Skip to main content
Quote / Variants

getVariantModelYears

getVariantModelYears

Overview

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)

Field

Format

Notes

Default Value

Mandatory

Model id

Model id

Model id

Yes

profile_required_flag

string

If yes, display model years 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

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

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_id": { "notDigits": "The input must contain only digits"}

model_id passed needs to be integer.