Events API

Field descriptions

Field Type Description
id integer The identifier of the event.
seccode string Seccode for the event. Seccode is used in some cases as an id for the event.
name string Name of the event
state string Indicate the state of the event.
* draft - event is not open for sale, and do not appear on any public sales lists.
* passive - event is not open for sale, but are exported to external partners
* published - event genneral available. Can be opne for sale depending on sales period and ticket availability
* held - event is held and closed for sale. Avaiting payout.
* completed - event is closed and event balance closed.
active boolean Indicate if an event is open for sale (if it is published, there are tickets for sale and current date is with in sales period). Often used to “pause” an event during sales.
mute boolean When muted the event doesn’t send emails. Default false.
bank_account_id integer  
description_short string The short description has a maximum length of 255 characters. If length is exceeded the extra characters will be ignored.
description_long string The long description does not have a maximum length.
begin_at datetime Note: After first sale it is no longer possible to change the date of begin_at to at date before begin_at. The time can still changes.
end_at datetime  
sale_open_at datetime  
sale_close_at datetime  
capacity integer The capacity can be either an integer or the character ‘∞’ which states that the capacity is unlimited.
passive boolean The passive bit allows you to create events without ticket sales. A passive event can be used for automatic Kultunaut export even when you don’t need the ticket sales part.
kultunaut_export boolean If true the event will be sendt to external partner kultunaut.dk. Default false.
kultunaut_age_group string Possible values are Alle, Børn, Unge, Voksne or Ældre.
kultunaut_picture_uri string Full url to the picture used at kultunaut.dk
kultunaut_export_category string  
waiting_list boolean If true a waitinglist is a available on the event if sold out occur. Does not indicate if the event is currently soldout
show_vat boolean  
sms_included boolean  
ticket_fee integer  
sales_workflow_type string  
passive boolean Indicating whether the event is passive.
address hash The address for the event with parameters
address.address1 string Main address
address.address2 string Secondary address
address.postal_code string  
address.city string  
address.phone string  
address.country string The country parameter must follow the ISO 3166-alpha-2 codes defined in: https://www.iso.org/iso-3166-country-codes.html
metadata hash Metadata of the event.
metadata.event_state string simplified state of the event.
* passive - event is not open for sale
* published - event genneral available. Can be open for sale depending on sales period and ticket availability
* paused - event is not open for sale.
metadata.sales_status string Indicate the sales status of the event.
* open - Ticket sale is open.
* upcoming - ticket sale will open later
* closed - Sale is not open.
metadata.available_tickets integer Indicating the amount of available tickets for the event. 200000 = unlimited.
metadata.scanned_tickets integer Indicating the amount of scanned tickets for the event.
metadata.deleteable integer Indicating if an event is deletable. An event will generally be deletable if there has been no sales and state is draft or published.
links hash sub links to the event.
links.prices string url for retrieving prices of the event.
links.sales_location string sales workflow location.

List events

List all events for a specific event maker

GET /event_makers/:event_maker_id/events

If you want to user pagination

GET /event_makers/:event_maker_id/events?per_page=10&page=10

Input

per_page
Optional integer - Defines number of Event per page, default value 200.
page
Optional integer
event_begin_at_after
Optional datetime - any event on or after the supplied date
event_begin_at_before
Optional datetime - any event on or before the supplied date

Response

Status: 200 OK
[
  {
    "id": 12345678,
    "name": "Eventbureauets første arrangement",
    "mute": false,
    "bank_account_id": 354,
    "description_short": "Det første arrangement som arrangereres af Eventbureauet",
    "description_long": "Kom og vær med til åbningen. Det bliver et brag af en fest!!",
    "begin_at": "2014-06-21T12:00:00Z",
    "end_at": "2014-06-21T16:00:00Z",
    "sale_open_at": "2011-06-21T10:00:00Z",
    "sale_close_at": "2014-06-21T10:00:00Z",
    "capacity": 1500,
    "kultunaut_export": true,
    "kultunaut_age_group": "Voksen",
    "kultunaut_picture_uri": "http://example.com/eventbureaut_picture_uri",
    "kultunaut_export_category": "Elektronisk",
    "show_vat": false,
    "sms_included": true,
    "ticket_fee": 0,
    "sales_workflow_type": "tickets",
    "address": {
      "address1": "Nørrelundvej 5",
      "address2": "",
      "postal_code": "2730",
      "city": "Herlev",
      "phone": "+45 7023 2550",
      "country": "DK"
    },
    "links": {
      "prices": "https://api.place2book.com/event_makers/evm1234567/events/12345678/prices",
      "sales_location": "https://www.place2book.com/da/sales_workflow/choose_tickets?seccode=12345678"
    },
    "meta_data": {
      "scanned_tickets": 7
    }
  }
]

