Variants & Vehicles API: Get a list of variant body types

API endpoints for vehicle variants, makes, models, and equipment

Get a list of variant body types

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)

  • model_id (string) — Model id No
  • model_year (string) — Model year No
  • profilerequiredflag (string) — If yes, display body types only for qtvariants with a qtvariant_profiles record with a 'date' valid for the current invocation date. I.e. the 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. 25 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 bodyDownload{ "_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

DetailComments
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.
DetailValidation MessagesComments
422 - Unprocessable Entity
"detail": "Failed Validation""model_year": { "notGreaterThanInclusive": "The input is not greater than or equal to '1920'" }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.

Get a body type by body type id

This method will return requested body type details.

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)

FieldFormatNotesMandatory
bodytypeidstringBody type idYes

Input URL Examples

https://api.test.catch-e.com/qt/body-types/100001

(Successful) Output Example

{ "body_type_id": 100001, "body_type": "CAB CHASSIS", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/body-types/100001" } }}

Error Codes

DetailComments
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.
404 - Not Found
"detail": "Invalid body type id"Entered bodytypeid cannot be found.

Get a list of variant data sources

This method will list details of all variant data sources.

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)

No input fields required.

Input URL Examples

https://api.test.catch-e.com/qt/data-sources

(Successful) Output Example

[ { "data_source_id": 100000, "data_source": "user-defined" }, { "data_source_id": 100001, "data_source": "redbook" }, { "data_source_id": 100002, "data_source": "glass" }]

Error Codes

DetailComments
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.

Get a list of variant makes

This method will list the makes 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)

  • make_code (string) — Make code. This field supports the wildcard % operator (See Wildcard % operator notes below). No
  • name (string) — Make name. This field supports the wildcard % operator (See Wildcard % operator notes below). No
  • make_type (string) — Make type No
  • datasourceid (string) — Data source id No
  • profilerequiredflag (string) — If yes, display makes only for qtvariants with a qtvariant_profiles record with a 'date' valid for the current invocation date. I.e. the must be on or before the date the API is run. yes No
  • includeinactiveflag (string) — Set to yes if inactive items are required in the list. When no, items are returned when both the qtmakes record and linked qtvariants records have an active status no No
  • page (string) — Page number. Defaults to 1 no No
  • page_size (string) — Page size. Defaults to 25 records per page. 25 No

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

Input URL Examples

https://api.test.catch-e.com/qt/makes?make_code=FO%25&make_type=motor-vehicles&profile_required_flag=no&include_inactive_flag=no&page=1&page_size=25

(Successful) Output Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/makes/?make_code=FO%25&make_type=motor-vehicles&profile_required_flag=no&include_inactive_flag=no&page=1&page_size=25" }, "first": { "href": "https://api.test.catch-e.com/qt/makes/?make_code=FO%25&make_type=motor-vehicles&profile_required_flag=no&include_inactive_flag=no&page_size=25" }, "last": { "href": "https://api.test.catch-e.com/qt/makes/?make_code=FO%25&make_type=motor-vehicles&profile_required_flag=no&include_inactive_flag=no&page=1&page_size=25" } }, "_embedded": { "qt_makes": [ { "make_id": 100014, "make_code": "FORD", "name": "FORD", "make_type": "motor-vehicles", "data_source_id": 100001, "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/makes/100014" } } }, { "make_id": 100085, "make_code": "FOTO", "name": "FOTON", "make_type": "motor-vehicles", "data_source_id": 100001, "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/makes/100085" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 2, "page": 1}

Error Codes

DetailComments
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.
DetailValidation MessagesComments
422 - Unprocessable Entity
"detail": "Failed Validation""datasourceid": { "notDigits": "The input must contain only digits"}datasourceid passed needs to be integer.
"detail": "Failed Validation""make_code": { "stringLengthTooShort": "The input is less than 2 characters long" }make_code length should be greater than one character.
"detail": "Failed Validation""name": { "stringLengthTooShort": "The input is less than 2 characters long" }name length should be greater than one character.

