GalaxyMobile Client API

UpdateVehicleLicense

The following routes are available for this service:
POST	/galaxy/vehicle/update	Update a user's vehicle license.


export class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public ApiKey: string;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    public Description: string;
    public Heading: string;
    public WasSuccessful: boolean;
    public ModelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class VehicleData
{
    /** @description The ID of the vehicle. */
    // @ApiMember(Description="The ID of the vehicle.")
    public Id: number;

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

    /** @description The vehicle license number. */
    // @ApiMember(Description="The vehicle license number.")
    public LicenseNumber: string;

    /** @description The vehicle registration number. */
    // @ApiMember(Description="The vehicle registration number.")
    public RegistrationNumber: string;

    /** @description The vehicle VIN number. */
    // @ApiMember(Description="The vehicle VIN number.")
    public Vin: string;

    /** @description The vehicle make. */
    // @ApiMember(Description="The vehicle make.")
    public Make: string;

    /** @description The vehicle series. */
    // @ApiMember(Description="The vehicle series.")
    public Series: string;

    /** @description The vehicle colour. */
    // @ApiMember(Description="The vehicle colour.")
    public Colour: string;

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

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

    /** @description True if this vehicle's license expired. */
    // @ApiMember(Description="True if this vehicle's license expired.")
    public Expired: boolean;

    public constructor(init?: Partial<VehicleData>) { (Object as any).assign(this, init); }
}

export class UpdateVehicleLicenseResponse extends ApiServiceResponse
{
    /** @description The newly update vehicle information. */
    // @ApiMember(Description="The newly update vehicle information.", IsRequired=true)
    public Vehicle: VehicleData;

    public constructor(init?: Partial<UpdateVehicleLicenseResponse>) { super(init); (Object as any).assign(this, init); }
}

export class UpdateVehicleLicense extends ApiServiceRequest
{
    /** @description ID Number of the user making this request. */
    // @ApiMember(Description="ID Number of the user making this request.", IsRequired=true)
    public IdNumber: string;

    /** @description The scanned vehicle license disk information. */
    // @ApiMember(Description="The scanned vehicle license disk information.", IsRequired=true)
    public Vehicle: VehicleData;

    public constructor(init?: Partial<UpdateVehicleLicense>) { super(init); (Object as any).assign(this, init); }
}

TypeScript UpdateVehicleLicense DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /galaxy/vehicle/update HTTP/1.1 
Host: galaxymobile.api.client.prod.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"IdNumber":"String","Vehicle":{"Id":0,"HasLicense":false,"LicenseNumber":"String","RegistrationNumber":"String","Vin":"String","Make":"String","Series":"String","Colour":"String","Expiry":"String","ExpiresSoon":false,"Expired":false},"ApiKey":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Vehicle":{"Id":0,"HasLicense":false,"LicenseNumber":"String","RegistrationNumber":"String","Vin":"String","Make":"String","Series":"String","Colour":"String","Expiry":"String","ExpiresSoon":false,"Expired":false},"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}