Get a single event

Retrieves the event identified by event id.

GET /event_makers/:event_maker_id/events/:event_id

Response

Status: 200 OK
{
  "id": 12345678,
  "name": "Eventbureauets første arrangement",
  "mute": false,
  "bank_account_id": 354,
  "description_short": "Det første arrangement som arrangereres af Eventbureauet",
  "description_long": "Kom og vær med til åbningen. Det bliver et brag af en fest!!",
  "begin_at": "2014-06-21T12:00:00Z",
  "end_at": "2014-06-21T16:00:00Z",
  "sale_open_at": "2011-06-21T10:00:00Z",
  "sale_close_at": "2014-06-21T10:00:00Z",
  "capacity": 1500,
  "kultunaut_export": true,
  "kultunaut_age_group": "Voksen",
  "kultunaut_picture_uri": "http://example.com/eventbureaut_picture_uri",
  "kultunaut_export_category": "Elektronisk",
  "show_vat": false,
  "sms_included": true,
  "ticket_fee": 0,
  "sales_workflow_type": "tickets",
  "address": {
    "address1": "Nørrelundvej 5",
    "address2": "",
    "postal_code": "2730",
    "city": "Herlev",
    "phone": "+45 7023 2550",
    "country": "DK"
  },
  "links": {
    "prices": "https://api.place2book.com/event_makers/evm1234567/events/12345678/prices",
    "sales_location": "https://www.place2book.com/da/sales_workflow/choose_tickets?seccode=12345678"
  },
  "meta_data": {
    "scanned_tickets": 7
  }
}

Error codes

Status: 404 Not Found

Create an event

POST /event_makers/:event_maker_id/events

Input

name
Required string
mute
Optional boolean - Default true
bank_account_id
Optional integer
description_short
Optional string
description_long
Optional string
begin_at
Required datetime
end_at
Optional datetime
sale_open_at
Optional datetime
sale_close_at
Optional datetime
capacity
Required integer
passive
Optional boolean
kultunaut_export
Optional boolean
kultunaut_age_group
Optional string - Possible values are Alle, Børn, Unge, Voksne or Ældre.
kultunaut_picture_uri
Optional string -
kultunaut_export_category - Contact Place2Book for at current list for valid values.
Optional string
show_vat
Optional boolean
sms_included
Optional boolean
ticket_fee
Optional integer
sales_workflow_type
Optional string
address
Required hash
address1
Required string
address2
Optional string
postal_code
Required string
city
Required string
phone
Required string
country
Required string
prices
Required array - An array of prices for the event with parameters:
name
Required string
description
Optional string
value
Optional integer - Price in cents, eg. 299 and not 2.99.
minimum_count
Optional integer
maximum_count
Optional integer
sale_begin_at
Optional datetime
sale_end_at
Optional datetime 
{
  "event": {
    "name": "Eventbureauets første arrangement",
    "description_short": "Det første arrangement som arrangereres af Eventbureauet",
    "description_long": "Kom og vær med til åbningen. Det bliver et brag af en fest!!",
    "begin_at": "2014-06-21T12:00:00Z",
    "end_at": "2014-06-21T16:00:00Z",
    "sale_open_at": "2011-06-21T10:00:00Z",
    "sale_close_at": "2014-06-21T10:00:00Z",
    "capacity": 1500,
    "kultunaut_export": true,
    "kultunaut_age_group": "Voksen",
    "kultunaut_picture_uri": "http://example.com/eventbureaut_picture_uri",
    "kultunaut_export_category": "Elektronisk",
    "address": {
      "address1": "Wildersgade 51, 1",
      "address2": "",
      "postal_code": "1408",
      "city": "København K",
      "phone": "+45 7023 2550",
      "country": "DK"
    }
  }
}

Response

