Billiecart API

RegisterCarRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT,PATCH	/cars/{Id}/register

import Foundation
import ServiceStack

public class RegisterCarRequest : PutPatchOperationTenanted<RegisterCarResponse>
{
    public var id:String?
    public var jurisdiction:String?
    public var number:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case jurisdiction
        case number
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(String.self, forKey: .id)
        jurisdiction = try container.decodeIfPresent(String.self, forKey: .jurisdiction)
        number = try container.decodeIfPresent(String.self, forKey: .number)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if jurisdiction != nil { try container.encode(jurisdiction, forKey: .jurisdiction) }
        if number != nil { try container.encode(number, forKey: .number) }
    }
}

public class PutPatchOperationTenanted<TResponse : Codable> : PutPatchOperationUnTenanted<TResponse>, ITenantedRequest
{
    public var organisationId:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case organisationId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        organisationId = try container.decodeIfPresent(String.self, forKey: .organisationId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if organisationId != nil { try container.encode(organisationId, forKey: .organisationId) }
    }
}

public class PutPatchOperationUnTenanted<TResponse : Codable> : IPatch, IPut, Codable
{
    required public init(){}
}

public class RegisterCarResponse : Codable
{
    public var responseStatus:ResponseStatus?
    public var car:Car?

    required public init(){}
}

public class Car : IIdentifiableResource, Codable
{
    public var manufacturer:CarManufacturer?
    public var plate:CarLicensePlate?
    public var owner:CarOwner?
    public var managers:[CarManager] = []
    public var status:String?
    public var altered:Bool?
    public var id:String?

    required public init(){}
}

public class CarManufacturer : Codable
{
    public var year:Int?
    public var make:String?
    public var model:String?

    required public init(){}
}

public class CarLicensePlate : Codable
{
    public var jurisdiction:String?
    public var number:String?

    required public init(){}
}

public class CarOwner : Codable
{
    public var id:String?

    required public init(){}
}

public class CarManager : Codable
{
    public var id:String?

    required public init(){}
}

Swift RegisterCarRequest DTOs

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

HTTP + CSV

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

PUT /cars/{Id}/register HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","jurisdiction":"String","number":"String","organisationId":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"car":{"manufacturer":{"year":0,"make":"String","model":"String"},"plate":{"jurisdiction":"String","number":"String"},"owner":{"id":"String"},"managers":[{"id":"String"}],"status":"String","altered":false,"id":"String"}}