Skip to main content
Quote / Variants

getVariantBodyTypes

getVariantBodyTypes

Overview

This method will list the variant body types and its detail.

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.
If you are not actively using the API, leave the permission off for better security.
Go to Roles / Apis and check on QuoteVariants:Get

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

Input Fields (Header)

  • Header should contain the 'Accept' Key with the Value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.

Input Fields (Body)

Field

Format

Notes

Default Value

Mandatory

model_id

string

Model id

No

model_year

string

Model year

No

profile_required_flag

string

If yes, display body types only for qt_variants with a qt_variant_profiles record with a 'date' valid for the current invocation date.

I.e. the [qt_variant_profiles]date must be on or before the date the API is run.

Yes

No

page

string

Page number. Defaults to 1

1

No

page_size

string

Page size. Defaults to 25 records per page.

yes

No

Input URL Examples

https://api.test.catch-e.com/qt/body-types?model_id=100009&model_year=2000&profile_required_flag=no&page=1&page_size=25 

(Successful) Output Example

nse body Download { "_links": { "self": { "href": "https://api.test.catch-e.com/qt/body-types/?model_id=100009&profile_required_flag=no&page=1&page_size=25" }, "first": { "href": "https://api.test.catch-e.com/qt/body-types/?model_id=100009&profile_required_flag=no&page_size=25" }, "last": { "href": "https://api.test.catch-e.com/qt/body-types/?model_id=100009&profile_required_flag=no&page=1&page_size=25" } }, "_embedded": { "qt_body_types": [ { "body_type_id": 100001, "body_type": "CAB CHASSIS", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/body-types/100001" } } }, { "body_type_id": 100009, "body_type": "SEDAN", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/body-types/100009" } } }, { "body_type_id": 100012, "body_type": "TRAYTOP", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/body-types/100012" } } }, { "body_type_id": 100013, "body_type": "UTILITY", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/body-types/100013" } } }, { "body_type_id": 100016, "body_type": "WAGON", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/body-types/100016" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 5, "page": 1 } 

Error Codes

Detail

Comments

401 - Unauthorized

"detail": "Unauthorized"

Login token has expired. You need to generate new token.

403 - Forbidden

"detail": "Forbidden"

You do not have permissions for this request.

Detail

Validation Messages

Comments

422 - Unprocessable Entity

"detail": "Failed Validation"

"model_year": { "notLessThanInclusive": "The input is not less or equal than '2021'" }

model_year passed cannot be less than 1920.

"detail": "Failed Validation"

"model_year": { "notLessThanInclusive": "The input is not less or equal than '2021'" }

model_year passed cannot be greater than the following year.

"detail": "Failed Validation"

"model_id": { "notDigits": "The input must contain only digits"}

model_id passed needs to be integer.