Status: 201 Created
Location: https://api.place2book.com/event_makers/evm1234567/events/ev12345678
{
  "id": 12345678,
  "name": "Eventbureauets første arrangement",
  "mute": false,
  "bank_account_id": 354,
  "description_short": "Det første arrangement som arrangereres af Eventbureauet",
  "description_long": "Kom og vær med til åbningen. Det bliver et brag af en fest!!",
  "begin_at": "2014-06-21T12:00:00Z",
  "end_at": "2014-06-21T16:00:00Z",
  "sale_open_at": "2011-06-21T10:00:00Z",
  "sale_close_at": "2014-06-21T10:00:00Z",
  "capacity": 1500,
  "kultunaut_export": true,
  "kultunaut_age_group": "Voksen",
  "kultunaut_picture_uri": "http://example.com/eventbureaut_picture_uri",
  "kultunaut_export_category": "Elektronisk",
  "show_vat": false,
  "sms_included": true,
  "ticket_fee": 0,
  "sales_workflow_type": "tickets",
  "address": {
    "address1": "Nørrelundvej 5",
    "address2": "",
    "postal_code": "2730",
    "city": "Herlev",
    "phone": "+45 7023 2550",
    "country": "DK"
  },
  "links": {
    "prices": "https://api.place2book.com/event_makers/evm1234567/events/12345678/prices",
    "sales_location": "https://www.place2book.com/da/sales_workflow/choose_tickets?seccode=12345678"
  },
  "meta_data": {
    "scanned_tickets": 7
  }
}

Error codes

Status: 400 Bad Request
Status: 500 Server Error

Update an event

PUT /event_makers/:event_maker_id/events/:event_id

Input

Input is identical to the input on create.

Response

Status: 200 OK
{
  "id": 12345678,
  "name": "Eventbureauets første arrangement",
  "mute": false,
  "bank_account_id": 354,
  "description_short": "Det første arrangement som arrangereres af Eventbureauet",
  "description_long": "Kom og vær med til åbningen. Det bliver et brag af en fest!!",
  "begin_at": "2014-06-21T12:00:00Z",
  "end_at": "2014-06-21T16:00:00Z",
  "sale_open_at": "2011-06-21T10:00:00Z",
  "sale_close_at": "2014-06-21T10:00:00Z",
  "capacity": 1500,
  "kultunaut_export": true,
  "kultunaut_age_group": "Voksen",
  "kultunaut_picture_uri": "http://example.com/eventbureaut_picture_uri",
  "kultunaut_export_category": "Elektronisk",
  "show_vat": false,
  "sms_included": true,
  "ticket_fee": 0,
  "sales_workflow_type": "tickets",
  "address": {
    "address1": "Nørrelundvej 5",
    "address2": "",
    "postal_code": "2730",
    "city": "Herlev",
    "phone": "+45 7023 2550",
    "country": "DK"
  },
  "links": {
    "prices": "https://api.place2book.com/event_makers/evm1234567/events/12345678/prices",
    "sales_location": "https://www.place2book.com/da/sales_workflow/choose_tickets?seccode=12345678"
  },
  "meta_data": {
    "scanned_tickets": 7
  }
}

Error codes

Status: 404 Not Found
Status: 500 Server Error

Delete an event

DELETE /event_makers/:event_maker_id/events/:event_id

Response

Status: 204 No Content

List purchases

List all purchases for a specific event

GET /event_makers/:event_maker_id/events/:event_id/purchases

Response

Status: 200 OK
[
  {
    "purchase_id": 1545123,
    "customer_profile_id": 56421234,
    "full_name": "John Doe",
    "email": "your@email.com",
    "phone_number": "+4512345678",
    "zip_code": "12323",
    "total_price_paid": 642100,
    "transaction_type": "completed",
    "created_at": "2014-06-21T10:00:00Z",
    "tickets": [
      {
        "ticket_id": 124665,
        "price_id": 765333,
        "total_amount_paid": 80000,
        "seating": "Row 3 Seat 5",
        "barcode": "ABCD1234",
        "custom_fields": [
          {
            "custom_field_name": "Your height",
            "value": "187 cm"
          }
        ],
        "additional_sales": [
          {
            "additional_sale_id": 342946,
            "additional_id": 234673,
            "additional_name": "additional",
            "debit_total_for_customer": 10000
          }
        ]
      },
      {
        "ticket_id": 124666,
        "price_id": 765333,
        "total_amount_paid": 80000,
        "seating": "Row 3 Seat 6",
        "barcode": "12345678",
        "custom_fields": [
          {
            "custom_field_name": "Your height",
            "value": "192 cm"
          }
        ],
        "additional_sales": [
          {
            "additional_sale_id": 342946,
            "additional_id": 234674,
            "additional_name": "additional",
            "debit_total_for_customer": 10000
          }
        ]
      }
    ],
    "custom_field_values": [
      {
        "custom_field_name": "Mode of transport",
        "value": "Car"
      }
    ]
  }
]

Error codes

Status: 403 Forbidden
Status: 404 Not Found