Get a list of variant body types

Get List of Variant Body Types

List variant body types with filtering.

Requires QuoteVariants:Get permission.

Go to Roles / APIs and check on QuoteVariants:Get.

HTTP Method

GET

Input - Header

Header should contain 'Accept' key with value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.

Input - Body

Field

Format

Notes

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 qt_variant_profiles record with date valid for current invocation date (on or before run date)

No

page

string

Page number (default: 1)

No

page_size

string

Records per page (default: 25)

No

URL Example

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

{ "_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 - 401 Unauthorized

"detail": "Unauthorized"

Login token expired. Generate new token.

Error - 403 Forbidden

"detail": "Forbidden"

You do not have permissions for this request.

Error - 422 Unprocessable Entity

Validation

Notes

model_year: notGreaterThanInclusive

Cannot be less than 1920

model_year: notLessThanInclusive

Cannot be greater than following year

model_id: notDigits

model_id must be integer

Get Body Type by Body Type ID

Return requested body type details.

Requires QuoteVariants:Get permission.

Go to Roles / APIs and check on QuoteVariants:Get.

HTTP Method

GET

Input - Header

Header should contain 'Accept' key with value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.

Input - Body

Field

Format

Notes

Mandatory

body_type_id

string

Body type ID

Yes

URL Example

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

Successful Output

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

Error - 401 Unauthorized

"detail": "Unauthorized"

Login token expired. Generate new token.

Error - 403 Forbidden

"detail": "Forbidden"

You do not have permissions for this request.

Error - 404 Not Found

"detail": "Invalid body type id"

Entered body_type_id cannot be found.

Get List of Variant Data Sources

List all variant data source details.

Requires QuoteVariants:Get permission.

Go to Roles / APIs and check on QuoteVariants:Get.

HTTP Method

GET

Input - Header

Header should contain 'Accept' key with value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.

Input - Body

No input fields required.

URL Example

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

Successful Output

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

Error - 401 Unauthorized

"detail": "Unauthorized"

Login token expired. Generate new token.

Error - 403 Forbidden

"detail": "Forbidden"

You do not have permissions for this request.

Get List of Variant Makes

List makes and details with filtering.

Requires QuoteVariants:Get permission.

Go to Roles / APIs and check on QuoteVariants:Get.

HTTP Method

GET

Input - Header

Header should contain 'Accept' key with value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.

Input - Body

Field

Format

Notes

Mandatory

make_code

string

Supports wildcard % operator

No

name

string

Supports wildcard % operator

No

make_type

string

Make type

No

data_source_id

string

Data source ID

No

profile_required_flag

string

If yes, display makes only for qt_variants with qt_variant_profiles record with date valid for current invocation date (on or before run date)

No

include_inactive_flag

string

Set to yes for inactive items. When no, returned when both qt_makes record and linked qt_variants records active. Default: no

No

page

string

Page number (default: 1)

No

page_size

string

Records per page (default: 25)

No

Wildcard % Operator Notes

In Postman, wildcard searches (%ab% or %ba%) may return "isEmpty" error.

Use %25ab%25 or %25ba%25 instead for proper encoding.

URL Example

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

{ "_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 - 401 Unauthorized

"detail": "Unauthorized"

Login token expired. Generate new token.

Error - 403 Forbidden

"detail": "Forbidden"

You do not have permissions for this request.

Error - 422 Unprocessable Entity

Validation

Notes

data_source_id: notDigits

data_source_id must be integer

make_code: stringLengthTooShort

Must be greater than 1 character

name: stringLengthTooShort

Must be greater than 1 character

Get List of Variant Models

List models and details with filtering.

Requires QuoteVariants:Get permission.

Go to Roles / APIs and check on QuoteVariants:Get.

HTTP Method

GET

Input - Header

Header should contain 'Accept' key with value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.

Input - Body

Field

Format

Notes

Mandatory

make_id

string

Make ID

No

model_code

string

Supports wildcard % operator

No

data_source_id

string

Data source ID

No

profile_required_flag

string

If yes, display models only for qt_variants with qt_variant_profiles record with date valid for current invocation date (on or before run date)

No

include_inactive_flag

string

Set to yes for inactive items. When no, returned when both qt_models record and linked qt_variants records active. Default: no

No

page

string

Page number (default: 1)

No

page_size

string

Records per page (default: 25)

No

Wildcard % Operator Notes

In Postman, wildcard searches (%ab% or %ba%) may return "isEmpty" error.

Use %25ab%25 or %25ba%25 instead for proper encoding.

URL Example

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

{ "_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 - 401 Unauthorized

"detail": "Unauthorized"

Login token expired. Generate new token.

Error - 403 Forbidden

"detail": "Forbidden"

You do not have permissions for this request.

Error - 422 Unprocessable Entity

Validation

Notes

data_source_id: notDigits

data_source_id must be integer

make_id: notDigits

make_id must be integer

model_code: stringLengthTooShort

Must be greater than 1 character

Get Model by Model ID

Return requested model details.

Requires QuoteVariants:Get permission.

Go to Roles / APIs and check on QuoteVariants:Get.

HTTP Method

GET

Input - Header

Header should contain 'Accept' key with value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.

Input - Body

Field

Format

Notes

Mandatory

model_id

string

Model ID

Yes

URL Example

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

Successful Output

{ "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 - 401 Unauthorized

"detail": "Unauthorized"

Login token expired. Generate new token.

Error - 403 Forbidden

"detail": "Forbidden"

You do not have permissions for this request.

Error - 404 Not Found

"detail": "Invalid model id"

Entered model_id cannot be found.

Get Make by Make ID

Return requested make details.

Requires QuoteVariants:Get permission.

Go to Roles / APIs and check on QuoteVariants:Get.

HTTP Method

GET

Input - Header

Header should contain 'Accept' key with value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.

Input - Body

Field

Format

Notes

Mandatory

make_id

string

Make ID

Yes

URL Example

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

Successful Output

{ "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 - 401 Unauthorized

"detail": "Unauthorized"

Login token expired. Generate new token.

Error - 403 Forbidden

"detail": "Forbidden"

You do not have permissions for this request.

Error - 404 Not Found

"detail": null

Entered make_id cannot be found.

Get Model Years for Vehicle Model

List all years for selected vehicle model.

Requires QuoteVariants:Get permission.

Go to Roles / APIs and check on QuoteVariants:Get.

HTTP Method

GET

Input - Header

Header should contain 'Accept' key with value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.

Input - Body

Field

Format

Notes

Mandatory

model_id

string

Model ID

Yes

profile_required_flag

string

If yes, display model years only for qt_variants with qt_variant_profiles record with date valid for current invocation date (on or before run date)

No

URL Example

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

Successful Output

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

Error - 401 Unauthorized

"detail": "Unauthorized"

Login token expired. Generate new token.

Error - 403 Forbidden

"detail": "Forbidden"

You do not have permissions for this request.

Error - 422 Unprocessable Entity

Validation Notes

model_id: notDigits

model_id must be integer