GETADITUS/Assets/Images/Get image

Get image

GET{{API_BASE_URL}}/assets/v1/images/:imageKey?context=orderItem:{{ORDER_ITEM}}&useFallback=True&language={{LANGUAGE}}

Request

This endpoint makes an HTTP GET request to retrieve a dynamic background picture for a specific context, with the option to use a fallback image and specify the language.

The context can be an appearance, an exhibitor or a order item.

Response

  • type (object): The type

  • properties: The properties of the image

    • imageURL: The image URL

      • type (string): The type of the image URL
    • dimensions: The with and height of the image

      • type (object)

      • properties:

        • width:

          • type (integer)
        • height:

          • type (integer)
    • metadata: The metadata of the image

      • type (object)

      • additional properties (boolean)

The response will include the details of the image, such as the image URL, dimensions, and any additional metadata.

(It is not possible to save media type responses as examples in this documentation.)

Authentication#auth

This endpoint does not require authentication.

Query parameters#query

contextorderItem:{{ORDER_ITEM}}optional

Schema: "{type}:{id}"

useFallbackTrueoptional
language{{LANGUAGE}}optional

Responses#responses

No example responses on file.