GalaxyMobile Client API

GetVehicleList

The following routes are available for this service:
GET	/galaxy/vehicle/list	Retrieve a list of a user's vehicles.

"use strict";
export class ApiServiceRequest {
    /** @param {{ApiKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    ApiKey;
}
export class ApiServiceResponse {
    /** @param {{Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Description;
    /** @type {string} */
    Heading;
    /** @type {boolean} */
    WasSuccessful;
    /** @type {Object} */
    ModelState;
}
export class VehicleData {
    /** @param {{Id?:number,HasLicense?:boolean,LicenseNumber?:string,RegistrationNumber?:string,Vin?:string,Make?:string,Series?:string,Colour?:string,Expiry?:string,ExpiresSoon?:boolean,Expired?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The ID of the vehicle. */
    Id;
    /**
     * @type {boolean}
     * @description Whether the vehicle has license disk information. */
    HasLicense;
    /**
     * @type {string}
     * @description The vehicle license number. */
    LicenseNumber;
    /**
     * @type {string}
     * @description The vehicle registration number. */
    RegistrationNumber;
    /**
     * @type {string}
     * @description The vehicle VIN number. */
    Vin;
    /**
     * @type {string}
     * @description The vehicle make. */
    Make;
    /**
     * @type {string}
     * @description The vehicle series. */
    Series;
    /**
     * @type {string}
     * @description The vehicle colour. */
    Colour;
    /**
     * @type {string}
     * @description The vehicle license expiry date in ISO 8601 format. */
    Expiry;
    /**
     * @type {boolean}
     * @description True if this vehicle's licence expiring soon. */
    ExpiresSoon;
    /**
     * @type {boolean}
     * @description True if this vehicle's license expired. */
    Expired;
}
export class VehicleListResponse extends ApiServiceResponse {
    /** @param {{Vehicles?:VehicleData[],Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {VehicleData[]} */
    Vehicles;
}
export class GetVehicleList extends ApiServiceRequest {
    /** @param {{IdNumber?:string,ApiKey?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description ID Number of the user making this request. */
    IdNumber;
}

JavaScript GetVehicleList DTOs

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

HTTP + XML

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: application/xml

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

<VehicleListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Vehicles">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <Vehicles i:nil="true" />
</VehicleListResponse>