Billiecart API

<back to all web services

RegisterCarRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
PUT,PATCH/cars/{Id}/register
import java.math.*
import java.util.*
import net.servicestack.client.*


open class RegisterCarRequest : PutPatchOperationTenanted<RegisterCarResponse>()
{
    var id:String? = null
    var jurisdiction:String? = null
    var number:String? = null
}

open class PutPatchOperationTenanted<TResponse> : PutPatchOperationUnTenanted<TResponse>(), ITenantedRequest
{
    var organisationId:String? = null
}

open class PutPatchOperationUnTenanted<TResponse> : IPatch, IPut
{
}

open class RegisterCarResponse
{
    var responseStatus:ResponseStatus? = null
    var car:Car? = null
}

open class Car : IIdentifiableResource
{
    var manufacturer:CarManufacturer? = null
    var plate:CarLicensePlate? = null
    var owner:CarOwner? = null
    var managers:ArrayList<CarManager> = ArrayList<CarManager>()
    var status:String? = null
    var altered:Boolean? = null
    var id:String? = null
}

open class CarManufacturer
{
    var year:Int? = null
    var make:String? = null
    var model:String? = null
}

open class CarLicensePlate
{
    var jurisdiction:String? = null
    var number:String? = null
}

open class CarOwner
{
    var id:String? = null
}

open class CarManager
{
    var id:String? = null
}

Kotlin RegisterCarRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","jurisdiction":"String","number":"String","organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}