Billiecart API

OfflineCarRequest

**Requires Authentication**
Requires the role:	manager

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PutPatchOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IPatch, IPut):
    @staticmethod
    def response_type(): return TResponse


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PutPatchOperationTenanted(Generic[TResponse], PutPatchOperationUnTenanted[TResponse], ITenantedRequest):
    organisation_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CarManufacturer:
    year: Optional[int] = None
    make: Optional[str] = None
    model: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CarLicensePlate:
    jurisdiction: Optional[str] = None
    number: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CarOwner:
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CarManager:
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Car(IIdentifiableResource):
    manufacturer: Optional[CarManufacturer] = None
    plate: Optional[CarLicensePlate] = None
    owner: Optional[CarOwner] = None
    managers: Optional[List[CarManager]] = None
    status: Optional[str] = None
    altered: Optional[bool] = None
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OfflineCarResponse:
    response_status: Optional[ResponseStatus] = None
    car: Optional[Car] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OfflineCarRequest(PutPatchOperationTenanted[OfflineCarResponse]):
    id: Optional[str] = None
    from_utc: Optional[datetime.datetime] = None
    to_utc: Optional[datetime.datetime] = None

Python OfflineCarRequest 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}/offline HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OfflineCarRequest 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>
  <FromUtc>0001-01-01T00:00:00</FromUtc>
  <Id>String</Id>
  <ToUtc>0001-01-01T00:00:00</ToUtc>
</OfflineCarRequest>

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

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