Billiecart API

<back to all web services

MaintainCarRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
PUT,PATCH/cars/{Id}/maintain
MaintainCarRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
FromUtcbodyDateTimeNo
ToUtcbodyDateTimeNo
PutPatchOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
MaintainCarResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CarformCarNo
Car Parameters:
NameParameterData TypeRequiredDescription
ManufacturerformCarManufacturerNo
PlateformCarLicensePlateNo
OwnerformCarOwnerNo
ManagersformList<CarManager>No
StatusformstringNo
Alteredformbool?No
IdformstringNo
CarManufacturer Parameters:
NameParameterData TypeRequiredDescription
YearformintNo
MakeformstringNo
ModelformstringNo
CarLicensePlate Parameters:
NameParameterData TypeRequiredDescription
JurisdictionformstringNo
NumberformstringNo
CarOwner Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CarManager Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
MaintainCarResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CarformCarNo

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}/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"}}