Billiecart API

<back to all web services

RegisterCarRequest

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

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

<RegisterCarRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Cars">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <Id>String</Id>
  <Jurisdiction>String</Jurisdiction>
  <Number>String</Number>
</RegisterCarRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegisterCarResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Cars">
  <Car xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Altered>false</d2p1:Altered>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Managers>
      <d2p1:CarManager>
        <d2p1:Id>String</d2p1:Id>
      </d2p1:CarManager>
    </d2p1:Managers>
    <d2p1:Manufacturer>
      <d2p1:Make>String</d2p1:Make>
      <d2p1:Model>String</d2p1:Model>
      <d2p1:Year>0</d2p1:Year>
    </d2p1:Manufacturer>
    <d2p1:Owner>
      <d2p1:Id>String</d2p1:Id>
    </d2p1:Owner>
    <d2p1:Plate>
      <d2p1:Jurisdiction>String</d2p1:Jurisdiction>
      <d2p1:Number>String</d2p1:Number>
    </d2p1:Plate>
    <d2p1:Status>String</d2p1:Status>
  </Car>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</RegisterCarResponse>