Sign in

Retrieve all events

Changed on
get/api/v1/events

Request

  • Base URL: http://varnish:8080
  • URL: http://varnish:8080/api/v1/events
  • Auth: one of:
    • HTTP basic
    • cookie (a scheme the document does not define)

Query parameters

_format'json' required

Request format

from_datestring date

Retrieve events which occur after and including the provided date. In ISO 8601 format.

Response

List of all publicly available events.

uuidstring uuid required

A unique identifier for the event.

titlestring required

The event title.

descriptionstring

The short event description.

urlstring uri required

An absolute URL end users should use to view the event at the website.

created_atstring date-time required

When the event was created. In ISO 8601 format.

updated_atstring date-time required

When the event was last updated. In ISO 8601 format.

ticket_manager_relevanceboolean

Whether the event is marked as relevant for ticket management systems

state'TicketSaleNotOpen' | 'Active' | 'SoldOut' | 'Cancelled' | 'Occurred' required

The state of the event.

all_dayboolean

Whether the event is marked as an all-day event, without time relevance.

branchesstring[]

The associated library branches.

branch_isil_idsstring[]

External branch ids (ISIL) for the associated library branches. Aligned by index with the branches property, and always the same length. An entry is an empty string when no ISIL has been configured for that branch in the CMS.

categoriesstring[]

The categories associated with the event.

audiencesstring[]

The audiences associated with the event.

tagsstring[]

The tags associated with the event.

partnersstring[]

The partners associated with the event.

ticket_capacityinteger

Total number of tickets which can be sold for the event.

bodystring

An editorial WYSIWYG/HTML description of the event.

screen_namesstring[]

The screens this event should be shown on.

Example response

[
  {
    "branch_isil_ids": [
      "DK-710100"
    ]
  }
]

Changes