GalaxyMobile Client API

<back to all web services

UpdateVehicleLicense

"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

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

<UpdateVehicleLicense xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Vehicles">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
  <IdNumber>String</IdNumber>
  <Vehicle>
    <Colour>String</Colour>
    <Expired>false</Expired>
    <ExpiresSoon>false</ExpiresSoon>
    <Expiry>String</Expiry>
    <HasLicense>false</HasLicense>
    <Id>0</Id>
    <LicenseNumber>String</LicenseNumber>
    <Make>String</Make>
    <RegistrationNumber>String</RegistrationNumber>
    <Series>String</Series>
    <Vin>String</Vin>
  </Vehicle>
</UpdateVehicleLicense>

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

<UpdateVehicleLicenseResponse 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>
  <Vehicle>
    <Colour>String</Colour>
    <Expired>false</Expired>
    <ExpiresSoon>false</ExpiresSoon>
    <Expiry>String</Expiry>
    <HasLicense>false</HasLicense>
    <Id>0</Id>
    <LicenseNumber>String</LicenseNumber>
    <Make>String</Make>
    <RegistrationNumber>String</RegistrationNumber>
    <Series>String</Series>
    <Vin>String</Vin>
  </Vehicle>
</UpdateVehicleLicenseResponse>