Skip to main content
Quote / Variants

getVariantPhotos

getVariantPhotos

Overview

This method will return photo URI of selected variants.

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

photo_type

array[string]

Option to do multiple select on: rear, front, interior, side and engine options.

No

Input URL Examples

https://api.test.catch-e.com/qt/variants/photos?variant_id=167353&photo_type=front,rear,interior,side,engine 

(Successful) Output Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/variants/photos?variant_id=167353&photo_type=front,rear,interior,side,engine&page=1" }, "first": { "href": "https://api.test.catch-e.com/qt/variants/photos?variant_id=167353&photo_type=front,rear,interior,side,engine" }, "last": { "href": "https://api.test.catch-e.com/qt/variants/photos?variant_id=167353&photo_type=front,rear,interior,side,engine&page=1" } }, "_embedded": { "qt_variant_photos": [ { "photo_id": 283862, "variant_id": 167353, "photo_type": "front", "photo_uri": "https://demo.test.catch-e.net.au/core/services/Redbook/photos/AUS/S0005LLJ.jpg", "photo_code": "S0005LLJ", "description": "", "data_source_id": 100001 }, { "photo_id": 283863, "variant_id": 167353, "photo_type": "rear", "photo_uri": "https://demo.test.catch-e.net.au/core/services/Redbook/photos/AUS/S0005LLK.jpg", "photo_code": "S0005LLK", "description": "", "data_source_id": 100001 } ] }, "page_count": 1, "page_size": 25, "total_items": 2, "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.

Detail

Validation Messages

Comments

422 - Unprocessable Entity

"detail": "Failed Validation"

"variant_id": { "notDigits": "The input must contain only digits" }

variant_id passed needs to be integer.