Get a list of variant models

This method will list the models 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)

  • make_id (string) — Make id. No
  • model_code (string) — Model code. This field supports the wildcard % operator (See Wildcard % operator notes below). No
  • datasourceid (string) — Data source id No
  • profilerequiredflag (string) — If yes, display models only for qtvariants with a qtvariant_profiles record with a 'date' valid for the current invocation date. I.e. the must be on or before the date the API is run. yes No
  • includeinactiveflag (string) — Set to yes if inactive items are required in the list. When no, items are returned when both the qtmodels record, and linked qtvariants records have an active status no No
  • page (string) — Page number. Defaults to 1 1 No
  • page_size (string) — Page size. Defaults to 25 records per page. 25 No

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

Input URL Examples

https://api.test.catch-e.com/qt/models?model_code=Falc%25&profile_required_flag=no&include_inactive_flag=no&page=1&page_size=25

(Successful) Output Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/models/?model_code=Falc%25&profile_required_flag=no&include_inactive_flag=no&page=1&page_size=25" }, "first": { "href": "https://api.test.catch-e.com/qt/models/?model_code=Falc%25&profile_required_flag=no&include_inactive_flag=no&page_size=25" }, "last": { "href": "https://api.test.catch-e.com/qt/models/?model_code=Falc%25&profile_required_flag=no&include_inactive_flag=no&page=1&page_size=25" } }, "_embedded": { "qt_models": [ { "model_id": 100009, "make_id": 100014, "model_code": "FALCON", "description": "Falcon", "data_source_id": 100001, "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/models/100009" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1}

Error Codes

DetailComments
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.
DetailValidation MessagesComments
422 - Unprocessable Entity
"detail": "Failed Validation""datasourceid": { "notDigits": "The input must contain only digits"}datasourceid passed needs to be integer.
"detail": "Failed Validation""make_id": { "notDigits": "The input must contain only digits"}make_id passed needs to be integer.
"detail": "Failed Validation""model_code": { "stringLengthTooShort": "The input is less than 2 characters long" }model_code length should be greater than one character.

Get a model by model id

This method will return requested model details.

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)

FieldFormatNotesMandatory
model_idstringModel idYes

Input URL Examples

https://api.test.catch-e.com/qt/models/100000

(Successful) Output Example

{ "model_id": 100000, "make_id": 100007, "model_code": "BERLING", "description": "Berlingo", "data_source_id": 100001, "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/models/100000" } }}

Error Codes

DetailComments
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.
404 - Not Found
"detail": "Invalid model id"Entered model_id cannot be found.

Get a make by make id

This method will return requested make details.

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)

FieldFormatNotesMandatory
make_idstringMake idYes

Input URL Examples

https://api.test.catch-e.com/qt/makes/100000

(Successful) Output Example

{ "make_id": 100000, "make_code": "ALFA", "name": "ALFA ROMEO", "make_type": "motor-vehicles", "data_source_id": 100001, "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/makes/100000" } }}

Error Codes

DetailComments
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.
404 - Not Found
"detail": nullEntered make_id cannot be found.

Get an array of model years for a given vehicle model

This method will list all the years for selected model.

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)

  • model_id (string) — Model id Yes
  • profilerequiredflag (string) — If yes, display model years only for qtvariants with a qtvariant_profiles record with a 'date' valid for the current invocation date. I.e. the must be on or before the date the API is run. yes No

Input URL Examples

https://api.test.catch-e.com/qt/model-years?model_id=100009&profile_required_flag=no

(Successful) Output Example

[ 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016]

Error Codes

DetailComments
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.
DetailValidation MessagesComments
422 - Unprocessable Entity
"detail": "Failed Validation""model_id": { "notDigits": "The input must contain only digits"}model_id passed needs to be integer.