| POST | /galaxy/vehicle/update | Update a user's vehicle license. |
|---|
namespace CommonService.Api.Models.Base
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiServiceResponse() =
member val Description:String = null with get,set
member val Heading:String = null with get,set
member val WasSuccessful:Boolean = new Boolean() with get,set
member val ModelState:Object = null with get,set
[<AllowNullLiteral>]
type VehicleData() =
///<summary>
///The ID of the vehicle.
///</summary>
[<ApiMember(Description="The ID of the vehicle.")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///Whether the vehicle has license disk information.
///</summary>
[<ApiMember(Description="Whether the vehicle has license disk information.")>]
member val HasLicense:Boolean = new Boolean() with get,set
///<summary>
///The vehicle license number.
///</summary>
[<ApiMember(Description="The vehicle license number.")>]
member val LicenseNumber:String = null with get,set
///<summary>
///The vehicle registration number.
///</summary>
[<ApiMember(Description="The vehicle registration number.")>]
member val RegistrationNumber:String = null with get,set
///<summary>
///The vehicle VIN number.
///</summary>
[<ApiMember(Description="The vehicle VIN number.")>]
member val Vin:String = null with get,set
///<summary>
///The vehicle make.
///</summary>
[<ApiMember(Description="The vehicle make.")>]
member val Make:String = null with get,set
///<summary>
///The vehicle series.
///</summary>
[<ApiMember(Description="The vehicle series.")>]
member val Series:String = null with get,set
///<summary>
///The vehicle colour.
///</summary>
[<ApiMember(Description="The vehicle colour.")>]
member val Colour:String = null with get,set
///<summary>
///The vehicle license expiry date in ISO 8601 format.
///</summary>
[<ApiMember(Description="The vehicle license expiry date in ISO 8601 format.")>]
member val Expiry:String = null with get,set
///<summary>
///True if this vehicle's licence expiring soon.
///</summary>
[<ApiMember(Description="True if this vehicle's licence expiring soon.")>]
member val ExpiresSoon:Boolean = new Boolean() with get,set
///<summary>
///True if this vehicle's license expired.
///</summary>
[<ApiMember(Description="True if this vehicle's license expired.")>]
member val Expired:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type UpdateVehicleLicenseResponse() =
inherit ApiServiceResponse()
///<summary>
///The newly update vehicle information.
///</summary>
[<ApiMember(Description="The newly update vehicle information.", IsRequired=true)>]
member val Vehicle:VehicleData = null with get,set
[<AllowNullLiteral>]
type ApiServiceRequest() =
///<summary>
///The API Key required for authentication
///</summary>
[<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
member val ApiKey:String = null with get,set
[<AllowNullLiteral>]
type UpdateVehicleLicense() =
inherit ApiServiceRequest()
///<summary>
///ID Number of the user making this request.
///</summary>
[<ApiMember(Description="ID Number of the user making this request.", IsRequired=true)>]
member val IdNumber:String = null with get,set
///<summary>
///The scanned vehicle license disk information.
///</summary>
[<ApiMember(Description="The scanned vehicle license disk information.", IsRequired=true)>]
member val Vehicle:VehicleData = null with get,set
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: {}
}