Skip to main content
Quote / Variants

getVariantModel

getVariantModel

Overview

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)

Field

Format

Notes

Mandatory

model_id

string

Model ID

Yes

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

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.

404 - Not Found

"detail": "Invalid model id"

Entered model_id cannot be found.