getVariantModels
getVariantModels
Overview
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)
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
Was this helpful?
More in Quote / Variants
getVariantDataSourcesgetVariantMakes getVariantModelgetVariantBodyTypesStill need help? Ask the team