GalaxyMobile App API

<back to all web services

AddOrUpdateVehicleRequest

Requires Authentication
import Foundation
import ServiceStack

public class AddOrUpdateVehicleRequest : ApiServiceRequest
{
    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 ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, IHasClientId, Codable
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public var apiKey:String

    /**
    * Latitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public var latitude:Double

    /**
    * Longitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public var longitude:Double

    required public init(){}
}

public class VehicleData : Codable
{
    public var id:Int
    public var hasLicense:Bool
    public var licenseNumber:String
    public var registrationNumber:String
    public var vin:String
    public var make:String
    public var series:String
    public var colour:String
    public var expiry:String
    public var expiryFormatted:String
    public var expiresSoon:Bool
    public var expired:Bool

    required public init(){}
}

public class VehicleDetailResponse : ApiServiceResponse
{
    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 AddOrUpdateVehicleRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/AddOrUpdateVehicleRequest HTTP/1.1 
Host: galaxymobile.api.dev.86degrees.com 
Accept: text/jsv
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,
		ExpiryFormatted: String,
		ExpiresSoon: False,
		Expired: False
	},
	ApiKey: String,
	Latitude: 0,
	Longitude: 0
}
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,
		ExpiryFormatted: String,
		ExpiresSoon: False,
		Expired: False
	},
	Description: String,
	Heading: String,
	WasSuccessful: False,
	ModelState: {}
}