General

Request structure

All URIs and their underlying operations are resource based.

The structure of the URIs is as follows:

product/version/area/sub-area(s)/resource

For example:

• product: shop

• version: v1

• area: discovery

• sub-area: events

• resource: ED24

➔ /shop/v1/discovery/events/ED24

Response structure

1. All responses contain at least the data node.

2. All answers that modify the cart (add or remove an item or voucher) always contain the current cart in the data/cart attribute in addition to the respective information about the modification. Details can be found in the Scheme of the respective operation.

3. If a request produced an error, the response will contain an error node instead of the data node. This error node contains a single error object, which may contain further details. This follows a standardized structure derived from the Result base class and contains the following information:

• Code

• Name

• Category

• Message

• LogId

• Severity

• Details

Identifier

1. All identifiers are represented as GUID

2. An event can also always be represented by using the slug (in addition to the GUID). This means that whenever the resource eventIdentifier is used, both usages lead to the same response:

   1. GET /shop/v1/discovery/events/ED24

   2. GET /shop/v1/discovery/events/f2e25737-4990-ee11-93cf-00155d960409

3. An user can always be represented by the id or the email address. That means that whenever the resource userIdentifier is used, both usages lead to the same response:

   1. GET /shop/v1/user/m.muster@email.com/profile

   2. GET /shop/v1/user/f2e25737-4990-ee11-93cf-00155d960409/profile

Localization

In order for textual resources within the response to be output in the user's language, the language must be transmitted as ISO-2 language code in the Accept-Language header.