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
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CarManufacturer() = 
        member val Year:Int32 = new Int32() with get,set
        member val Make:String = null with get,set
        member val Model:String = null with get,set

    [<AllowNullLiteral>]
    type CarLicensePlate() = 
        member val Jurisdiction:String = null with get,set
        member val Number:String = null with get,set

    [<AllowNullLiteral>]
    type CarOwner() = 
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type CarManager() = 
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type Car() = 
        member val Manufacturer:CarManufacturer = null with get,set
        member val Plate:CarLicensePlate = null with get,set
        member val Owner:CarOwner = null with get,set
        member val Managers:ResizeArray<CarManager> = new ResizeArray<CarManager>() with get,set
        member val Status:String = null with get,set
        member val Altered:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type RegisterCarResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Car:Car = null with get,set

    [<AllowNullLiteral>]
    type RegisterCarRequest() = 
        inherit PutPatchOperationTenanted<RegisterCarResponse>()
        member val Id:String = null with get,set
        member val Jurisdiction:String = null with get,set
        member val Number:String = null with get,set

    [<AllowNullLiteral>]
    type PutPatchOperationTenanted<'TResponse>() = 
        inherit PutPatchOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type PutPatchOperationUnTenanted<'TResponse>() = 
        interface IPatch
        interface IPut

F# 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"}}