Skip to main content
Quote / Variants

getStandardVariantEquipment

getStandardVariantEquipment

Overview

This method will list all standard equipment for selected variant.

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

variant_id

string

Variant id

Yes

page

string

Page number. Defaults to 1

No

page_size

string

Page size. Defaults to 25 records per page.

No

Input URL Examples

https://api.test.catch-e.com/qt/variants/167353/standard-equipment?page=1&page_size=5 

(Successful) Output Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/variants/167353/standard-equipment?page=1" }, "first": { "href": "https://api.test.catch-e.com/qt/variants/167353/standard-equipment" }, "last": { "href": "https://api.test.catch-e.com/qt/variants/167353/standard-equipment?page=30" }, "next": { "href": "https://api.test.catch-e.com/qt/variants/167353/standard-equipment?page=2" } }, "_embedded": { "qt_variant_standard_equipment": [ { "standard_equipment_id": 131171, "description": "12V Socket(s) - Auxiliary" }, { "standard_equipment_id": 100142, "description": "18\" Alloy Wheels" }, { "standard_equipment_id": 100039, "description": "8 Speaker Stereo" }, { "standard_equipment_id": 100001, "description": "ABS (Antilock Brakes)" }, { "standard_equipment_id": 100511, "description": "Active Torque Transfer System" } ] }, "page_count": 30, "page_size": 5, "total_items": 148, "page": 1 } 

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": null

Entered variant_id cannot be found.