Event makers API
Field descriptions
| Field | Type | Description |
|---|---|---|
| id | integer | The identifier of the event maker/organiser |
| name | string | Name of the event maker/organiser |
| cvr | string | |
| company_name | string | |
| support_email | string | |
| mute | boolean | When muted the event maker doesn’t send emails. Default false. |
| 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 |
| links | hash | sub links to the event maker. |
| links.events | string | url for retrieving events of the event maker. |
| links.bank_accounts | string | url for retrieving bank_accounts. |
List event makers
List the authenticated user’s event makers
GET /event_makers
Response
Status: 200 OK
[
{
"id": 1234567,
"cvr": "28888880",
"name": "Eventbureauet",
"company_name": "Place2Book ApS",
"support_email": "support@place2book.com",
"mute": false,
"links": {
"events": "https://api.place2book.com/event_makers/1234567/events",
"bank_accounts": "https://api.place2book.com/event_makers/1234567/bank_accounts"
},
"address": {
"address1": "Nørrelundvej 5",
"address2": "",
"postal_code": "2730",
"city": "Herlev",
"phone": "70232550",
"country": "DK"
}
}
]
Get a single event maker
GET /event_makers/:id
Response
Status: 200 OK
{
"id": 1234567,
"cvr": "28888880",
"name": "Eventbureauet",
"company_name": "Place2Book ApS",
"support_email": "support@place2book.com",
"mute": false,
"links": {
"events": "https://api.place2book.com/event_makers/1234567/events",
"bank_accounts": "https://api.place2book.com/event_makers/1234567/bank_accounts"
},
"address": {
"address1": "Nørrelundvej 5",
"address2": "",
"postal_code": "2730",
"city": "Herlev",
"phone": "70232550",
"country": "DK"
}
}
Error codes
Status: 404 Not Found
Create an event maker
POST /event_makers
Input
- name
- Required string
- cvr
- Required string
- company_name
- Required string
- support_email
- Optional string
- mute
-
Optional boolean - Default
true - address
-
Required hash - The address for the event maker with parameters:
- address1
- Required string
- address2
- Optional string
- postal_code
- Required string
- city
- Required string
- phone
- Required string
- country
- Required string
{
"event_maker": {
"name": "the display name for the event maker",
"cvr": "cvr code for the event maker",
"company_name": "the official company name",
"support_email": "support email address",
"address": {
"address1": "main address",
"address2": "secondary address",
"postal_code": "postal code",
"city": "city",
"phone": "phone number",
"country": "country code according to the ISO 3166-alpha-2 standard: https://www.iso.org/iso-3166-country-codes.html"
}
}
}
Response
Status: 201 Created
Location: https://api.place2book.com/event_makers/1234567
{
"id": 1234567,
"cvr": "28888880",
"name": "Eventbureauet",
"company_name": "Place2Book ApS",
"support_email": "support@place2book.com",
"mute": false,
"links": {
"events": "https://api.place2book.com/event_makers/1234567/events",
"bank_accounts": "https://api.place2book.com/event_makers/1234567/bank_accounts"
},
"address": {
"address1": "Nørrelundvej 5",
"address2": "",
"postal_code": "2730",
"city": "Herlev",
"phone": "70232550",
"country": "DK"
}
}
Error codes
Status: 400 Bad Request
Status: 500 Server Error
Update an event maker
PUT /event_makers/:id
Input
Input is identical to the input on create.
Response
Status: 200 OK
{
"id": 1234567,
"cvr": "28888880",
"name": "Eventbureauet",
"company_name": "Place2Book ApS",
"support_email": "support@place2book.com",
"mute": false,
"links": {
"events": "https://api.place2book.com/event_makers/1234567/events",
"bank_accounts": "https://api.place2book.com/event_makers/1234567/bank_accounts"
},
"address": {
"address1": "Nørrelundvej 5",
"address2": "",
"postal_code": "2730",
"city": "Herlev",
"phone": "70232550",
"country": "DK"
}
}
Error codes
Status: 404 Not Found
Status: 500 Server Error
Delete an event maker
DELETE /event_makers/:id
Response
Status: 204 No Content
Error codes
Status: 403 Forbidden
Status: 404 Not Found