Billiecart API

RegisterCarRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT,PATCH	/cars/{Id}/register

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Cars
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces.Resources

        Public Partial Class Car
            Implements IIdentifiableResource
            Public Sub New()
                Managers = New List(Of CarManager)
            End Sub

            Public Overridable Property Manufacturer As CarManufacturer
            Public Overridable Property Plate As CarLicensePlate
            Public Overridable Property Owner As CarOwner
            Public Overridable Property Managers As List(Of CarManager)
            Public Overridable Property Status As String
            Public Overridable Property Altered As Nullable(Of Boolean)
            Public Overridable Property Id As String
        End Class

        Public Partial Class CarLicensePlate
            Public Overridable Property Jurisdiction As String
            Public Overridable Property Number As String
        End Class

        Public Partial Class CarManager
            Public Overridable Property Id As String
        End Class

        Public Partial Class CarManufacturer
            Public Overridable Property Year As Integer
            Public Overridable Property Make As String
            Public Overridable Property Model As String
        End Class

        Public Partial Class CarOwner
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class PutPatchOperationTenanted(Of TResponse)
            Inherits PutPatchOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class PutPatchOperationUnTenanted(Of TResponse)
            Implements IPatch
            Implements IPut
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Cars

        Public Partial Class RegisterCarRequest
            Inherits PutPatchOperationTenanted(Of RegisterCarResponse)
            Public Overridable Property Id As String
            Public Overridable Property Jurisdiction As String
            Public Overridable Property Number As String
        End Class

        Public Partial Class RegisterCarResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Car As Car
        End Class
    End Namespace
End Namespace

VB.NET RegisterCarRequest 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.

PUT /cars/{Id}/register HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RegisterCarRequest 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>
  <Id>String</Id>
  <Jurisdiction>String</Jurisdiction>
  <Number>String</Number>
</RegisterCarRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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