Skip to content

Endpoints

Jump to bottom
Dimitar Atanasov edited this page Apr 6, 2023 · 15 revisions

Partners

Partner Object

The Partner object contains information about the Organizer (a.k.a Partner). It's usually referenced in ownerRef and cohostRef properties of other objects.

PROPERTIES

  • id (string) - ID of the partner
  • name (string) - Name of the partner


Partner Endpoints

GET /v2/partners/me

Current partner that holds the API key.

CURL EXAMPLE

$ curl -G https://api.entase.bg/v2/partners/me \
       -u your_api_key:




GET /v2/partners/{id}

CURL EXAMPLE

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




Productions

Production Object

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

PROPERTIES

  • id (string) - ID of the production
  • ownerRef (string) - Owner of the production. The same Partner that holds the API key unless co-hosting.
  • 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
  • cohosting (bool) - Whether the production is shared with current partner. If TRUE then the ownerRef will reference to a different partner.


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.

INPUT / OTHERS

  • extend - Result set extension. Provide additional info within same result set.

Fields: ownerName.
Example: extend[0] = ownerName.

CURL EXAMPLE

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




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
  • ownerRef (object ref string) - Owner of the event. The same partner that holds the API key unless co-hosting.
  • 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.
  • 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 - (Object) Current statistics
  • stats.capacity - (int) Capacity for the event
  • stats.reserved - (int) Seats reserved
  • stats.selled - (int) Seats selled
  • stats.totalAmount - (float) Total amount of the seats selled
  • location - (object) Event location
  • location.countryCode - (string) Country code
  • location.countryName - (string) Country name
  • location.cityName - (string) City name
  • location.postCode - (string) Post code
  • location.placeName - (string) Name of the place
  • location.lat - (float) GPS Latitude
  • location.lng - (float) GPS Longitude
  • cohosting - (bool) - Whether the event is shared with other partner.
  • cohostRef - (object ref string) - Co-hosting partner. NULL if cohosting is FALSE.
  • incomeTarget - (string) - The partner that will be holding the event income. Possible values - cohost referenced in cohostRef OR current referenced in ownerRef.

CO-HOSTING FLOW

  1. Partner A shares a production to Partner B.
  2. Partner B accepts the production.
  3. Partner B creates an event.

Partner A is owner of the production and co-host of the event. Partner B is cohost of the production and owner of the event.




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.

  • extend - Result set extension. Provide additional info within same result set.

Fields: productionTitle, productionStory.
Example: extend[0] = productionTitle & extend[1] = productionStory.

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 \
       -d "extend[0]"=productionTitle \




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