| GET | /galaxy/vehicle/list | Retrieve a list of a user's vehicles. |
|---|
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 VehicleListResponse extends ApiServiceResponse
{
public Vehicles: VehicleData[];
public constructor(init?: Partial<VehicleListResponse>) { super(init); (Object as any).assign(this, init); }
}
export class GetVehicleList 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;
public constructor(init?: Partial<GetVehicleList>) { super(init); (Object as any).assign(this, init); }
}
TypeScript GetVehicleList DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}