| POST | /galaxy/vehicle/update | Update a user's vehicle license. |
|---|
"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 UpdateVehicleLicenseResponse extends ApiServiceResponse {
/** @param {{Vehicle?:VehicleData,Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {VehicleData}
* @description The newly update vehicle information. */
Vehicle;
}
export class UpdateVehicleLicense extends ApiServiceRequest {
/** @param {{IdNumber?:string,Vehicle?:VehicleData,ApiKey?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description ID Number of the user making this request. */
IdNumber;
/**
* @type {VehicleData}
* @description The scanned vehicle license disk information. */
Vehicle;
}
JavaScript UpdateVehicleLicense DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
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: text/jsv
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: {}
}