| POST | /galaxy/vehicle/update | Update a user's vehicle license. |
|---|
import Foundation
import ServiceStack
public class UpdateVehicleLicense : ApiServiceRequest
{
/**
* ID Number of the user making this request.
*/
// @ApiMember(Description="ID Number of the user making this request.", IsRequired=true)
public var idNumber:String
/**
* The scanned vehicle license disk information.
*/
// @ApiMember(Description="The scanned vehicle license disk information.", IsRequired=true)
public var vehicle:VehicleData
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case idNumber
case vehicle
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
idNumber = try container.decodeIfPresent(String.self, forKey: .idNumber)
vehicle = try container.decodeIfPresent(VehicleData.self, forKey: .vehicle)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if idNumber != nil { try container.encode(idNumber, forKey: .idNumber) }
if vehicle != nil { try container.encode(vehicle, forKey: .vehicle) }
}
}
public class ApiServiceRequest : IServiceRequest, IHasApiKey, Codable
{
/**
* The API Key required for authentication
*/
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public var apiKey:String
required public init(){}
}
public class VehicleData : Codable
{
/**
* The ID of the vehicle.
*/
// @ApiMember(Description="The ID of the vehicle.")
public var id:Int
/**
* Whether the vehicle has license disk information.
*/
// @ApiMember(Description="Whether the vehicle has license disk information.")
public var hasLicense:Bool
/**
* The vehicle license number.
*/
// @ApiMember(Description="The vehicle license number.")
public var licenseNumber:String
/**
* The vehicle registration number.
*/
// @ApiMember(Description="The vehicle registration number.")
public var registrationNumber:String
/**
* The vehicle VIN number.
*/
// @ApiMember(Description="The vehicle VIN number.")
public var vin:String
/**
* The vehicle make.
*/
// @ApiMember(Description="The vehicle make.")
public var make:String
/**
* The vehicle series.
*/
// @ApiMember(Description="The vehicle series.")
public var series:String
/**
* The vehicle colour.
*/
// @ApiMember(Description="The vehicle colour.")
public var colour:String
/**
* The vehicle license expiry date in ISO 8601 format.
*/
// @ApiMember(Description="The vehicle license expiry date in ISO 8601 format.")
public var expiry:String
/**
* True if this vehicle's licence expiring soon.
*/
// @ApiMember(Description="True if this vehicle's licence expiring soon.")
public var expiresSoon:Bool
/**
* True if this vehicle's license expired.
*/
// @ApiMember(Description="True if this vehicle's license expired.")
public var expired:Bool
required public init(){}
}
public class UpdateVehicleLicenseResponse : ApiServiceResponse
{
/**
* The newly update vehicle information.
*/
// @ApiMember(Description="The newly update vehicle information.", IsRequired=true)
public var vehicle:VehicleData
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case vehicle
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
vehicle = try container.decodeIfPresent(VehicleData.self, forKey: .vehicle)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if vehicle != nil { try container.encode(vehicle, forKey: .vehicle) }
}
}
public class ApiServiceResponse : IServiceResponse, Codable
{
public var Description:String
public var heading:String
public var wasSuccessful:Bool
//modelState:Object ignored. Type could not be extended in Swift
required public init(){}
}
Swift UpdateVehicleLicense DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: 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>