GalaxyMobile Client API

<back to all web services

GetVehicleList

The following routes are available for this service:
GET/galaxy/vehicle/listRetrieve a list of a user's vehicles.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetVehicleList extends ApiServiceRequest
    {
        /**
        * ID Number of the user making this request.
        */
        @ApiMember(Description="ID Number of the user making this request.", IsRequired=true)
        public String IdNumber = null;
        
        public String getIdNumber() { return IdNumber; }
        public GetVehicleList setIdNumber(String value) { this.IdNumber = value; return this; }
    }

    public static class ApiServiceRequest implements IServiceRequest, IHasApiKey
    {
        /**
        * The API Key required for authentication
        */
        @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        public String ApiKey = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiServiceRequest setApiKey(String value) { this.ApiKey = value; return this; }
    }

    public static class VehicleListResponse extends ApiServiceResponse
    {
        public ArrayList<VehicleData> Vehicles = null;
        
        public ArrayList<VehicleData> getVehicles() { return Vehicles; }
        public VehicleListResponse setVehicles(ArrayList<VehicleData> value) { this.Vehicles = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        public String Description = null;
        public String Heading = null;
        public Boolean WasSuccessful = null;
        public Object ModelState = null;
        
        public String getDescription() { return Description; }
        public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
        public String getHeading() { return Heading; }
        public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
        public Boolean isWasSuccessful() { return WasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
        public Object getModelState() { return ModelState; }
        public ApiServiceResponse setModelState(Object value) { this.ModelState = value; return this; }
    }

    public static class VehicleData
    {
        /**
        * The ID of the vehicle.
        */
        @ApiMember(Description="The ID of the vehicle.")
        public Integer Id = null;

        /**
        * Whether the vehicle has license disk information.
        */
        @ApiMember(Description="Whether the vehicle has license disk information.")
        public Boolean HasLicense = null;

        /**
        * The vehicle license number.
        */
        @ApiMember(Description="The vehicle license number.")
        public String LicenseNumber = null;

        /**
        * The vehicle registration number.
        */
        @ApiMember(Description="The vehicle registration number.")
        public String RegistrationNumber = null;

        /**
        * The vehicle VIN number.
        */
        @ApiMember(Description="The vehicle VIN number.")
        public String Vin = null;

        /**
        * The vehicle make.
        */
        @ApiMember(Description="The vehicle make.")
        public String Make = null;

        /**
        * The vehicle series.
        */
        @ApiMember(Description="The vehicle series.")
        public String Series = null;

        /**
        * The vehicle colour.
        */
        @ApiMember(Description="The vehicle colour.")
        public String Colour = null;

        /**
        * The vehicle license expiry date in ISO 8601 format.
        */
        @ApiMember(Description="The vehicle license expiry date in ISO 8601 format.")
        public String Expiry = null;

        /**
        * True if this vehicle's licence expiring soon.
        */
        @ApiMember(Description="True if this vehicle's licence expiring soon.")
        public Boolean ExpiresSoon = null;

        /**
        * True if this vehicle's license expired.
        */
        @ApiMember(Description="True if this vehicle's license expired.")
        public Boolean Expired = null;
        
        public Integer getId() { return Id; }
        public VehicleData setId(Integer value) { this.Id = value; return this; }
        public Boolean isHasLicense() { return HasLicense; }
        public VehicleData setHasLicense(Boolean value) { this.HasLicense = value; return this; }
        public String getLicenseNumber() { return LicenseNumber; }
        public VehicleData setLicenseNumber(String value) { this.LicenseNumber = value; return this; }
        public String getRegistrationNumber() { return RegistrationNumber; }
        public VehicleData setRegistrationNumber(String value) { this.RegistrationNumber = value; return this; }
        public String getVin() { return Vin; }
        public VehicleData setVin(String value) { this.Vin = value; return this; }
        public String getMake() { return Make; }
        public VehicleData setMake(String value) { this.Make = value; return this; }
        public String getSeries() { return Series; }
        public VehicleData setSeries(String value) { this.Series = value; return this; }
        public String getColour() { return Colour; }
        public VehicleData setColour(String value) { this.Colour = value; return this; }
        public String getExpiry() { return Expiry; }
        public VehicleData setExpiry(String value) { this.Expiry = value; return this; }
        public Boolean isExpiresSoon() { return ExpiresSoon; }
        public VehicleData setExpiresSoon(Boolean value) { this.ExpiresSoon = value; return this; }
        public Boolean isExpired() { return Expired; }
        public VehicleData setExpired(Boolean value) { this.Expired = value; return this; }
    }

}

Java GetVehicleList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /galaxy/vehicle/list HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}