Documentation - V1

Last updated: August 21th, 2023

Pack

A pack has the following structure : 


        {
            "id": "39815A69-6C58-7B1D-DA16-29A6D975D489",
            "label": "Pass de 10 places",
            "typeid": 20,
            "description": "Voici la description",
            "itemnb_min": 0,
            "itemnb_max": 10,
            "mainpackid": "",
            "shop_url": "http://shop.utick.local/wheretobuy",
            "image_url": "https://library.utick.be/packs/image.jpg"
        }
Parameter Values Description
id uuid unique ID for this pack
label string pack's label
description string pack's description
typeid See typeid list below the type of the pack
shop_url url the direct URL to the booking page
image_url url link to the main image of the attraction

Pack type ids

Id Description
1 Standard
10 Shopping
20 Passport
100 Card

List packs

/catalogue/packs/

Access control : for application

Retreive the list of published packs

Parameter Values Description
limit integer the number of records to return (200 max)
offset integer record offset
/{id} string pack details

Stocks in a pack

/catalogue/packs/details/{id}/

Access control : for application

Get the stocks available in a pack

Parameter Values Description
{id} * string pack id
stockid string to stockid to filter
In addition to basic pack information, this call returns a list of sets (id, label, description, itemnb_min, itemnb_max) which contain the list of stocks available in the pack.

Stream

A stream has the following structure : 


    {
      "id": "97B8994B-D521-A2C2-FA06-982B5F1DAFD2",
      "label": "Fullshow on Video",
      "description": "Marcus Zingerman, est un puissant industriel. ....",
      "starttime": null,
      "endtime": null,
      "accessendtime": null,
      "url": "https://vod.theatre.be/",
      "shop_url": "http://shop.utick.local/wheretobuy",
      "access_duration": "48",
      "freeaccess_packs": true,
      "freeaccess_seats": true,
      "status": {
            "id": 10,
            "label": "Published"
        },
       "venue" :{the venue object},
       "attraction" :{the attraction object}

    }
Parameter Values Description
id uuid unique ID for this stream
label string stream's label
description string stream's description
starttime iso 8601 date string/null the start date of the stream event
endtime iso 8601 date string/null the end date of the stream event
accessendtime iso 8601 date string/null the access end date of the stream event
url url the direct URL to the stream
shop_url url the direct URL to the booking page
access_duration integer the validity duration (in hours) after the first stream access
freeaccess_packs boolean the owner of a pack can have free access to this stream
freeaccess_seats boolean the owner of a seat ticket can have free access to this stream
status See status list below the current status of the stream
venue venue structure (see above) the information venue which hosts this stream
attraction attraction structure (see above) the information venue which hosts this stream

Stream status codes

Code Description
10 Published
11 No booking
20 Cancelled

List streams

/catalogue/streams/

Access control : for application

Retreive the list of streams

Parameter Values Description
limit integer the number of records to return (200 max)
offset integer record offset
/{id} string stream details

Control stream access

/catalogue/streams/{id}/control/

Access control : for application

Control access to a specific stream

Parameter Values Description
{id} * string stream id
contactid string contact id
accesscode string stream access code

Return code

Code Description
-1 Access denied
1 Access granted
10 Access granted (stream purchased)
20 Access granted (related product purchased)
30 Access granted (related pack purchased)