Requires the role: | manager |
PUT,PATCH | /cars/{Id}/maintain |
---|
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 MaintainCarResponse:
response_status: Optional[ResponseStatus] = None
car: Optional[Car] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MaintainCarRequest(PutPatchOperationTenanted[MaintainCarResponse]):
id: Optional[str] = None
from_utc: Optional[datetime.datetime] = None
to_utc: Optional[datetime.datetime] = None
Python MaintainCarRequest 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /cars/{Id}/maintain HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"id":"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"}}