Billiecart API

<back to all web services

CreateCarRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/cars
import Foundation
import ServiceStack

public class CreateCarRequest : PostOperationTenanted<CreateCarResponse>
{
    public var year:Int?
    public var make:String?
    public var model:String?

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

    private enum CodingKeys : String, CodingKey {
        case year
        case make
        case model
    }

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

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

public class PostOperationTenanted<TResponse : Codable> : PostOperationUnTenanted<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 PostOperationUnTenanted<TResponse : Codable> : IPost, Codable
{
    required public init(){}
}

public class CreateCarResponse : 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 CreateCarRequest 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 /cars HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	year: 0,
	make: String,
	model: String,
	organisationId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
	}
}