Billiecart API

<back to all web services

CreateCarRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
POST/cars
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 CreateCarResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Car:Car = null with get,set

    [<AllowNullLiteral>]
    type CreateCarRequest() = 
        inherit PostOperationTenanted<CreateCarResponse>()
        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 PostOperationTenanted<'TResponse>() = 
        inherit PostOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type PostOperationUnTenanted<'TResponse>() = 
        interface IPost

F# CreateCarRequest DTOs

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

HTTP + XML

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

<CreateCarRequest 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>
  <Make>String</Make>
  <Model>String</Model>
  <Year>0</Year>
</CreateCarRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateCarResponse 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>
</CreateCarResponse>