Skip to content

Endpoints

Dimitar Atanasov edited this page Sep 22, 2022 · 15 revisions

Productions

Production Object

The Production object contains all information about the nature of the events.

PROPERTIES

  • id (string) - ID of the production
  • title (string) - Production title
  • story (markup string) - Production story
  • tags (array) - Tags extracted from the story.
  • tags.name (string) - Tag name.
  • tags.type (int) - TagType enumeration. 0 for Hashtag, 1 for Persontag.
  • length (int) - Length in minutes.
  • minAgeRestriction (int) - Age restriction. 0 for no restriction.
  • dateCreated (timestamp) - When production was created


Production Endpoints

GET /v2/productions

INPUT / SORT

  • sort - Sort by field.

Fields: id.
Directions: asc | desc. Default: desc.
Example: sort[id] = asc.

INPUT / PAGING

  • after - Server after object ID.
  • limit - Limit the response. Min: 1. Max: 100. Default: 30.

CURL EXAMPLE

$ curl -G https://api.entase.bg/v2/productions \
       -u your_api_key: \
       -d limit=10 \
       -d "sort[id]"=asc




GET /v2/productions/{id}

CURL EXAMPLE

$ curl -G https://api.entase.bg/v2/productions/{id} \
       -u your_api_key:




Events

Event Object

The Event object contains all information about the specific date and terms. When and where the production will take place.

PROPERTIES

  • id (string) - ID of the event
  • productionID (string) - ID of the production
  • dateCreated (timestamp) - When the event was created
  • dateStart (timestamp) - Event start date/time
  • dateInSell (timestamp) - When the Event will transit into OpenSell status.
  • isLocked (bool) - Indicates whether first order took place.
  • ownerRef (object ref string) - Owner of the event
  • pricelist (array, key-value pairs) - Price list by seat groups.
  • pricePolicyID (string) - ID of the price policy applied
  • reportState (string) - Report state. 0 pending, 1 reported, 2 invoiced, 3 no invoice.
  • status (string) - Event status. 0 pending, 1 open sell, 2 closed sell, 3 finished, 4 canceled, 5 rescheduling
  • stats - Current statistics
  • stats.capacity - Capacity for the event
  • stats.reserved - Seats reserved
  • stats.selled - Seats selled
  • stats.totalAmount - Total amount of the seats selled
  • location - Event location
  • location.countryCode - Country code
  • location.countryName - Country name
  • location.cityName - City name
  • location.postCode - Post code
  • location.placeName - Name of the place
  • location.lat - GPS Latitude
  • location.lng - GPS Longitude


Event Endpoints

GET /v2/events

INPUT / SORT

  • sort - Sort by field.

Fields: id.
Directions: asc | desc. Default: desc.
Example: sort[id] = asc.

INPUT / PAGING

  • after - Server after object ID.
  • limit - Limit the response. Min: 1. Max: 100. Default: 30.

INPUT / OTHERS

  • filter - Filter by property value.

Fields: productionID, status, isLocked, reportState.
Example: filter[status][0] = 1 & filter[status][1] = 2 & filter[productionID] = 63217c55cb925f6f3d0c11e7.

CURL EXAMPLE

$ curl -G https://api.entase.bg/v2/events \
       -u your_api_key: \
       -d limit=10 \
       -d "sort[id]"=asc \
       -d "filter[status][0]"=1 \
       -d "filter[status][1]"=2




GET /v2/events/{id}

CURL EXAMPLE

$ curl -G https://api.entase.bg/v2/events/{id} \
       -u your_api_key:




Photos

Photos are retrieved individually for every object.

Photos Endpoints

GET /v2/photos/object/{objref}

INPUT / OTHERS

  • serve (array) - Sizes needed. The API will return photos in the closest available size.

CURL EXAMPLE

$ curl -G https://api.entase.bg/v2/photos/object/{objref} \
       -u your_api_key: \
       -d "serve[0]"=300x300




Clone this wiki locally