GET | /cars/available |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FromUtc | query | DateTime? | No | |
ToUtc | query | DateTime? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Distinct | form | string | No | |
Limit | form | int? | No | |
Offset | form | int? | No | |
Sort | form | string | No | |
Filter | form | string | No | |
Search | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Embed | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Cars | form | List<Car> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Metadata | form | SearchMetadata | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Total | form | int | No | |
Limit | form | int | No | |
Offset | form | int | No | |
Sort | form | Sorting | No | |
Filter | form | Filtering | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
By | form | string | No | |
Direction | form | SortDirection | No |
Ascending | |
Descending |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Fields | form | List<string> | No | |
Search | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Manufacturer | form | CarManufacturer | No | |
Plate | form | CarLicensePlate | No | |
Owner | form | CarOwner | No | |
Managers | form | List<CarManager> | No | |
Status | form | string | No | |
Altered | form | bool? | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Year | form | int | No | |
Make | form | string | No | |
Model | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Jurisdiction | form | string | No | |
Number | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Cars | form | List<Car> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /cars/available HTTP/1.1 Host: staging-api.billiecart.com.au Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"cars":[{"manufacturer":{"year":0,"make":"String","model":"String"},"plate":{"jurisdiction":"String","number":"String"},"owner":{"id":"String"},"managers":[{"id":"String"}],"status":"String","altered":false,"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}