Requires the role: | manager |
GET | /cars/models |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Make | query | 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 | |
Models | form | List<CarModel> | 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 |
---|---|---|---|---|
Make | form | string | No | |
Model | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Models | form | List<CarModel> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /cars/models HTTP/1.1 Host: staging-api.billiecart.com.au Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, models: [ { make: String, model: String } ], metadata: { total: 0, limit: 0, offset: 0, sort: { by: String, direction: Ascending }, filter: { fields: [ String ], search: String } } }