Skip to content

Endpoints

Jump to bottom
Dimitar Atanasov edited this page Oct 16, 2024 · 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.com/v2/partners/me \
       -u your_api_key:




GET /v2/partners/{id}

CURL EXAMPLE

$ curl -G https://api.entase.com/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.com/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.com/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 in local timezone specified by location.timezone
  • 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 (int) - 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.validated - (int) Total seats validated
  • stats.totalAmount - (int) Total amount of the seats selled. Amount in cents.
  • 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.timezone - (string) Timezone of the location
  • 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.




EventPricelist Object

The EventPricelist object contains pricing information about the event.

PROPERTIES

  • id (string) - ID of the price list
  • eventID (string) - ID of the event
  • pricelist (array, key-value pairs) - Price list by seat groups. Price amounts are in cents.
  • dateCreated (timestamp) - When the price list was created.




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, pricelist.
Example: extend[0] = productionTitle & extend[1] = productionStory.

CURL EXAMPLE

$ curl -G https://api.entase.com/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.com/v2/events/{id} \
       -u your_api_key:




GET /v2/events/{id}/pricelists

Retrieve event price lists.

CURL EXAMPLE

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




GET /v2/events/{id}/pricelists/{pricelist_id}

Get specific price list. Use latest for retrieving the latest one.

CURL EXAMPLE

$ curl -G https://api.entase.com/v2/events/{id}/pricelists/{pricelist_id} \
       -u your_api_key:
$ curl -G https://api.entase.com/v2/events/{id}/pricelists/latest \
       -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.com/v2/photos/object/{objref} \
       -u your_api_key: \
       -d "serve[0]"=300x300




BookingOrders

BookingOrder Object

The BookingOrder object contains all information about a customer booking for event.

PROPERTIES

  • id (string) - ID of the order
  • code (string) - Booking code. Format: AAA-BBB-CCC.
  • ownerRef (object ref string) - Owner of the event. The same partner that holds the API key unless co-hosting.
  • eventID (string) - ID of the event.
  • eventPricelistID (string) - ID of the event price list at the time of the order.
  • channel (int) - Order channel. 0 online, 1 desk (box office)
  • operatorRef (object ref string) - Operator of the order. Can be either User or WebRef.
  • originalAmount (int) - Total amount without any discounts. Amount in cents.
  • amount (int) - Total amount paid by the user, after all discounts. Amount in cents.
  • currency (string) - Currency of the order.
  • note (string) - Optional note by operator.
  • customerInfo (object). Customer info.
  • discountItems (array). Information about the discounts applied.
  • status (int) - Order status. 0 pending, 1 completed, 2 confirmed, 3 canceled, 4 refunded. Valid orders are in status 2 confirmed.
  • validForEvent (bool) - Indicates if order was canceled due to event cancelation. Then the status would be 3 canceled.
  • dateConfirmed (timestamp) - Date/time of the order confirmation.
  • dateCreated (timestamp) - Date/time of the order creation (initiation).
  • additionalData (array) - Additional data such as customer language, etc.
  • segmentCode (string) - Segmed code (if applied).
  • cohosting - (bool) - Whether the event is shared with other partner.
  • cohostRef - (object ref string) - Co-hosting partner. NULL if cohosting is FALSE.




OrderTicket Object

The OrderTicket object contains information about the issued tickets and performed validations.

PROPERTIES

  • id (string) - ID of the price list
  • code (string) - Ticket code. May be different from the booking code in case multiple tickets are issued.
  • orderID (string) - ID of the booking order
  • seats (array) - OrderTicketSeat items
  • validations (array) - OrderTicketValidation items
  • price (int) - price of the ticket. Amount in cents.
  • consumed (bool) - Indicates if all seats are validated
  • dateConsumed (timestamp) - Date/time when the last remaining seat is validated




BookingOrder Endpoints

GET /v2/bookingorders

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: eventID, status, channel.
Example: filter[status][0] = 1 & filter[status][1] = 2 & filter[eventID] = 63217c55cb925f6f3d0c11e7.

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

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

CURL EXAMPLE

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




GET /v2/bookingorders/{id|code}

Get booking order by id or code.

CURL EXAMPLE

$ curl -G https://api.entase.com/v2/bookingorders/{id} \
       -u your_api_key:
$ curl -G https://api.entase.com/v2/bookingorders/{code} \
       -u your_api_key:




GET /v2/bookingorders/{id|code}/tickets

Get all tickets associated with an order. Pass either order id or booking code.

CURL EXAMPLE

$ curl -G https://api.entase.com/v2/bookingorders/{id|code}/tickets \
       -u your_api_key:




GET /v2/bookingorders/{id|code}/tickets/{ticket_id|ticket_code}

Get specific ticket associated with an order. Pass either id or ticket code.

CURL EXAMPLE

$ curl -G https://api.entase.com/v2/bookingorders/{id|code}/tickets/{ticket_id|ticket_code} \
       -u your_api_key:




Clone this wiki locally