Requires the role: | manager |
PUT,PATCH | /cars/{Id}/offline |
---|
import Foundation
import ServiceStack
public class OfflineCarRequest : PutPatchOperationTenanted<OfflineCarResponse>
{
public var id:String?
public var fromUtc:Date?
public var toUtc:Date?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case id
case fromUtc
case toUtc
}
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)
fromUtc = try container.decodeIfPresent(Date.self, forKey: .fromUtc)
toUtc = try container.decodeIfPresent(Date.self, forKey: .toUtc)
}
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 fromUtc != nil { try container.encode(fromUtc, forKey: .fromUtc) }
if toUtc != nil { try container.encode(toUtc, forKey: .toUtc) }
}
}
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 OfflineCarResponse : 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(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /cars/{Id}/offline HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 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 } }