Regions

Connect can be configured to return a subset of data depending on a supplied Region Code. Allowing two distinct cinema circuits - for example, circuits across two different countries - to use a single instance of Connect.

Retrieving configured regions

If regions are configured in your Connect instance, they can be retrieved from the Regions endpoints. The code property of the region you want to use should then be provided back to Connect as the Region Code.

Providing a region code to Connect

To get data specific to a given region provide the Region Code in a Connect-Region-Code HTTP header on every request made to Connect. Connect will then only return data relevant to that region. Note that this does not change the response structure in any way, only the data returned in that response.

If an invalid Region Code is provided Connect will return the following response.

HTTP Response Code 400

{
    "exceptionType": "WSVistaWebClient.ServiceImplementation.RegionHeaderExceptionHelper",
    "errorDescription": "Connect-Region-Code provided is invalid"
}