| GET | /galaxy/vehicle/list | Retrieve a list of a user's vehicles. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class GetVehicleList : ApiServiceRequest()
{
/**
* ID Number of the user making this request.
*/
@ApiMember(Description="ID Number of the user making this request.", IsRequired=true)
var IdNumber:String? = null
}
open class ApiServiceRequest : IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
var ApiKey:String? = null
}
open class VehicleListResponse : ApiServiceResponse()
{
var Vehicles:ArrayList<VehicleData> = ArrayList<VehicleData>()
}
open class ApiServiceResponse : IServiceResponse
{
var Description:String? = null
var Heading:String? = null
var WasSuccessful:Boolean? = null
var ModelState:Object? = null
}
open class VehicleData
{
/**
* The ID of the vehicle.
*/
@ApiMember(Description="The ID of the vehicle.")
var Id:Int? = null
/**
* Whether the vehicle has license disk information.
*/
@ApiMember(Description="Whether the vehicle has license disk information.")
var HasLicense:Boolean? = null
/**
* The vehicle license number.
*/
@ApiMember(Description="The vehicle license number.")
var LicenseNumber:String? = null
/**
* The vehicle registration number.
*/
@ApiMember(Description="The vehicle registration number.")
var RegistrationNumber:String? = null
/**
* The vehicle VIN number.
*/
@ApiMember(Description="The vehicle VIN number.")
var Vin:String? = null
/**
* The vehicle make.
*/
@ApiMember(Description="The vehicle make.")
var Make:String? = null
/**
* The vehicle series.
*/
@ApiMember(Description="The vehicle series.")
var Series:String? = null
/**
* The vehicle colour.
*/
@ApiMember(Description="The vehicle colour.")
var Colour:String? = null
/**
* The vehicle license expiry date in ISO 8601 format.
*/
@ApiMember(Description="The vehicle license expiry date in ISO 8601 format.")
var Expiry:String? = null
/**
* True if this vehicle's licence expiring soon.
*/
@ApiMember(Description="True if this vehicle's licence expiring soon.")
var ExpiresSoon:Boolean? = null
/**
* True if this vehicle's license expired.
*/
@ApiMember(Description="True if this vehicle's license expired.")
var Expired:Boolean? = null
}
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.
GET /galaxy/vehicle/list HTTP/1.1 Host: galaxymobile.api.client.prod.86degrees.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Description: String,
Heading: String,
WasSuccessful: False,
ModelState: {}
}