{"__v":12,"_id":"54d2cbfe2ce0e00d007515ef","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"API Endpoints:\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Listing Events\",\n    \"h-0\": \"Function\",\n    \"h-1\": \"Endpoint\",\n    \"h-2\": \"Request\",\n    \"1-0\": \"Event Detail\",\n    \"2-0\": \"Listing Event Questions\",\n    \"3-0\": \"Listing Attendees\",\n    \"4-0\": \"Attendee Detail\",\n    \"5-0\": \"Updating an Attendee\",\n    \"6-0\": \"Checking an Attendee in\",\n    \"7-0\": \"Updating an Attendee's Question\",\n    \"0-2\": \"GET\",\n    \"1-2\": \"GET\",\n    \"2-2\": \"GET\",\n    \"3-2\": \"GET\",\n    \"4-2\": \"GET\",\n    \"5-2\": \"POST\",\n    \"6-2\": \"POST\",\n    \"7-2\": \"POST\",\n    \"0-1\": \"/apps/api/events\",\n    \"1-1\": \"/apps/api/events/<event id>\",\n    \"2-1\": \"/api/events/<event id>/questions\",\n    \"3-1\": \"/apps/api/events/<event id>/attendees\",\n    \"4-1\": \"/apps/api/attendees/<attendee id>\",\n    \"5-1\": \"/apps/api/attendees/<attendee id>/update\",\n    \"6-1\": \"/apps/api/attendees/<attendee id>/checkin\",\n    \"7-1\": \"/apps/api/attendees/<attendee id>/update_questions\",\n    \"8-0\": \"Listing a user's Groups\",\n    \"9-0\": \"Creating an event\",\n    \"10-0\": \"Creating a registration type\",\n    \"11-0\": \"Editing a registration type\",\n    \"8-2\": \"GET\",\n    \"9-2\": \"POST\",\n    \"10-2\": \"POST\",\n    \"11-2\": \"POST\",\n    \"8-1\": \"/restapi/web/groups\",\n    \"9-1\": \"/restapi/events\",\n    \"10-1\": \"/restapi/events/<event id>/create_reservation_type\",\n    \"11-1\": \"/restapi/events/<event id>/update_reservation_type\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-02-05T01:48:46.666Z","excerpt":"This page will help you get started with Boomset Public API. You'll be up and running in a jiffy!","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"project":"54d2cbfc2ce0e00d007515e9","slug":"getting-started","sync_unique":"","title":"Boomset Public API","type":"basic","updates":[],"user":"54d2cb905616470d0013cc1f","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

Boomset Public API

This page will help you get started with Boomset Public API. You'll be up and running in a jiffy!

[block:api-header] { "type": "basic", "title": "API Endpoints:" } [/block] [block:parameters] { "data": { "0-0": "Listing Events", "h-0": "Function", "h-1": "Endpoint", "h-2": "Request", "1-0": "Event Detail", "2-0": "Listing Event Questions", "3-0": "Listing Attendees", "4-0": "Attendee Detail", "5-0": "Updating an Attendee", "6-0": "Checking an Attendee in", "7-0": "Updating an Attendee's Question", "0-2": "GET", "1-2": "GET", "2-2": "GET", "3-2": "GET", "4-2": "GET", "5-2": "POST", "6-2": "POST", "7-2": "POST", "0-1": "/apps/api/events", "1-1": "/apps/api/events/<event id>", "2-1": "/api/events/<event id>/questions", "3-1": "/apps/api/events/<event id>/attendees", "4-1": "/apps/api/attendees/<attendee id>", "5-1": "/apps/api/attendees/<attendee id>/update", "6-1": "/apps/api/attendees/<attendee id>/checkin", "7-1": "/apps/api/attendees/<attendee id>/update_questions", "8-0": "Listing a user's Groups", "9-0": "Creating an event", "10-0": "Creating a registration type", "11-0": "Editing a registration type", "8-2": "GET", "9-2": "POST", "10-2": "POST", "11-2": "POST", "8-1": "/restapi/web/groups", "9-1": "/restapi/events", "10-1": "/restapi/events/<event id>/create_reservation_type", "11-1": "/restapi/events/<event id>/update_reservation_type" }, "cols": 3, "rows": 12 } [/block]
[block:api-header] { "type": "basic", "title": "API Endpoints:" } [/block] [block:parameters] { "data": { "0-0": "Listing Events", "h-0": "Function", "h-1": "Endpoint", "h-2": "Request", "1-0": "Event Detail", "2-0": "Listing Event Questions", "3-0": "Listing Attendees", "4-0": "Attendee Detail", "5-0": "Updating an Attendee", "6-0": "Checking an Attendee in", "7-0": "Updating an Attendee's Question", "0-2": "GET", "1-2": "GET", "2-2": "GET", "3-2": "GET", "4-2": "GET", "5-2": "POST", "6-2": "POST", "7-2": "POST", "0-1": "/apps/api/events", "1-1": "/apps/api/events/<event id>", "2-1": "/api/events/<event id>/questions", "3-1": "/apps/api/events/<event id>/attendees", "4-1": "/apps/api/attendees/<attendee id>", "5-1": "/apps/api/attendees/<attendee id>/update", "6-1": "/apps/api/attendees/<attendee id>/checkin", "7-1": "/apps/api/attendees/<attendee id>/update_questions", "8-0": "Listing a user's Groups", "9-0": "Creating an event", "10-0": "Creating a registration type", "11-0": "Editing a registration type", "8-2": "GET", "9-2": "POST", "10-2": "POST", "11-2": "POST", "8-1": "/restapi/web/groups", "9-1": "/restapi/events", "10-1": "/restapi/events/<event id>/create_reservation_type", "11-1": "/restapi/events/<event id>/update_reservation_type" }, "cols": 3, "rows": 12 } [/block]
{"__v":1,"_id":"54d2d4185616470d0013cc2a","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"Authorization is a required header for every request.  To authenticate your requests, include a header for `Authorization` with a value of `Token ` followed by your API key, as shown below:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header Name\",\n    \"h-1\": \"Header Value\",\n    \"0-0\": \"Content-Type\",\n    \"0-1\": \"application/json\",\n    \"1-0\": \"Authorization\",\n    \"1-1\": \"Token 4f81fed8ec862793b0abb9318b2066c47439bb13\",\n    \"2-0\": \"9\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nYou can get your token from the API Key section of your profile, or by using the [login endpoint](https://boomset-public-api.readme.io/docs/login).","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-02-05T02:23:20.676Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"project":"54d2cbfc2ce0e00d007515e9","slug":"authentication","sync_unique":"","title":"Authentication","type":"basic","updates":[],"user":"54d2cb905616470d0013cc1f","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

Authentication


Authorization is a required header for every request. To authenticate your requests, include a header for `Authorization` with a value of `Token ` followed by your API key, as shown below: [block:parameters] { "data": { "h-0": "Header Name", "h-1": "Header Value", "0-0": "Content-Type", "0-1": "application/json", "1-0": "Authorization", "1-1": "Token 4f81fed8ec862793b0abb9318b2066c47439bb13", "2-0": "9" }, "cols": 2, "rows": 2 } [/block] You can get your token from the API Key section of your profile, or by using the [login endpoint](https://boomset-public-api.readme.io/docs/login).
Authorization is a required header for every request. To authenticate your requests, include a header for `Authorization` with a value of `Token ` followed by your API key, as shown below: [block:parameters] { "data": { "h-0": "Header Name", "h-1": "Header Value", "0-0": "Content-Type", "0-1": "application/json", "1-0": "Authorization", "1-1": "Token 4f81fed8ec862793b0abb9318b2066c47439bb13", "2-0": "9" }, "cols": 2, "rows": 2 } [/block] You can get your token from the API Key section of your profile, or by using the [login endpoint](https://boomset-public-api.readme.io/docs/login).
{"__v":0,"_id":"54d968f64c49f40d00dff95a","api":{"auth":"optional","examples":{"codes":[]},"params":[{"_id":"54d968f64c49f40d00dff95c","default":"","desc":"","in":"body","name":"username","ref":"","required":true,"type":"string"},{"_id":"54d968f64c49f40d00dff95b","default":"","desc":"","in":"body","name":"password","ref":"","required":true,"type":"string"}],"results":{"codes":[{"name":"","code":"{\n    \"token\": \"4f81fed8ec862793b0abb9318b2066c47439bb13\"\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/apps/api/auth"},"body":"With this endpoint you can login and retrieve your API key. With your key, you can [authenticate](https://boomset-public-api.readme.io/docs/authentication) all of your requests to the Boomset API.\n\nAlternatively, you may also retrieve your API key from your profile on the Boomset web platform.","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-02-10T02:12:06.169Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"project":"54d2cbfc2ce0e00d007515e9","slug":"login","sync_unique":"","title":"Login","type":"post","updates":[],"user":"54d2cb905616470d0013cc1f","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postLogin


username:
required
string
password:
required
string
With this endpoint you can login and retrieve your API key. With your key, you can [authenticate](https://boomset-public-api.readme.io/docs/authentication) all of your requests to the Boomset API. Alternatively, you may also retrieve your API key from your profile on the Boomset web platform.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



With this endpoint you can login and retrieve your API key. With your key, you can [authenticate](https://boomset-public-api.readme.io/docs/authentication) all of your requests to the Boomset API. Alternatively, you may also retrieve your API key from your profile on the Boomset web platform.
{"__v":17,"_id":"54d2da2b5616470d0013cc2e","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 23974,\n            \"group\": {\n                \"id\": 10956,\n                \"name\": \"Remy's Group\",\n                \"email\": null,\n                \"phone\": null,\n                \"website\": null,\n                \"fbpage\": null,\n                \"twitter\": null,\n                \"googleplus\": null\n            },\n            \"name\": \"Actual\",\n            \"startsat\": \"2015-02-04T18:00:00\",\n            \"endsat\": \"2015-03-06T19:13:00\",\n            \"timezone\": 8,\n            \"premium\": false,\n            \"created\": \"2015-02-05T00:13:00\",\n            \"modified\": \"2015-02-06T00:37:14\"\n        },\n        {\n            \"id\": 24172,\n            \"group\": {\n                \"id\": 11435,\n                \"name\": \"Developers\",\n                \"email\": null,\n                \"phone\": \"1-860-266-6738\",\n                \"website\": null,\n                \"fbpage\": null,\n                \"twitter\": null,\n                \"googleplus\": null\n            },\n            \"name\": \"Boomset Demo\",\n            \"startsat\": \"2015-01-01T19:00:00\",\n            \"endsat\": \"2017-12-31T23:00:00\",\n            \"timezone\": 8,\n            \"premium\": false,\n            \"created\": \"2015-02-10T00:45:40\",\n            \"modified\": \"2015-02-10T00:50:28\"\n        }\n    ]\n}","name":""},{"status":400,"language":"json","code":"","name":""}]},"settings":"","url":"/apps/api/events"},"body":"This endpoint will list any events which you are authorized to view. You will see information about each event including:\n\n* The event's id\n\n* The group which the event belongs to and its contact information as available\n\n* The name of each event\n\n* Premium status\n\n* Created and modified dates (using GMT)\n\n* Time zone of the event\n\n* The starting (`startsat`) and ending (`endsat`) times of the event in the event's timezone.\n\nTimezone codes are as follows:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"id\",\n    \"h-1\": \"Timezone\",\n    \"0-0\": \"1\",\n    \"1-0\": \"2\",\n    \"2-0\": \"3\",\n    \"3-0\": \"4\",\n    \"4-0\": \"5\",\n    \"5-0\": \"6\",\n    \"6-0\": \"7\",\n    \"7-0\": \"8\",\n    \"8-0\": \"9\",\n    \"9-0\": \"10\",\n    \"10-0\": \"11\",\n    \"11-0\": \"12\",\n    \"12-0\": \"13\",\n    \"13-0\": \"14\",\n    \"14-0\": \"15\",\n    \"15-0\": \"16\",\n    \"16-0\": \"17\",\n    \"17-0\": \"18\",\n    \"18-0\": \"19\",\n    \"19-0\": \"20\",\n    \"20-0\": \"21\",\n    \"21-0\": \"22\",\n    \"22-0\": \"23\",\n    \"23-0\": \"24\",\n    \"24-0\": \"25\",\n    \"25-0\": \"26\",\n    \"26-0\": \"27\",\n    \"27-0\": \"28\",\n    \"28-0\": \"29\",\n    \"29-0\": \"30\",\n    \"30-0\": \"31\",\n    \"31-0\": \"32\",\n    \"32-0\": \"33\",\n    \"33-0\": \"34\",\n    \"34-0\": \"35\",\n    \"35-0\": \"36\",\n    \"0-1\": \"Pacific/Kwajalein\",\n    \"1-1\": \"Pacific/Midway\",\n    \"2-1\": \"US/Hawaii\",\n    \"3-1\": \"US/Alaska\",\n    \"4-1\": \"US/Pacific\",\n    \"5-1\": \"US/Mountain\",\n    \"6-1\": \"US/Central\",\n    \"7-1\": \"US/Eastern\",\n    \"8-1\": \"Atlantic/Bermuda\",\n    \"9-1\": \"America/Argentina/Buenos_Aires\",\n    \"10-1\": \"Atlantic/South_Georgia\",\n    \"11-1\": \"Atlantic/Azores\",\n    \"12-1\": \"GMT\",\n    \"13-1\": \"Europe/London\",\n    \"14-1\": \"Europe/Amsterdam\",\n    \"15-1\": \"Europe/Belgrade\",\n    \"16-1\": \"Europe/Brussels\",\n    \"17-1\": \"Europe/Sarajevo\",\n    \"18-1\": \"Asia/Istanbul\",\n    \"19-1\": \"Europe/Moscow\",\n    \"20-1\": \"Asia/Tehran\",\n    \"21-1\": \"Asia/Baku\",\n    \"22-1\": \"Asia/Kabul\",\n    \"23-1\": \"Asia/Karachi'\",\n    \"24-1\": \"Asia/Calcutta\",\n    \"25-1\": \"Asia/Kathmandu\",\n    \"26-1\": \"Asia/Almaty\",\n    \"27-1\": \"Asia/Rangoon\",\n    \"28-1\": \"Asia/Bangkok\",\n    \"29-1\": \"Asia/Singapore\",\n    \"30-1\": \"Asia/Tokyo\",\n    \"31-1\": \"Australia/Adelaide\",\n    \"32-1\": \"Australia/Brisbane\",\n    \"33-1\": \"Australia/Canberra\",\n    \"34-1\": \"Asia/Magadan\",\n    \"35-1\": \"Pacific/Fiji\"\n  },\n  \"cols\": 2,\n  \"rows\": 36\n}\n[/block]\nWith an event id retrieved from this call, you can perform other calls to viewing the [event's detail](https://boomset-public-api.readme.io/docs/event-detail), [questions](https://boomset-public-api.readme.io/docs/listing-event-questions), and [attendees](https://boomset-public-api.readme.io/docs/listing-attendees), as well as [create](https://boomset-public-api.readme.io/docs/creating-a-registration-type) and [edit](https://boomset-public-api.readme.io/docs/editing-a-registration-type) registration types.","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-02-05T02:49:15.620Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"project":"54d2cbfc2ce0e00d007515e9","slug":"listing-events","sync_unique":"","title":"Listing Events","type":"get","updates":[],"user":"54d2cb905616470d0013cc1f","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getListing Events


This endpoint will list any events which you are authorized to view. You will see information about each event including: * The event's id * The group which the event belongs to and its contact information as available * The name of each event * Premium status * Created and modified dates (using GMT) * Time zone of the event * The starting (`startsat`) and ending (`endsat`) times of the event in the event's timezone. Timezone codes are as follows: [block:parameters] { "data": { "h-0": "id", "h-1": "Timezone", "0-0": "1", "1-0": "2", "2-0": "3", "3-0": "4", "4-0": "5", "5-0": "6", "6-0": "7", "7-0": "8", "8-0": "9", "9-0": "10", "10-0": "11", "11-0": "12", "12-0": "13", "13-0": "14", "14-0": "15", "15-0": "16", "16-0": "17", "17-0": "18", "18-0": "19", "19-0": "20", "20-0": "21", "21-0": "22", "22-0": "23", "23-0": "24", "24-0": "25", "25-0": "26", "26-0": "27", "27-0": "28", "28-0": "29", "29-0": "30", "30-0": "31", "31-0": "32", "32-0": "33", "33-0": "34", "34-0": "35", "35-0": "36", "0-1": "Pacific/Kwajalein", "1-1": "Pacific/Midway", "2-1": "US/Hawaii", "3-1": "US/Alaska", "4-1": "US/Pacific", "5-1": "US/Mountain", "6-1": "US/Central", "7-1": "US/Eastern", "8-1": "Atlantic/Bermuda", "9-1": "America/Argentina/Buenos_Aires", "10-1": "Atlantic/South_Georgia", "11-1": "Atlantic/Azores", "12-1": "GMT", "13-1": "Europe/London", "14-1": "Europe/Amsterdam", "15-1": "Europe/Belgrade", "16-1": "Europe/Brussels", "17-1": "Europe/Sarajevo", "18-1": "Asia/Istanbul", "19-1": "Europe/Moscow", "20-1": "Asia/Tehran", "21-1": "Asia/Baku", "22-1": "Asia/Kabul", "23-1": "Asia/Karachi'", "24-1": "Asia/Calcutta", "25-1": "Asia/Kathmandu", "26-1": "Asia/Almaty", "27-1": "Asia/Rangoon", "28-1": "Asia/Bangkok", "29-1": "Asia/Singapore", "30-1": "Asia/Tokyo", "31-1": "Australia/Adelaide", "32-1": "Australia/Brisbane", "33-1": "Australia/Canberra", "34-1": "Asia/Magadan", "35-1": "Pacific/Fiji" }, "cols": 2, "rows": 36 } [/block] With an event id retrieved from this call, you can perform other calls to viewing the [event's detail](https://boomset-public-api.readme.io/docs/event-detail), [questions](https://boomset-public-api.readme.io/docs/listing-event-questions), and [attendees](https://boomset-public-api.readme.io/docs/listing-attendees), as well as [create](https://boomset-public-api.readme.io/docs/creating-a-registration-type) and [edit](https://boomset-public-api.readme.io/docs/editing-a-registration-type) registration types.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



This endpoint will list any events which you are authorized to view. You will see information about each event including: * The event's id * The group which the event belongs to and its contact information as available * The name of each event * Premium status * Created and modified dates (using GMT) * Time zone of the event * The starting (`startsat`) and ending (`endsat`) times of the event in the event's timezone. Timezone codes are as follows: [block:parameters] { "data": { "h-0": "id", "h-1": "Timezone", "0-0": "1", "1-0": "2", "2-0": "3", "3-0": "4", "4-0": "5", "5-0": "6", "6-0": "7", "7-0": "8", "8-0": "9", "9-0": "10", "10-0": "11", "11-0": "12", "12-0": "13", "13-0": "14", "14-0": "15", "15-0": "16", "16-0": "17", "17-0": "18", "18-0": "19", "19-0": "20", "20-0": "21", "21-0": "22", "22-0": "23", "23-0": "24", "24-0": "25", "25-0": "26", "26-0": "27", "27-0": "28", "28-0": "29", "29-0": "30", "30-0": "31", "31-0": "32", "32-0": "33", "33-0": "34", "34-0": "35", "35-0": "36", "0-1": "Pacific/Kwajalein", "1-1": "Pacific/Midway", "2-1": "US/Hawaii", "3-1": "US/Alaska", "4-1": "US/Pacific", "5-1": "US/Mountain", "6-1": "US/Central", "7-1": "US/Eastern", "8-1": "Atlantic/Bermuda", "9-1": "America/Argentina/Buenos_Aires", "10-1": "Atlantic/South_Georgia", "11-1": "Atlantic/Azores", "12-1": "GMT", "13-1": "Europe/London", "14-1": "Europe/Amsterdam", "15-1": "Europe/Belgrade", "16-1": "Europe/Brussels", "17-1": "Europe/Sarajevo", "18-1": "Asia/Istanbul", "19-1": "Europe/Moscow", "20-1": "Asia/Tehran", "21-1": "Asia/Baku", "22-1": "Asia/Kabul", "23-1": "Asia/Karachi'", "24-1": "Asia/Calcutta", "25-1": "Asia/Kathmandu", "26-1": "Asia/Almaty", "27-1": "Asia/Rangoon", "28-1": "Asia/Bangkok", "29-1": "Asia/Singapore", "30-1": "Asia/Tokyo", "31-1": "Australia/Adelaide", "32-1": "Australia/Brisbane", "33-1": "Australia/Canberra", "34-1": "Asia/Magadan", "35-1": "Pacific/Fiji" }, "cols": 2, "rows": 36 } [/block] With an event id retrieved from this call, you can perform other calls to viewing the [event's detail](https://boomset-public-api.readme.io/docs/event-detail), [questions](https://boomset-public-api.readme.io/docs/listing-event-questions), and [attendees](https://boomset-public-api.readme.io/docs/listing-attendees), as well as [create](https://boomset-public-api.readme.io/docs/creating-a-registration-type) and [edit](https://boomset-public-api.readme.io/docs/editing-a-registration-type) registration types.
{"__v":2,"_id":"54d2da845616470d0013cc30","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"54d2da845616470d0013cc31","default":"","desc":"Event ID","in":"path","name":"event_id","ref":"","required":true,"type":"int"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": 24172,\n    \"group\": {\n        \"id\": 11435,\n        \"name\": \"Developers\",\n        \"email\": null,\n        \"phone\": \"1-860-266-6738\",\n        \"website\": null,\n        \"fbpage\": null,\n        \"twitter\": null,\n        \"googleplus\": null\n    },\n    \"restypes\": [\n        {\n            \"pricing\": \"Ticket\",\n            \"source\": \"Boomset\",\n            \"price\": \"0.00\",\n            \"name\": \"General Admission\",\n            \"description\": \"\"\n        },\n        {\n            \"pricing\": \"Ticket\",\n            \"source\": \"Boomset\",\n            \"price\": \"0.00\",\n            \"name\": \"VIP\",\n            \"description\": \"\"\n        }\n    ],\n    \"name\": \"Boomset Demo\",\n    \"startsat\": \"2015-01-01T19:00:00\",\n    \"endsat\": \"2017-12-31T23:00:00\",\n    \"timezone\": 8,\n    \"premium\": false,\n    \"created\": \"2015-02-10T00:45:40\",\n    \"modified\": \"2015-02-10T00:50:28\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/apps/api/events/:event_id"},"body":"This endpoint will list the details of one specific [event](https://boomset-public-api.readme.io/docs/listing-events). Such details include:\n\n* The group to which the event belongs and its contact information as available\n\n* Reservation types for the event\n\n* The name of the event\n\n* Premium status\n\n* Created and modified dates (using GMT)\n\n* Time zone of the event (see [here](https://boomset-public-api.readme.io/docs/listing-events) for timezone codes)\n\n* The starting (`startsat`) and ending (`endsat`) times of the event in the event's timezone.","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-02-05T02:50:44.040Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"project":"54d2cbfc2ce0e00d007515e9","slug":"event-detail","sync_unique":"","title":"Event Detail","type":"get","updates":[],"user":"54d2cb905616470d0013cc1f","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getEvent Detail


event_id:
required
integer
Event ID
This endpoint will list the details of one specific [event](https://boomset-public-api.readme.io/docs/listing-events). Such details include: * The group to which the event belongs and its contact information as available * Reservation types for the event * The name of the event * Premium status * Created and modified dates (using GMT) * Time zone of the event (see [here](https://boomset-public-api.readme.io/docs/listing-events) for timezone codes) * The starting (`startsat`) and ending (`endsat`) times of the event in the event's timezone.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



This endpoint will list the details of one specific [event](https://boomset-public-api.readme.io/docs/listing-events). Such details include: * The group to which the event belongs and its contact information as available * Reservation types for the event * The name of the event * Premium status * Created and modified dates (using GMT) * Time zone of the event (see [here](https://boomset-public-api.readme.io/docs/listing-events) for timezone codes) * The starting (`startsat`) and ending (`endsat`) times of the event in the event's timezone.
{"__v":2,"_id":"54d2dad45616470d0013cc32","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"54d2dad45616470d0013cc33","default":"","desc":"Event ID","in":"path","name":"event_id","ref":"","required":true,"type":"int"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"count\": 4,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 1036757,\n            \"question\": \"What do you prefer for lunch?\",\n            \"type\": \"8\",\n            \"options\": [],\n            \"created\": \"2015-02-10T00:51:02\",\n            \"modified\": \"2015-02-10T00:51:02\"\n        },\n        {\n            \"id\": 1036759,\n            \"question\": \"What is your favorite means of travel?\",\n            \"type\": \"2\",\n            \"options\": [\n                {\n                    \"answer\": \"Walking\",\n                    \"id\": 75546\n                },\n                {\n                    \"answer\": \"Car\",\n                    \"id\": 75547\n                },\n                {\n                    \"answer\": \"Boat\",\n                    \"id\": 75548\n                },\n                {\n                    \"answer\": \"Plane\",\n                    \"id\": 75549\n                },\n                {\n                    \"answer\": \"Motorcycle\",\n                    \"id\": 75550\n                }\n            ],\n            \"created\": \"2015-02-10T00:55:38\",\n            \"modified\": \"2015-02-10T00:55:38\"\n        },\n        {\n            \"id\": 1036760,\n            \"question\": \"Where are you from?\",\n            \"type\": \"8\",\n            \"options\": [],\n            \"created\": \"2015-02-10T01:11:26\",\n            \"modified\": \"2015-02-10T01:11:26\"\n        },\n        {\n            \"id\": 1036761,\n            \"question\": \"What is your passion?\",\n            \"type\": \"8\",\n            \"options\": [],\n            \"created\": \"2015-02-10T01:11:59\",\n            \"modified\": \"2015-02-10T01:11:59\"\n        }\n    ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"https://www.boomset.com/apps/api/events/:event_id/questions"},"body":"This endpoint will list details about every question of one specific [event](https://boomset-public-api.readme.io/docs/listing-events). Such details include:\n\n* Question ID\n\n* Question type\n\n* Options for answer choices (blank if question type is a text field)\n\n* Created and modified dates (using GMT)\n\nBoomset question types are as follows:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"1\",\n    \"1-0\": \"2\",\n    \"2-0\": \"3\",\n    \"4-0\": \"5\",\n    \"5-0\": \"6\",\n    \"6-0\": \"7\",\n    \"7-0\": \"8\",\n    \"8-0\": \"9\",\n    \"9-0\": \"10\",\n    \"10-0\": \"11\",\n    \"11-0\": \"12\",\n    \"12-0\": \"13\",\n    \"13-0\": \"14\",\n    \"14-0\": \"15\",\n    \"15-0\": \"16\",\n    \"16-0\": \"17\",\n    \"0-1\": \"Text\",\n    \"1-1\": \"Dropdown\",\n    \"2-1\": \"Radio\",\n    \"4-1\": \"Password\",\n    \"5-1\": \"Date\",\n    \"6-1\": \"Multiple Selections\",\n    \"7-1\": \"Text Area\",\n    \"8-1\": \"Address State\",\n    \"9-1\": \"Address Country\",\n    \"10-1\": \"Address Zip\",\n    \"11-1\": \"Address City\",\n    \"12-1\": \"Address Line 1\",\n    \"13-1\": \"Address Line 2\",\n    \"14-1\": \"Email\",\n    \"15-1\": \"URL\",\n    \"16-1\": \"Gender\",\n    \"3-0\": \"4\",\n    \"3-1\": \"Checkbox\"\n  },\n  \"cols\": 2,\n  \"rows\": 17\n}\n[/block]","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-02-05T02:52:04.719Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"project":"54d2cbfc2ce0e00d007515e9","slug":"listing-event-questions","sync_unique":"","title":"Listing Event Questions","type":"get","updates":[],"user":"54d2cb905616470d0013cc1f","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getListing Event Questions


event_id:
required
integer
Event ID
This endpoint will list details about every question of one specific [event](https://boomset-public-api.readme.io/docs/listing-events). Such details include: * Question ID * Question type * Options for answer choices (blank if question type is a text field) * Created and modified dates (using GMT) Boomset question types are as follows: [block:parameters] { "data": { "0-0": "1", "1-0": "2", "2-0": "3", "4-0": "5", "5-0": "6", "6-0": "7", "7-0": "8", "8-0": "9", "9-0": "10", "10-0": "11", "11-0": "12", "12-0": "13", "13-0": "14", "14-0": "15", "15-0": "16", "16-0": "17", "0-1": "Text", "1-1": "Dropdown", "2-1": "Radio", "4-1": "Password", "5-1": "Date", "6-1": "Multiple Selections", "7-1": "Text Area", "8-1": "Address State", "9-1": "Address Country", "10-1": "Address Zip", "11-1": "Address City", "12-1": "Address Line 1", "13-1": "Address Line 2", "14-1": "Email", "15-1": "URL", "16-1": "Gender", "3-0": "4", "3-1": "Checkbox" }, "cols": 2, "rows": 17 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



This endpoint will list details about every question of one specific [event](https://boomset-public-api.readme.io/docs/listing-events). Such details include: * Question ID * Question type * Options for answer choices (blank if question type is a text field) * Created and modified dates (using GMT) Boomset question types are as follows: [block:parameters] { "data": { "0-0": "1", "1-0": "2", "2-0": "3", "4-0": "5", "5-0": "6", "6-0": "7", "7-0": "8", "8-0": "9", "9-0": "10", "10-0": "11", "11-0": "12", "12-0": "13", "13-0": "14", "14-0": "15", "15-0": "16", "16-0": "17", "0-1": "Text", "1-1": "Dropdown", "2-1": "Radio", "4-1": "Password", "5-1": "Date", "6-1": "Multiple Selections", "7-1": "Text Area", "8-1": "Address State", "9-1": "Address Country", "10-1": "Address Zip", "11-1": "Address City", "12-1": "Address Line 1", "13-1": "Address Line 2", "14-1": "Email", "15-1": "URL", "16-1": "Gender", "3-0": "4", "3-1": "Checkbox" }, "cols": 2, "rows": 17 } [/block]
{"__v":3,"_id":"54d2daefdbd2730d0040747c","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"54d2dad45616470d0013cc33","default":"","desc":"Event ID","in":"path","name":"event_id","ref":"","required":true,"type":"int"},{"_id":"55ad63bdf302af23000abf25","default":"","desc":"Page number","in":"path","name":"page","ref":"","required":false,"type":"int"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"count\": 16,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 7177343,\n            \"contact\": {\n                \"prefix\": \"Mr.\",\n                \"first_name\": \"Cem\",\n                \"last_name\": \"Kozinoglu\",\n                \"suffix\": null,\n                \"phone\": null,\n                \"cellphone\": null,\n                \"email\": \"boomset@boomset.com\"\n            },\n            \"work_info\": {\n                \"website\": \"www.boomset.com\",\n                \"fax\": \"+1 (860) 266-6738\",\n                \"title\": \"Co-Founder and CEO\",\n                \"company\": \"Boomset\",\n                \"blog\": null,\n                \"phone\": null\n            },\n            \"answers\": [\n                {\n                    \"answer\": \"Plane\",\n                    \"option_id\": 75549,\n                    \"question\": \"What is your favorite means of travel?\",\n                    \"question_id\": 1036759\n                },\n                {\n                    \"answer\": \"Turkey\",\n                    \"question\": \"Where are you from?\",\n                    \"question_id\": 1036760\n                },\n                {\n                    \"answer\": \"Creating\",\n                    \"question\": \"What is your passion?\",\n                    \"question_id\": 1036761\n                },\n                {\n                    \"answer\": \"Variety\",\n                    \"question\": \"What do you prefer for lunch?\",\n                    \"question_id\": 1036757\n                }\n            ],\n            \"checkin_info\": [\n                {\n                    \"timestamp\": \"2015-02-10T01:15:18\",\n                    \"source\": \"Admin Panel\",\n                    \"quantity\": 1\n                }\n            ],\n            \"transaction\": {\n                \"restype\": {\n                    \"id\": 107172,\n                    \"name\": \"VIP\",\n                    \"description\": \"\"\n                },\n                \"amount\": \"0.00\",\n                \"fee\": \"0.00\",\n                \"total\": \"0.00\"\n            },\n            \"quantity\": 1,\n            \"total\": \"0.00\",\n            \"paid\": 10,\n            \"created\": \"2015-02-10T01:03:07\",\n            \"modified\": \"2015-02-10T01:21:57\"\n        },\n        {\n            \"id\": 7177344,\n            \"contact\": {\n                \"prefix\": null,\n                \"first_name\": \"Kerem\",\n                \"last_name\": \"Baran\",\n                \"suffix\": null,\n                \"phone\": null,\n                \"cellphone\": null,\n                \"email\": null\n            },\n            \"work_info\": {\n                \"website\": \"www.boomset.com\",\n                \"fax\": \"+1 (860) 266-6738\",\n                \"title\": \"Co-founder, COO, and iOS Developer\",\n                \"company\": \"Boomset\",\n                \"blog\": null,\n                \"phone\": null\n            },\n            \"answers\": [\n                {\n                    \"answer\": \"\",\n                    \"question\": \"What do you prefer for lunch?\",\n                    \"question_id\": 1036757\n                },\n                {\n                    \"answer\": \"\",\n                    \"question\": \"What is your favorite means of travel?\",\n                    \"question_id\": 1036759\n                },\n                {\n                    \"answer\": \"\",\n                    \"question\": \"Where are you from?\",\n                    \"question_id\": 1036760\n                },\n                {\n                    \"answer\": \"\",\n                    \"question\": \"What is your passion?\",\n                    \"question_id\": 1036761\n                }\n            ],\n            \"checkin_info\": [\n                {\n                    \"timestamp\": \"2015-02-10T01:21:45\",\n                    \"source\": \"Admin Panel\",\n                    \"quantity\": 1\n                }\n            ],\n            \"transaction\": {\n                \"restype\": {\n                    \"id\": 107172,\n                    \"name\": \"VIP\",\n                    \"description\": \"\"\n                },\n                \"amount\": \"0.00\",\n                \"fee\": \"0.00\",\n                \"total\": \"0.00\"\n            },\n            \"quantity\": 1,\n            \"total\": \"0.00\",\n            \"paid\": 10,\n            \"created\": \"2015-02-10T01:03:28\",\n            \"modified\": \"2015-02-10T01:21:45\"\n        },\n        {\n            \"id\": 7177345,\n            \"contact\": {\n                \"prefix\": null,\n                \"first_name\": \"Rachael\",\n                \"last_name\": \"Livingston\",\n                \"suffix\": null,\n                \"phone\": null,\n                \"cellphone\": null,\n                \"email\": null\n            },\n            \"work_info\": {\n                \"website\": \"\",\n                \"fax\": \"\",\n                \"title\": \"\",\n                \"company\": \"\",\n                \"blog\": \"\",\n                \"phone\": \"\"\n            },\n            \"answers\": [\n                {\n                    \"answer\": \"\",\n                    \"question\": \"What do you prefer for lunch?\",\n                    \"question_id\": 1036757\n                },\n                {\n                    \"answer\": \"\",\n                    \"question\": \"What is your favorite means of travel?\",\n                    \"question_id\": 1036759\n                },\n                {\n                    \"answer\": \"\",\n                    \"question\": \"Where are you from?\",\n                    \"question_id\": 1036760\n                },\n                {\n                    \"answer\": \"\",\n                    \"question\": \"What is your passion?\",\n                    \"question_id\": 1036761\n                }\n            ],\n            \"checkin_info\": [\n                {\n                    \"timestamp\": \"2015-02-10T01:29:51\",\n                    \"source\": \"Admin Panel\",\n                    \"quantity\": 1\n                }\n            ],\n            \"transaction\": {\n                \"restype\": {\n                    \"id\": 107172,\n                    \"name\": \"VIP\",\n                    \"description\": \"\"\n                },\n                \"amount\": \"0.00\",\n                \"fee\": \"0.00\",\n                \"total\": \"0.00\"\n            },\n            \"quantity\": 1,\n            \"total\": \"0.00\",\n            \"paid\": 10,\n            \"created\": \"2015-02-10T01:03:38\",\n            \"modified\": \"2015-02-10T01:29:51\"\n        }\n    ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/apps/api/events/:event_id/attendees:page"},"body":"This endpoint will list the attendees of one specific [event](https://boomset-public-api.readme.io/docs/listing-events).\n\nAttendees are returned in batches of 50, and it is possible to navigate using the \"next\" and \"previous\" links returned in the JSON data, or otherwise providing the page number in the URL.\n\nThis endpoint returns information about each attendee including:\n\n* Name\n\n* id\n\n* Contact Information\n\n* Work information\n\n* Answers to questions\n\n* Check in times and quantities\n\n* Their reservation type\n\n* Quantity\n\n* Ticket cost/payment status\n\n* Created/modified (using GMT)\n\nWith an attendee's id, you can [view](https://boomset-public-api.readme.io/docs/attendee-detail) and [update](https://boomset-public-api.readme.io/docs/updating-an-attendee) their contact details, as well as [check the attendee in or out](https://boomset-public-api.readme.io/docs/checking-an-attendee-in). A separate call is available for updating an attendee's [questions](https://boomset-public-api.readme.io/docs/updating-an-attendees-questions)","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-02-05T02:52:31.017Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"project":"54d2cbfc2ce0e00d007515e9","slug":"listing-attendees","sync_unique":"","title":"Listing Attendees","type":"get","updates":[],"user":"54d2cb905616470d0013cc1f","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getListing Attendees


event_id:
required
integer
Event ID
page:
integer
Page number
This endpoint will list the attendees of one specific [event](https://boomset-public-api.readme.io/docs/listing-events). Attendees are returned in batches of 50, and it is possible to navigate using the "next" and "previous" links returned in the JSON data, or otherwise providing the page number in the URL. This endpoint returns information about each attendee including: * Name * id * Contact Information * Work information * Answers to questions * Check in times and quantities * Their reservation type * Quantity * Ticket cost/payment status * Created/modified (using GMT) With an attendee's id, you can [view](https://boomset-public-api.readme.io/docs/attendee-detail) and [update](https://boomset-public-api.readme.io/docs/updating-an-attendee) their contact details, as well as [check the attendee in or out](https://boomset-public-api.readme.io/docs/checking-an-attendee-in). A separate call is available for updating an attendee's [questions](https://boomset-public-api.readme.io/docs/updating-an-attendees-questions)

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



This endpoint will list the attendees of one specific [event](https://boomset-public-api.readme.io/docs/listing-events). Attendees are returned in batches of 50, and it is possible to navigate using the "next" and "previous" links returned in the JSON data, or otherwise providing the page number in the URL. This endpoint returns information about each attendee including: * Name * id * Contact Information * Work information * Answers to questions * Check in times and quantities * Their reservation type * Quantity * Ticket cost/payment status * Created/modified (using GMT) With an attendee's id, you can [view](https://boomset-public-api.readme.io/docs/attendee-detail) and [update](https://boomset-public-api.readme.io/docs/updating-an-attendee) their contact details, as well as [check the attendee in or out](https://boomset-public-api.readme.io/docs/checking-an-attendee-in). A separate call is available for updating an attendee's [questions](https://boomset-public-api.readme.io/docs/updating-an-attendees-questions)
{"__v":2,"_id":"54d2db2769578e0d002730ad","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"54d2dad45616470d0013cc33","default":"","desc":"Attendee ID","in":"path","name":"attendee_id","ref":"","required":true,"type":"int"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": 7177343,\n    \"contact\": {\n        \"prefix\": \"Mr.\",\n        \"first_name\": \"Cem\",\n        \"last_name\": \"Kozinoglu\",\n        \"suffix\": null,\n        \"phone\": null,\n        \"cellphone\": null,\n        \"email\": \"boomset@boomset.com\"\n    },\n    \"work_info\": {\n        \"website\": \"www.boomset.com\",\n        \"fax\": \"+1 (860) 266-6738\",\n        \"title\": \"Co-Founder and CEO\",\n        \"company\": \"Boomset\",\n        \"blog\": null,\n        \"phone\": null\n    },\n    \"answers\": [\n        {\n            \"answer\": \"Plane\",\n            \"option_id\": 75549,\n            \"question\": \"What is your favorite means of travel?\",\n            \"question_id\": 1036759\n        },\n        {\n            \"answer\": \"Turkey\",\n            \"question\": \"Where are you from?\",\n            \"question_id\": 1036760\n        },\n        {\n            \"answer\": \"Creating\",\n            \"question\": \"What is your passion?\",\n            \"question_id\": 1036761\n        },\n        {\n            \"answer\": \"Variety\",\n            \"question\": \"What do you prefer for lunch?\",\n            \"question_id\": 1036757\n        }\n    ],\n    \"checkin_info\": [\n        {\n            \"timestamp\": \"2015-02-10T01:15:18\",\n            \"source\": \"Admin Panel\",\n            \"quantity\": 1\n        }\n    ],\n    \"transaction\": {\n        \"restype\": {\n            \"id\": 107172,\n            \"name\": \"VIP\",\n            \"description\": \"\"\n        },\n        \"amount\": \"0.00\",\n        \"fee\": \"0.00\",\n        \"total\": \"0.00\"\n    },\n    \"quantity\": 1,\n    \"total\": \"0.00\",\n    \"paid\": 10,\n    \"created\": \"2015-02-10T01:03:07\",\n    \"modified\": \"2015-02-10T01:21:57\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/apps/api/attendees/:attendee_id"},"body":"This endpoint returns details about an [attendee](https://boomset-public-api.readme.io/docs/listing-attendees), including:\n\n* Contact information\n\n* Work information\n\n* Quantity of checkins\n\n* Payment status\n\n* Dates created, modified, and last checked in\n\n* Questions answered and their answers","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-02-05T02:53:27.059Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"project":"54d2cbfc2ce0e00d007515e9","slug":"attendee-detail","sync_unique":"","title":"Attendee Detail","type":"get","updates":[],"user":"54d2cb905616470d0013cc1f","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getAttendee Detail


attendee_id:
required
integer
Attendee ID
This endpoint returns details about an [attendee](https://boomset-public-api.readme.io/docs/listing-attendees), including: * Contact information * Work information * Quantity of checkins * Payment status * Dates created, modified, and last checked in * Questions answered and their answers

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



This endpoint returns details about an [attendee](https://boomset-public-api.readme.io/docs/listing-attendees), including: * Contact information * Work information * Quantity of checkins * Payment status * Dates created, modified, and last checked in * Questions answered and their answers
{"__v":3,"_id":"54d2db3a69578e0d002730ae","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"54d2dad45616470d0013cc33","default":"","desc":"Attendee ID","in":"path","name":"attendee_id","ref":"","required":true,"type":"int"},{"_id":"54d2e0072ce0e00d0075161b","default":"","desc":"First Name","in":"body","name":"first_name","ref":"","required":false,"type":"string"},{"_id":"54d2e0072ce0e00d0075161a","default":"","desc":"Last Name","in":"body","name":"last_name","ref":"","required":false,"type":"string"},{"_id":"54d2e0072ce0e00d00751619","default":"","desc":"E-mail","in":"body","name":"email","ref":"","required":false,"type":"string"},{"_id":"54d2e0072ce0e00d00751618","default":"","desc":"Phone","in":"body","name":"phone","ref":"","required":false,"type":"string"},{"_id":"54d2e0072ce0e00d00751617","default":"","desc":"Cell Phone","in":"body","name":"cellphone","ref":"","required":false,"type":"string"},{"_id":"54d2e0072ce0e00d00751616","default":"","desc":"Company","in":"body","name":"company","ref":"","required":false,"type":"string"},{"_id":"54d2e0072ce0e00d00751615","default":"","desc":"Title","in":"body","name":"title","ref":"","required":false,"type":"string"},{"_id":"54d2e0072ce0e00d00751614","default":"","desc":"Fax","in":"body","name":"fax","ref":"","required":false,"type":"string"},{"_id":"54d2e0072ce0e00d00751613","default":"","desc":"Work Phone","in":"body","name":"workphone","ref":"","required":false,"type":"string"},{"_id":"54d2e0072ce0e00d00751612","default":"","desc":"Website","in":"body","name":"website","ref":"","required":false,"type":"string"},{"_id":"54d2e0072ce0e00d00751611","default":"","desc":"Blog","in":"body","name":"blog","ref":"","required":false,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": 7177343,\n    \"contact\": {\n        \"prefix\": \"Mr.\",\n        \"first_name\": \"Cem\",\n        \"last_name\": \"Kozinoglu\",\n        \"suffix\": null,\n        \"phone\": null,\n        \"cellphone\": null,\n        \"email\": \"boomset@boomset.com\"\n    },\n    \"work_info\": {\n        \"website\": \"www.boomset.com\",\n        \"fax\": \"+1 (860) 266-6738\",\n        \"title\": \"Co-Founder and CEO\",\n        \"company\": \"Boomset\",\n        \"blog\": null,\n        \"phone\": \"1-860-266-6738\"\n    },\n    \"answers\": [\n        {\n            \"answer\": \"Plane\",\n            \"option_id\": 75549,\n            \"question\": \"What is your favorite means of travel?\",\n            \"question_id\": 1036759\n        },\n        {\n            \"answer\": \"Turkey\",\n            \"question\": \"Where are you from?\",\n            \"question_id\": 1036760\n        },\n        {\n            \"answer\": \"Creating\",\n            \"question\": \"What is your passion?\",\n            \"question_id\": 1036761\n        },\n        {\n            \"answer\": \"Variety\",\n            \"question\": \"What do you prefer for lunch?\",\n            \"question_id\": 1036757\n        }\n    ],\n    \"checkin_info\": [\n        {\n            \"timestamp\": \"2015-02-10T01:15:18\",\n            \"source\": \"Admin Panel\",\n            \"quantity\": 1\n        }\n    ],\n    \"transaction\": {\n        \"restype\": {\n            \"id\": 107172,\n            \"name\": \"VIP\",\n            \"description\": \"\"\n        },\n        \"amount\": \"0.00\",\n        \"fee\": \"0.00\",\n        \"total\": \"0.00\"\n    },\n    \"quantity\": 1,\n    \"total\": \"0.00\",\n    \"paid\": 10,\n    \"created\": \"2015-02-10T01:03:07\",\n    \"modified\": \"2015-02-10T01:44:10.194\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/apps/api/attendees/:attendee_id/update"},"body":"This endpoint allows you to update an [attendee's](https://boomset-public-api.readme.io/docs/listing-attendees) basic information. Everything except the attendee_id is optional.\n\nResponses to an attendee's questions can be edited with this endpoint: [https://boomset-public-api.readme.io/docs/updating-an-attendees-questions](https://boomset-public-api.readme.io/docs/updating-an-attendees-questions)","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-02-05T02:53:46.681Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":8,"project":"54d2cbfc2ce0e00d007515e9","slug":"updating-an-attendee","sync_unique":"","title":"Updating an Attendee","type":"post","updates":[],"user":"54d2cb905616470d0013cc1f","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postUpdating an Attendee


attendee_id:
required
integer
Attendee ID
first_name:
string
First Name
last_name:
string
Last Name
email:
string
E-mail
phone:
string
Phone
cellphone:
string
Cell Phone
company:
string
Company
title:
string
Title
fax:
string
Fax
workphone:
string
Work Phone
website:
string
Website
blog:
string
Blog
This endpoint allows you to update an [attendee's](https://boomset-public-api.readme.io/docs/listing-attendees) basic information. Everything except the attendee_id is optional. Responses to an attendee's questions can be edited with this endpoint: [https://boomset-public-api.readme.io/docs/updating-an-attendees-questions](https://boomset-public-api.readme.io/docs/updating-an-attendees-questions)

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



This endpoint allows you to update an [attendee's](https://boomset-public-api.readme.io/docs/listing-attendees) basic information. Everything except the attendee_id is optional. Responses to an attendee's questions can be edited with this endpoint: [https://boomset-public-api.readme.io/docs/updating-an-attendees-questions](https://boomset-public-api.readme.io/docs/updating-an-attendees-questions)
{"__v":3,"_id":"54d2db4f2ce0e00d00751601","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"54d2dad45616470d0013cc33","default":"","desc":"Attendee ID","in":"path","name":"attendee_id","ref":"","required":true,"type":"int"},{"_id":"54d2e03b2ce0e00d0075161c","default":"","desc":"Quantity","in":"body","name":"quantity","ref":"","required":true,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": 7177343,\n    \"contact\": {\n        \"prefix\": \"Mr.\",\n        \"first_name\": \"Cem\",\n        \"last_name\": \"Kozinoglu\",\n        \"suffix\": null,\n        \"phone\": null,\n        \"cellphone\": null,\n        \"email\": \"boomset@boomset.com\"\n    },\n    \"work_info\": {\n        \"website\": \"www.boomset.com\",\n        \"fax\": \"+1 (860) 266-6738\",\n        \"title\": \"Co-Founder and CEO\",\n        \"company\": \"Boomset\",\n        \"blog\": null,\n        \"phone\": \"1-860-266-6738\"\n    },\n    \"answers\": [\n        {\n            \"answer\": \"Plane\",\n            \"option_id\": 75549,\n            \"question\": \"What is your favorite means of travel?\",\n            \"question_id\": 1036759\n        },\n        {\n            \"answer\": \"Turkey\",\n            \"question\": \"Where are you from?\",\n            \"question_id\": 1036760\n        },\n        {\n            \"answer\": \"Creating\",\n            \"question\": \"What is your passion?\",\n            \"question_id\": 1036761\n        },\n        {\n            \"answer\": \"Variety\",\n            \"question\": \"What do you prefer for lunch?\",\n            \"question_id\": 1036757\n        }\n    ],\n    \"checkin_info\": [\n        {\n            \"timestamp\": \"2015-02-10T01:15:18\",\n            \"source\": \"Admin Panel\",\n            \"quantity\": 1\n        },\n        {\n            \"timestamp\": \"2015-02-10T01:51:02\",\n            \"source\": \"Boomset API\",\n            \"quantity\": 6\n        }\n    ],\n    \"transaction\": {\n        \"restype\": {\n            \"id\": 107172,\n            \"name\": \"VIP\",\n            \"description\": \"\"\n        },\n        \"amount\": \"0.00\",\n        \"fee\": \"0.00\",\n        \"total\": \"0.00\"\n    },\n    \"quantity\": 1,\n    \"total\": \"0.00\",\n    \"paid\": 10,\n    \"created\": \"2015-02-10T01:03:07\",\n    \"modified\": \"2015-02-10T01:44:10\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/apps/api/attendees/:attendee_id/checkin"},"body":"This endpoint allows you to check an [attendee](https://boomset-public-api.readme.io/docs/listing-attendees) in to an [event](https://boomset-public-api.readme.io/docs/listing-events).\n\n* For checkin, use a quantity of 1.\n\n* For checkout, use a quantity of -1.","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-02-05T02:54:07.333Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":9,"project":"54d2cbfc2ce0e00d007515e9","slug":"checking-an-attendee-in","sync_unique":"","title":"Checking an Attendee In","type":"post","updates":[],"user":"54d2cb905616470d0013cc1f","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postChecking an Attendee In


attendee_id:
required
integer
Attendee ID
quantity:
required
string
Quantity
This endpoint allows you to check an [attendee](https://boomset-public-api.readme.io/docs/listing-attendees) in to an [event](https://boomset-public-api.readme.io/docs/listing-events). * For checkin, use a quantity of 1. * For checkout, use a quantity of -1.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



This endpoint allows you to check an [attendee](https://boomset-public-api.readme.io/docs/listing-attendees) in to an [event](https://boomset-public-api.readme.io/docs/listing-events). * For checkin, use a quantity of 1. * For checkout, use a quantity of -1.
{"__v":3,"_id":"54d2db765616470d0013cc34","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"54d2dad45616470d0013cc33","default":"","desc":"Attendee ID","in":"path","name":"attendee_id","ref":"","required":true,"type":"int"},{"_id":"54d2e0a42ce0e00d0075161d","default":"","desc":"Question and Answer","in":"body","name":"questions","ref":"","required":true,"type":"array_string"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"success\": true\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/apps/api/attendees/:attendee_id/update_questions"},"body":"This endpoint will allow you to update the answers to any question an [attendee](https://boomset-public-api.readme.io/docs/listing-attendees) may be asked.\n\nIt accepts a JSON string with a key for questions. The value of the questions key must be an array. In each index of the array must be an object with a key and value for the question's id and the response.\n* For a multiple choice question, use the key `option_id` to specify the response\n* For a text field, use the key `answer` to specify the response\n\nExample formatting:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" \\\"questions\\\" : [ {\\\"question_id\\\" : 1, \\\"answer\\\" : \\\"Test\\\"}, {\\\"question_id\\\" : 2, \\\"option_id\\\" : 1}]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-02-05T02:54:46.333Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":10,"project":"54d2cbfc2ce0e00d007515e9","slug":"updating-an-attendees-questions","sync_unique":"","title":"Updating an Attendee's Questions","type":"post","updates":[],"user":"54d2cb905616470d0013cc1f","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postUpdating an Attendee's Questions


attendee_id:
required
integer
Attendee ID
questions:
required
array of strings
Question and Answer
This endpoint will allow you to update the answers to any question an [attendee](https://boomset-public-api.readme.io/docs/listing-attendees) may be asked. It accepts a JSON string with a key for questions. The value of the questions key must be an array. In each index of the array must be an object with a key and value for the question's id and the response. * For a multiple choice question, use the key `option_id` to specify the response * For a text field, use the key `answer` to specify the response Example formatting: [block:code] { "codes": [ { "code": " \"questions\" : [ {\"question_id\" : 1, \"answer\" : \"Test\"}, {\"question_id\" : 2, \"option_id\" : 1}]", "language": "json" } ] } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



This endpoint will allow you to update the answers to any question an [attendee](https://boomset-public-api.readme.io/docs/listing-attendees) may be asked. It accepts a JSON string with a key for questions. The value of the questions key must be an array. In each index of the array must be an object with a key and value for the question's id and the response. * For a multiple choice question, use the key `option_id` to specify the response * For a text field, use the key `answer` to specify the response Example formatting: [block:code] { "codes": [ { "code": " \"questions\" : [ {\"question_id\" : 1, \"answer\" : \"Test\"}, {\"question_id\" : 2, \"option_id\" : 1}]", "language": "json" } ] } [/block]
{"__v":1,"_id":"55f2f792525cb12300c6c58f","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/web/groups"},"body":"This call lists the groups a user has. Every user has a group created for them when they first register, and all [events](https://boomset-public-api.readme.io/docs/listing-events) are created in groups.\n\nIt pages by 1000.","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-09-11T15:47:30.605Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":12,"project":"54d2cbfc2ce0e00d007515e9","slug":"listing-groups","sync_unique":"","title":"Listing Groups","type":"get","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getListing Groups


This call lists the groups a user has. Every user has a group created for them when they first register, and all [events](https://boomset-public-api.readme.io/docs/listing-events) are created in groups. It pages by 1000.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



This call lists the groups a user has. Every user has a group created for them when they first register, and all [events](https://boomset-public-api.readme.io/docs/listing-events) are created in groups. It pages by 1000.
{"__v":1,"_id":"55f2f7d3b5b25021002b7df2","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"55f2fc37f14a752f0032574a","default":"","desc":"Name","in":"body","name":"name","ref":"","required":true,"type":"string"},{"_id":"55f2fc37f14a752f00325749","default":"","desc":"Group id","in":"body","name":"group","ref":"","required":true,"type":"int"},{"_id":"55f2fc37f14a752f00325748","default":"","desc":"Timezone 1-36","in":"body","name":"timezone","ref":"","required":true,"type":"int"},{"_id":"55f2fc37f14a752f00325747","default":"","desc":"Event state (enter as 1)","in":"body","name":"state","ref":"","required":true,"type":"int"},{"_id":"55f2fc37f14a752f00325746","default":"","desc":"Time starts ISO 8601 format (Example: 2015-09-08T18:00)","in":"body","name":"startsat","ref":"","required":true,"type":"datetime"},{"_id":"55f2fc37f14a752f00325745","default":"","desc":"Time ends ISO 8601 format (Example: 2015-09-08T18:00)","in":"body","name":"endsat","ref":"","required":true,"type":"datetime"},{"_id":"55f2fc37f14a752f00325744","default":"","desc":"Type of event 0-9","in":"body","name":"qtype","ref":"","required":false,"type":"int"},{"_id":"55f2fc37f14a752f00325743","default":"","desc":"(for internal reference) Expected size","in":"body","name":"qsize","ref":"","required":false,"type":"int"},{"_id":"55f2fc37f14a752f00325742","default":"","desc":"(for internal reference) Will the event have sessions?","in":"body","name":"qsessionsbool","ref":"","required":false,"type":"boolean"},{"_id":"55f2fc37f14a752f00325741","default":"","desc":"(for internal reference) Will the event have leads","in":"body","name":"qlead","ref":"","required":false,"type":"boolean"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/events"},"body":"Timezone accepts any of the following integer values:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"1\",\n    \"0-1\": \"[GMT -12:00] Eniwetok, Kwajalein\",\n    \"1-0\": \"2\",\n    \"2-0\": \"3\",\n    \"3-0\": \"4\",\n    \"4-0\": \"5\",\n    \"5-0\": \"6\",\n    \"6-0\": \"7\",\n    \"7-0\": \"8\",\n    \"8-0\": \"9\",\n    \"8-1\": \"[GMT -04:00] Atlantic Time - Canada, Caracas, La Paz\",\n    \"9-0\": \"10\",\n    \"10-0\": \"11\",\n    \"11-0\": \"12\",\n    \"12-0\": \"13\",\n    \"13-0\": \"14\",\n    \"14-0\": \"15\",\n    \"15-0\": \"16\",\n    \"16-0\": \"17\",\n    \"16-1\": \"[GMT +01:00] Brussels, Copenhagen, Madrid, Paris\",\n    \"17-1\": \"[GMT +01:00] Sarajevo, Warsaw, Zagreb\",\n    \"17-0\": \"18\",\n    \"18-0\": \"19\",\n    \"19-0\": \"20\",\n    \"20-0\": \"21\",\n    \"21-0\": \"22\",\n    \"22-0\": \"23\",\n    \"23-0\": \"24\",\n    \"24-0\": \"25\",\n    \"25-0\": \"26\",\n    \"26-0\": \"27\",\n    \"27-0\": \"28\",\n    \"28-0\": \"29\",\n    \"29-0\": \"30\",\n    \"30-0\": \"31\",\n    \"31-0\": \"32\",\n    \"32-0\": \"33\",\n    \"33-0\": \"34\",\n    \"34-0\": \"35\",\n    \"35-0\": \"36\",\n    \"1-1\": \"[GMT -11:00] Midway Islands, Samoa\",\n    \"2-1\": \"[GMT -10:00] Hawaii\",\n    \"3-1\": \"[GMT -09:00] Alaska\",\n    \"4-1\": \"[GMT -08:00] Pacific Time - US & Canada, Tijuana\",\n    \"5-1\": \"[GMT -07:00] Mountain Time - US & Canada\",\n    \"6-1\": \"[GMT -06:00] Central Time - US & Canada, Mexico City\",\n    \"7-1\": \"[GMT -05:00] Eastern Time - US & Canada, Bogota\",\n    \"9-1\": \"[GMT -03:00] Buenos Aires, Georgetown, Greenland\",\n    \"10-1\": \"[GMT -02:00] Mid-Atlantic\",\n    \"11-1\": \"[GMT -01:00] Azores, Cape Verde Island\",\n    \"12-1\": \"[GMT] Greenwich Mean Time: Dublin, London\",\n    \"13-1\": \"[BST] British Summer Time\",\n    \"14-1\": \"[GMT +01:00] Amsterdam, Berlin, Rome\",\n    \"15-1\": \"[GMT +01:00] Belgrade, Prague, Budapest\",\n    \"18-1\": \"[GMT +02:00] Istanbul, Jerusalem, Athens, Minsk\",\n    \"19-1\": \"[GMT +03:00] Moscow, Kuwait Baghdad, Nairobi\",\n    \"20-1\": \"[GMT +03:30] Tehran\",\n    \"21-1\": \"[GMT +04:00] Abu Dhabi, Baku, Tbilisi\",\n    \"22-1\": \"[GMT +04:30] Kabul\",\n    \"23-1\": \"[GMT +05:00] Islamabad, Karachi, Tashkent\",\n    \"24-1\": \"[GMT +05:30] Calcutta, Chennai, Mumbai, New Delhi\",\n    \"25-1\": \"[GMT +05:45] Kathmandu\",\n    \"26-1\": \"[GMT +06:00] Astana, Almaty, Dhaka, Novosibirsk\",\n    \"27-1\": \"[GMT +06:30] Rangoon\",\n    \"28-1\": \"[GMT +07:00] Bangkok, Hanoi, Jakarta\",\n    \"29-1\": \"[GMT +08:00] Beijing, Chongqing, Hong Kong, Singapore\",\n    \"30-1\": \"[GMT +09:00] Osaka, Sapporo, Tokyo\",\n    \"31-1\": \"[GMT +09:30] Adelaide, Darwin\",\n    \"32-1\": \"[GMT +10:00] Brisbane\",\n    \"33-1\": \"[GMT +10:00] Canberra, Melbourne, Sydney\",\n    \"34-1\": \"[GMT +11:00] Magadan, New Caledonia\",\n    \"35-1\": \"[GMT +12:00] Fiji, Kamchatka, Marshall Islands\",\n    \"h-0\": \"Value\",\n    \"h-1\": \"Timezone\"\n  },\n  \"cols\": 2,\n  \"rows\": 36\n}\n[/block]\nQtype refers to the type of event. It accepts any of the following integer values:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"0\",\n    \"0-1\": \"Other\",\n    \"1-0\": \"1\",\n    \"1-1\": \"Conference & Tradeshow\",\n    \"2-0\": \"2\",\n    \"2-1\": \"Festival\",\n    \"3-0\": \"3\",\n    \"3-1\": \"Corporate Event\",\n    \"4-0\": \"4\",\n    \"4-1\": \"Schools & Colleges\",\n    \"5-0\": \"5\",\n    \"5-1\": \"Religious Event\",\n    \"6-0\": \"6\",\n    \"6-1\": \"Networking\",\n    \"7-0\": \"7\",\n    \"7-1\": \"Charity & Fundraiser\",\n    \"8-0\": \"8\",\n    \"8-1\": \"Political Campaign\",\n    \"9-0\": \"9\",\n    \"9-1\": \"Holiday Event\",\n    \"h-0\": \"Value\",\n    \"h-1\": \"Event type\"\n  },\n  \"cols\": 2,\n  \"rows\": 10\n}\n[/block]","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-09-11T15:48:35.092Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":13,"project":"54d2cbfc2ce0e00d007515e9","slug":"creating-an-event","sync_unique":"","title":"Creating an Event","type":"post","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postCreating an Event


name:
required
string
Name
group:
required
integer
Group id
timezone:
required
integer
Timezone 1-36
state:
required
integer
Event state (enter as 1)
startsat:
required
datetime
Time starts ISO 8601 format (Example: 2015-09-08T18:00)
endsat:
required
datetime
Time ends ISO 8601 format (Example: 2015-09-08T18:00)
qtype:
integer
Type of event 0-9
qsize:
integer
(for internal reference) Expected size
qsessionsbool:
boolean
(for internal reference) Will the event have sessions?
qlead:
boolean
(for internal reference) Will the event have leads
Timezone accepts any of the following integer values: [block:parameters] { "data": { "0-0": "1", "0-1": "[GMT -12:00] Eniwetok, Kwajalein", "1-0": "2", "2-0": "3", "3-0": "4", "4-0": "5", "5-0": "6", "6-0": "7", "7-0": "8", "8-0": "9", "8-1": "[GMT -04:00] Atlantic Time - Canada, Caracas, La Paz", "9-0": "10", "10-0": "11", "11-0": "12", "12-0": "13", "13-0": "14", "14-0": "15", "15-0": "16", "16-0": "17", "16-1": "[GMT +01:00] Brussels, Copenhagen, Madrid, Paris", "17-1": "[GMT +01:00] Sarajevo, Warsaw, Zagreb", "17-0": "18", "18-0": "19", "19-0": "20", "20-0": "21", "21-0": "22", "22-0": "23", "23-0": "24", "24-0": "25", "25-0": "26", "26-0": "27", "27-0": "28", "28-0": "29", "29-0": "30", "30-0": "31", "31-0": "32", "32-0": "33", "33-0": "34", "34-0": "35", "35-0": "36", "1-1": "[GMT -11:00] Midway Islands, Samoa", "2-1": "[GMT -10:00] Hawaii", "3-1": "[GMT -09:00] Alaska", "4-1": "[GMT -08:00] Pacific Time - US & Canada, Tijuana", "5-1": "[GMT -07:00] Mountain Time - US & Canada", "6-1": "[GMT -06:00] Central Time - US & Canada, Mexico City", "7-1": "[GMT -05:00] Eastern Time - US & Canada, Bogota", "9-1": "[GMT -03:00] Buenos Aires, Georgetown, Greenland", "10-1": "[GMT -02:00] Mid-Atlantic", "11-1": "[GMT -01:00] Azores, Cape Verde Island", "12-1": "[GMT] Greenwich Mean Time: Dublin, London", "13-1": "[BST] British Summer Time", "14-1": "[GMT +01:00] Amsterdam, Berlin, Rome", "15-1": "[GMT +01:00] Belgrade, Prague, Budapest", "18-1": "[GMT +02:00] Istanbul, Jerusalem, Athens, Minsk", "19-1": "[GMT +03:00] Moscow, Kuwait Baghdad, Nairobi", "20-1": "[GMT +03:30] Tehran", "21-1": "[GMT +04:00] Abu Dhabi, Baku, Tbilisi", "22-1": "[GMT +04:30] Kabul", "23-1": "[GMT +05:00] Islamabad, Karachi, Tashkent", "24-1": "[GMT +05:30] Calcutta, Chennai, Mumbai, New Delhi", "25-1": "[GMT +05:45] Kathmandu", "26-1": "[GMT +06:00] Astana, Almaty, Dhaka, Novosibirsk", "27-1": "[GMT +06:30] Rangoon", "28-1": "[GMT +07:00] Bangkok, Hanoi, Jakarta", "29-1": "[GMT +08:00] Beijing, Chongqing, Hong Kong, Singapore", "30-1": "[GMT +09:00] Osaka, Sapporo, Tokyo", "31-1": "[GMT +09:30] Adelaide, Darwin", "32-1": "[GMT +10:00] Brisbane", "33-1": "[GMT +10:00] Canberra, Melbourne, Sydney", "34-1": "[GMT +11:00] Magadan, New Caledonia", "35-1": "[GMT +12:00] Fiji, Kamchatka, Marshall Islands", "h-0": "Value", "h-1": "Timezone" }, "cols": 2, "rows": 36 } [/block] Qtype refers to the type of event. It accepts any of the following integer values: [block:parameters] { "data": { "0-0": "0", "0-1": "Other", "1-0": "1", "1-1": "Conference & Tradeshow", "2-0": "2", "2-1": "Festival", "3-0": "3", "3-1": "Corporate Event", "4-0": "4", "4-1": "Schools & Colleges", "5-0": "5", "5-1": "Religious Event", "6-0": "6", "6-1": "Networking", "7-0": "7", "7-1": "Charity & Fundraiser", "8-0": "8", "8-1": "Political Campaign", "9-0": "9", "9-1": "Holiday Event", "h-0": "Value", "h-1": "Event type" }, "cols": 2, "rows": 10 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Timezone accepts any of the following integer values: [block:parameters] { "data": { "0-0": "1", "0-1": "[GMT -12:00] Eniwetok, Kwajalein", "1-0": "2", "2-0": "3", "3-0": "4", "4-0": "5", "5-0": "6", "6-0": "7", "7-0": "8", "8-0": "9", "8-1": "[GMT -04:00] Atlantic Time - Canada, Caracas, La Paz", "9-0": "10", "10-0": "11", "11-0": "12", "12-0": "13", "13-0": "14", "14-0": "15", "15-0": "16", "16-0": "17", "16-1": "[GMT +01:00] Brussels, Copenhagen, Madrid, Paris", "17-1": "[GMT +01:00] Sarajevo, Warsaw, Zagreb", "17-0": "18", "18-0": "19", "19-0": "20", "20-0": "21", "21-0": "22", "22-0": "23", "23-0": "24", "24-0": "25", "25-0": "26", "26-0": "27", "27-0": "28", "28-0": "29", "29-0": "30", "30-0": "31", "31-0": "32", "32-0": "33", "33-0": "34", "34-0": "35", "35-0": "36", "1-1": "[GMT -11:00] Midway Islands, Samoa", "2-1": "[GMT -10:00] Hawaii", "3-1": "[GMT -09:00] Alaska", "4-1": "[GMT -08:00] Pacific Time - US & Canada, Tijuana", "5-1": "[GMT -07:00] Mountain Time - US & Canada", "6-1": "[GMT -06:00] Central Time - US & Canada, Mexico City", "7-1": "[GMT -05:00] Eastern Time - US & Canada, Bogota", "9-1": "[GMT -03:00] Buenos Aires, Georgetown, Greenland", "10-1": "[GMT -02:00] Mid-Atlantic", "11-1": "[GMT -01:00] Azores, Cape Verde Island", "12-1": "[GMT] Greenwich Mean Time: Dublin, London", "13-1": "[BST] British Summer Time", "14-1": "[GMT +01:00] Amsterdam, Berlin, Rome", "15-1": "[GMT +01:00] Belgrade, Prague, Budapest", "18-1": "[GMT +02:00] Istanbul, Jerusalem, Athens, Minsk", "19-1": "[GMT +03:00] Moscow, Kuwait Baghdad, Nairobi", "20-1": "[GMT +03:30] Tehran", "21-1": "[GMT +04:00] Abu Dhabi, Baku, Tbilisi", "22-1": "[GMT +04:30] Kabul", "23-1": "[GMT +05:00] Islamabad, Karachi, Tashkent", "24-1": "[GMT +05:30] Calcutta, Chennai, Mumbai, New Delhi", "25-1": "[GMT +05:45] Kathmandu", "26-1": "[GMT +06:00] Astana, Almaty, Dhaka, Novosibirsk", "27-1": "[GMT +06:30] Rangoon", "28-1": "[GMT +07:00] Bangkok, Hanoi, Jakarta", "29-1": "[GMT +08:00] Beijing, Chongqing, Hong Kong, Singapore", "30-1": "[GMT +09:00] Osaka, Sapporo, Tokyo", "31-1": "[GMT +09:30] Adelaide, Darwin", "32-1": "[GMT +10:00] Brisbane", "33-1": "[GMT +10:00] Canberra, Melbourne, Sydney", "34-1": "[GMT +11:00] Magadan, New Caledonia", "35-1": "[GMT +12:00] Fiji, Kamchatka, Marshall Islands", "h-0": "Value", "h-1": "Timezone" }, "cols": 2, "rows": 36 } [/block] Qtype refers to the type of event. It accepts any of the following integer values: [block:parameters] { "data": { "0-0": "0", "0-1": "Other", "1-0": "1", "1-1": "Conference & Tradeshow", "2-0": "2", "2-1": "Festival", "3-0": "3", "3-1": "Corporate Event", "4-0": "4", "4-1": "Schools & Colleges", "5-0": "5", "5-1": "Religious Event", "6-0": "6", "6-1": "Networking", "7-0": "7", "7-1": "Charity & Fundraiser", "8-0": "8", "8-1": "Political Campaign", "9-0": "9", "9-1": "Holiday Event", "h-0": "Value", "h-1": "Event type" }, "cols": 2, "rows": 10 } [/block]
{"__v":2,"_id":"55f32f1ae1484d0d006c8091","api":{"auth":"required","examples":{"codes":[{"language":"text","code":"curl -H \"Authorization: Token <token_id>\" \\\n          -H \"Content-Type: application/json\" \\\n          -X POST -d '{\n                \"type\": \"ticket\",\n                \"name\": \"Example Registration Type\",\n                \"sale\": \"od\",\n                \"startdate\": \"08/01/2016\",\n                \"enddate\": \"08/30/2016\",\n                \"minorder\": \"1\",\n                \"maxorder\": \"20\",\n                \"price\": \"0\",\n                \"qty\": \"150\",\n                \"desc\": \"Example description\"\n            }' \\\n          https://boomset.com/restapi/events/<event_id>/create_reservation_type"}]},"params":[{"_id":"57aafd8fdb6b2e0e003e7d32","default":"","desc":"'donation', 'ticket'","in":"body","name":"type","ref":"","required":true,"type":"string"},{"_id":"55f2fc37f14a752f0032574a","ref":"","in":"body","required":true,"desc":"Name","default":"","type":"string","name":"name"},{"_id":"55f2fc37f14a752f00325749","default":"","desc":"o, d, h, od","in":"body","name":"sale","ref":"","required":true,"type":"string"},{"_id":"55f2fc37f14a752f00325748","ref":"","in":"body","required":true,"desc":"Accepts %m/%d/%Y format","default":"","type":"datetime","name":"startdate"},{"_id":"55f2fc37f14a752f00325746","ref":"","in":"body","required":true,"desc":"Accepts %m/%d/%Y format","default":"","type":"datetime","name":"enddate"},{"_id":"55f2fc37f14a752f00325747","ref":"","in":"body","required":true,"desc":"Accepts %m/%d/%Y %I:%M %p format","default":"","type":"datetime","name":"starttime"},{"_id":"55f2fc37f14a752f00325745","ref":"","in":"body","required":true,"desc":"Accepts %m/%d/%Y %I:%M %p","default":"","type":"datetime","name":"endtime"},{"_id":"55f2fc37f14a752f00325744","default":"","desc":"Minimum purchase","in":"body","name":"minorder","ref":"","required":false,"type":"string"},{"_id":"55f2fc37f14a752f00325743","default":"","desc":"Maximum purchase","in":"body","name":"maxorder","ref":"","required":false,"type":"string"},{"_id":"55f2fc37f14a752f00325742","default":"","desc":"Cost","in":"body","name":"price","ref":"","required":false,"type":"string"},{"_id":"55f32f1ae1484d0d006c809a","default":"","desc":"Registration capacity","in":"body","name":"qty","ref":"","required":false,"type":"string"},{"_id":"55f32f1ae1484d0d006c8099","ref":"","in":"body","required":false,"desc":"Description","default":"","type":"string","name":"desc"},{"_id":"55f32f1ae1484d0d006c8098","ref":"","in":"body","required":false,"desc":"Boolean to show the available quantity","default":"","type":"boolean","name":"showqty"},{"_id":"55f32f1ae1484d0d006c8097","ref":"","in":"body","required":false,"desc":"Boolean for wristband","default":"","type":"boolean","name":"wristband"},{"_id":"55f32f1ae1484d0d006c8096","ref":"","in":"body","required":false,"desc":"HTML color code for wrist band","default":"","type":"string","name":"wristcolor"},{"_id":"55f32f1ae1484d0d006c8095","ref":"","in":"body","required":false,"desc":"Boolean for door sales","default":"","type":"boolean","name":"door"},{"_id":"55f32f1ae1484d0d006c8094","ref":"","in":"body","required":false,"desc":"Boolean for door tickets","default":"","type":"boolean","name":"online"},{"_id":"55f32f1ae1484d0d006c8093","ref":"","in":"body","required":false,"desc":"Boolean for online tickets","default":"","type":"boolean","name":"greeting"},{"_id":"55f32f1ae1484d0d006c8092","ref":"","in":"body","required":false,"desc":"Service fee","default":"","type":"int","name":"fee"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/events/:eventID/create_reservation_type"},"body":"This call enables one to create a registration type for an [event](https://boomset-public-api.readme.io/docs/listing-events). Registration types are needed for needed for adding [attendees](https://boomset-public-api.readme.io/docs/listing-attendees).\n\nThe `sale` parameter accepts the following values:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"o\",\n    \"1-0\": \"d\",\n    \"2-0\": \"h\",\n    \"3-0\": \"od\",\n    \"0-1\": \"Online\",\n    \"1-1\": \"Door\",\n    \"2-1\": \"Hidden\",\n    \"3-1\": \"Online and Door\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-09-11T19:44:26.058Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":14,"project":"54d2cbfc2ce0e00d007515e9","slug":"creating-a-registration-type","sync_unique":"","title":"Creating a Registration Type","type":"post","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postCreating a Registration Type


type:
required
string
'donation', 'ticket'
name:
required
string
Name
sale:
required
string
o, d, h, od
startdate:
required
datetime
Accepts %m/%d/%Y format
enddate:
required
datetime
Accepts %m/%d/%Y format
starttime:
required
datetime
Accepts %m/%d/%Y %I:%M %p format
endtime:
required
datetime
Accepts %m/%d/%Y %I:%M %p
minorder:
string
Minimum purchase
maxorder:
string
Maximum purchase
price:
string
Cost
qty:
string
Registration capacity
desc:
string
Description
showqty:
boolean
Boolean to show the available quantity
wristband:
boolean
Boolean for wristband
wristcolor:
string
HTML color code for wrist band
door:
boolean
Boolean for door sales
online:
boolean
Boolean for door tickets
greeting:
boolean
Boolean for online tickets
fee:
integer
Service fee
This call enables one to create a registration type for an [event](https://boomset-public-api.readme.io/docs/listing-events). Registration types are needed for needed for adding [attendees](https://boomset-public-api.readme.io/docs/listing-attendees). The `sale` parameter accepts the following values: [block:parameters] { "data": { "0-0": "o", "1-0": "d", "2-0": "h", "3-0": "od", "0-1": "Online", "1-1": "Door", "2-1": "Hidden", "3-1": "Online and Door" }, "cols": 2, "rows": 4 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This call enables one to create a registration type for an [event](https://boomset-public-api.readme.io/docs/listing-events). Registration types are needed for needed for adding [attendees](https://boomset-public-api.readme.io/docs/listing-attendees). The `sale` parameter accepts the following values: [block:parameters] { "data": { "0-0": "o", "1-0": "d", "2-0": "h", "3-0": "od", "0-1": "Online", "1-1": "Door", "2-1": "Hidden", "3-1": "Online and Door" }, "cols": 2, "rows": 4 } [/block]
{"__v":1,"_id":"55fc46c8a6ea820d0086ef7f","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"55fc4701af72eb0d0007e02d","default":"","desc":"The ID of the registration type you're trying to edit.","in":"body","name":"id","ref":"","required":true,"type":"string"},{"_id":"55f2fc37f14a752f0032574a","default":"","desc":"Name","in":"body","name":"name","ref":"","required":false,"type":"string"},{"_id":"55f2fc37f14a752f00325749","default":"","desc":"Where it's available","in":"body","name":"sale","ref":"","required":false,"type":"int"},{"_id":"55f2fc37f14a752f00325748","default":"","desc":"Tme starts, accepted with ISO 8601, for example 2015-09-08T18:00","in":"body","name":"startdate","ref":"","required":false,"type":"datetime"},{"_id":"55f2fc37f14a752f00325747","default":"","desc":"Time ends, accepted with ISO 8601, for example 2015-09-08T18:00","in":"body","name":"starttime","ref":"","required":false,"type":"int"},{"_id":"55f2fc37f14a752f00325746","default":"","desc":"Date starts, accepted with ISO 8601, for example 2015-09-08T18:00","in":"body","name":"enddate","ref":"","required":false,"type":"datetime"},{"_id":"55f2fc37f14a752f00325745","default":"","desc":"Date ends, accepted with ISO 8601, for example 2015-09-08T18:00","in":"body","name":"endtime","ref":"","required":false,"type":"datetime"},{"_id":"55f2fc37f14a752f00325744","default":"","desc":"Minimum purchase","in":"body","name":"minorder","ref":"","required":false,"type":"int"},{"_id":"55f2fc37f14a752f00325743","default":"","desc":"Maximum purchase","in":"body","name":"maxorder","ref":"","required":false,"type":"int"},{"_id":"55f2fc37f14a752f00325742","default":"","desc":"Cost","in":"body","name":"price","ref":"","required":false,"type":"int"},{"_id":"55f32f1ae1484d0d006c809a","default":"","desc":"Registration capacity","in":"body","name":"qty","ref":"","required":false,"type":"int"},{"_id":"55f32f1ae1484d0d006c8099","default":"","desc":"Description","in":"body","name":"desc","ref":"","required":false,"type":"string"},{"_id":"55f32f1ae1484d0d006c8098","default":"","desc":"Boolean to show the available quantity","in":"body","name":"showqty","ref":"","required":false,"type":"boolean"},{"_id":"55f32f1ae1484d0d006c8097","default":"","desc":"Boolean for wristband","in":"body","name":"wristband","ref":"","required":false,"type":"boolean"},{"_id":"55f32f1ae1484d0d006c8096","default":"","desc":"HTML color code for wrist band","in":"body","name":"wristcolor","ref":"","required":false,"type":"string"},{"_id":"55f32f1ae1484d0d006c8095","default":"","desc":"Boolean for door sales","in":"body","name":"door","ref":"","required":false,"type":"boolean"},{"_id":"55f32f1ae1484d0d006c8094","default":"","desc":"Boolean for door tickets","in":"body","name":"online","ref":"","required":false,"type":"boolean"},{"_id":"55f32f1ae1484d0d006c8093","default":"","desc":"Boolean for online tickets","in":"body","name":"greeting","ref":"","required":false,"type":"boolean"},{"_id":"55f32f1ae1484d0d006c8092","default":"","desc":"Service fee","in":"body","name":"fee","ref":"","required":false,"type":"int"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/events/:eventID/update_reservation_type"},"body":"This call enables one to edit a registration type for a specific [event](https://boomset-public-api.readme.io/docs/listing-events). Registration types are needed for needed for adding [attendees](https://boomset-public-api.readme.io/docs/listing-attendees).\n\nThe `sale` parameter accepts the following values:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"o\",\n    \"1-0\": \"d\",\n    \"2-0\": \"h\",\n    \"3-0\": \"od\",\n    \"0-1\": \"Online\",\n    \"1-1\": \"Door\",\n    \"2-1\": \"Hidden\",\n    \"3-1\": \"Online and Door\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"54d2cbfd2ce0e00d007515ed","createdAt":"2015-09-18T17:15:52.524Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":15,"project":"54d2cbfc2ce0e00d007515e9","slug":"editing-a-registration-type","sync_unique":"","title":"Editing a Registration Type","type":"post","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postEditing a Registration Type


id:
required
string
The ID of the registration type you're trying to edit.
name:
string
Name
sale:
integer
Where it's available
startdate:
datetime
Tme starts, accepted with ISO 8601, for example 2015-09-08T18:00
starttime:
integer
Time ends, accepted with ISO 8601, for example 2015-09-08T18:00
enddate:
datetime
Date starts, accepted with ISO 8601, for example 2015-09-08T18:00
endtime:
datetime
Date ends, accepted with ISO 8601, for example 2015-09-08T18:00
minorder:
integer
Minimum purchase
maxorder:
integer
Maximum purchase
price:
integer
Cost
qty:
integer
Registration capacity
desc:
string
Description
showqty:
boolean
Boolean to show the available quantity
wristband:
boolean
Boolean for wristband
wristcolor:
string
HTML color code for wrist band
door:
boolean
Boolean for door sales
online:
boolean
Boolean for door tickets
greeting:
boolean
Boolean for online tickets
fee:
integer
Service fee
This call enables one to edit a registration type for a specific [event](https://boomset-public-api.readme.io/docs/listing-events). Registration types are needed for needed for adding [attendees](https://boomset-public-api.readme.io/docs/listing-attendees). The `sale` parameter accepts the following values: [block:parameters] { "data": { "0-0": "o", "1-0": "d", "2-0": "h", "3-0": "od", "0-1": "Online", "1-1": "Door", "2-1": "Hidden", "3-1": "Online and Door" }, "cols": 2, "rows": 4 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



This call enables one to edit a registration type for a specific [event](https://boomset-public-api.readme.io/docs/listing-events). Registration types are needed for needed for adding [attendees](https://boomset-public-api.readme.io/docs/listing-attendees). The `sale` parameter accepts the following values: [block:parameters] { "data": { "0-0": "o", "1-0": "d", "2-0": "h", "3-0": "od", "0-1": "Online", "1-1": "Door", "2-1": "Hidden", "3-1": "Online and Door" }, "cols": 2, "rows": 4 } [/block]
{"__v":4,"_id":"55b84db46aa1a60d00ddf33c","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/accounts/me"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-07-29T03:51:16.487Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"54d2cbfc2ce0e00d007515e9","slug":"testinput","sync_unique":"","title":"Getting User Info","type":"get","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getGetting User Info



User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"55b852fe171b920d001e8d5d","api":{"auth":"required","params":[{"_id":"55b84e5dd9caa30d001aae5f","required":false,"desc":"This should be true for Mobile Inquiries","default":"true","type":"boolean","name":"isMobile","in":"query"},{"_id":"55b84e5dd9caa30d001aae5e","required":false,"desc":"Page size, default 100","default":"100","type":"string","name":"page_size","in":"query"},{"_id":"55b85157171b920d001e8d5a","required":false,"desc":"Page number","default":"0","type":"string","name":"page","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/leadretrieval/events"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-07-29T04:13:50.504Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"project":"54d2cbfc2ce0e00d007515e9","slug":"getting-lead-retrieval-events","sync_unique":"","title":"Getting User Owned Lead Retrieval Events","type":"get","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getGetting User Owned Lead Retrieval Events


isMobile:
booleantrue
This should be true for Mobile Inquiries
page_size:
string100
Page size, default 100
page:
string0
Page number

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"55b8577330943f0d0068c0fb","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55b84e5dd9caa30d001aae5f","required":false,"desc":"This should be true for Mobile Inquiries","default":"true","type":"boolean","name":"isMobile","in":"query"}],"url":"/restapi/leadretrieval/leadEvents"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-07-29T04:32:51.671Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"project":"54d2cbfc2ce0e00d007515e9","slug":"getting-public-lead-retrieval-events","sync_unique":"","title":"Getting Public Lead Retrieval Events","type":"get","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getGetting Public Lead Retrieval Events


isMobile:
booleantrue
This should be true for Mobile Inquiries

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"55b853b6171b920d001e8d5e","api":{"auth":"required","params":[{"_id":"55b853b6171b920d001e8d5f","required":true,"desc":"Event ID","default":"","type":"string","name":"event_id","in":"path"},{"_id":"55b84e5dd9caa30d001aae5f","required":false,"desc":"This should be true for Mobile Inquiries","default":"true","type":"boolean","name":"isMobile","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/events/:event_id/info"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-07-29T04:16:54.972Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"project":"54d2cbfc2ce0e00d007515e9","slug":"getting-event-infosettings","sync_unique":"","title":"Getting Event Info/Settings","type":"get","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getGetting Event Info/Settings


event_id:
required
string
Event ID
isMobile:
booleantrue
This should be true for Mobile Inquiries

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"55b8540bd9caa30d001aae68","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55b853b6171b920d001e8d5f","required":true,"desc":"Event ID","default":"","type":"string","name":"event_id","in":"path"},{"_id":"55b84e5dd9caa30d001aae5f","required":false,"desc":"This should be true for Mobile Inquiries","default":"true","type":"boolean","name":"isMobile","in":"query"}],"url":"/restapi/leadretrieval/events/:event_id"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-07-29T04:18:19.933Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"project":"54d2cbfc2ce0e00d007515e9","slug":"getting-lead-retrieval-event-infosettings","sync_unique":"","title":"Getting Lead Retrieval Event Info/Settings","type":"get","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getGetting Lead Retrieval Event Info/Settings


event_id:
required
string
Event ID
isMobile:
booleantrue
This should be true for Mobile Inquiries

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"55b854ba6aa1a60d00ddf343","api":{"auth":"required","params":[{"_id":"55b854ba6aa1a60d00ddf345","required":true,"desc":"Event ID","default":"","type":"string","name":"event_id","in":"path"},{"_id":"55b84e5dd9caa30d001aae5f","required":false,"desc":"This should be true for Mobile Inquiries","default":"true","type":"boolean","name":"isMobile","in":"query"},{"_id":"55b84e5dd9caa30d001aae5e","required":false,"desc":"Page size, default 100","default":"100","type":"string","name":"page_size","in":"query"},{"_id":"55b85157171b920d001e8d5a","required":false,"desc":"Page number","default":"0","type":"string","name":"page","in":"query"},{"_id":"55b854ba6aa1a60d00ddf344","required":false,"desc":"Set ordering of guests","default":"id","type":"string","name":"ordering","in":"query"},{"_id":"565cd68177f0090d005817d8","default":"","desc":"If you provide this variable, it returns you only the the attendees who are updated after this time. Needs to be sent in GMT. Format: 2015-07-29T18:35:31'","name":"timestamp","required":false,"type":"string","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/guestlist/:event_id"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-07-29T04:21:14.929Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"project":"54d2cbfc2ce0e00d007515e9","slug":"getting-guests","sync_unique":"","title":"Getting Guests","type":"get","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getGetting Guests


event_id:
required
string
Event ID
isMobile:
booleantrue
This should be true for Mobile Inquiries
page_size:
string100
Page size, default 100
page:
string0
Page number
ordering:
stringid
Set ordering of guests
timestamp:
string
If you provide this variable, it returns you only the the attendees who are updated after this time. Needs to be sent in GMT. Format: 2015-07-29T18:35:31'

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"55b8551ad9caa30d001aae6d","api":{"auth":"required","params":[{"_id":"55b854ba6aa1a60d00ddf345","required":true,"desc":"Event ID","default":"","type":"string","name":"event_id","in":"path"},{"_id":"55b84e5dd9caa30d001aae5f","required":false,"desc":"This should be true for Mobile Inquiries","default":"true","type":"boolean","name":"isMobile","in":"query"},{"_id":"55b84e5dd9caa30d001aae5e","required":false,"desc":"Page size, default 100","default":"100","type":"string","name":"page_size","in":"query"},{"_id":"55b85157171b920d001e8d5a","required":false,"desc":"Page number","default":"0","type":"string","name":"page","in":"query"},{"_id":"55b854ba6aa1a60d00ddf344","required":false,"desc":"Set ordering of guests","default":"id","type":"string","name":"ordering","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/leadretrieval/leads/:event_id"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-07-29T04:22:50.717Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"project":"54d2cbfc2ce0e00d007515e9","slug":"getting-leads","sync_unique":"","title":"Getting Leads","type":"get","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getGetting Leads


event_id:
required
string
Event ID
isMobile:
booleantrue
This should be true for Mobile Inquiries
page_size:
string100
Page size, default 100
page:
string0
Page number
ordering:
stringid
Set ordering of guests

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"55b855e926a2da0d00083b80","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55b854ba6aa1a60d00ddf345","required":true,"desc":"Registration ID","default":"","type":"string","name":"registration_id","in":"path"}],"url":"/restapi/reservation/settings/:registration_id/send_ticket"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-07-29T04:26:17.791Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"project":"54d2cbfc2ce0e00d007515e9","slug":"re-sending-registration-confirmation","sync_unique":"","title":"Re-Sending Registration Confirmation","type":"post","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postRe-Sending Registration Confirmation


registration_id:
required
string
Registration ID

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"55b915208fd1a02b00f4964c","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55b84e5dd9caa30d001aae5f","required":false,"desc":"This should be true for Mobile Inquiries","default":"true","type":"boolean","name":"isMobile","in":"query"}],"url":"/restapi/groups/handshake"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-07-29T18:02:08.166Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":9,"project":"54d2cbfc2ce0e00d007515e9","slug":"handshaking-groups","sync_unique":"","title":"Handshaking Groups","type":"get","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getHandshaking Groups


isMobile:
booleantrue
This should be true for Mobile Inquiries

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"55b9153a8fd1a02b00f4964d","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"55b84e5dd9caa30d001aae5f","required":false,"desc":"This should be true for Mobile Inquiries","default":"true","type":"boolean","name":"isMobile","in":"query"}],"url":"/restapi/leadretrieval/handshake"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-07-29T18:02:34.648Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":10,"project":"54d2cbfc2ce0e00d007515e9","slug":"handshaking-lead-retrieval-groups","sync_unique":"","title":"Handshaking Lead Retrieval Groups","type":"get","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

getHandshaking Lead Retrieval Groups


isMobile:
booleantrue
This should be true for Mobile Inquiries

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"55b91dc6146ef1210021586d","api":{"auth":"required","examples":{"codes":[{"name":"","code":"barcodes = [\n\t{\n\t\t'id':'1231312',\n \t \t'used': '1',\n  \t'timestamp': '2015-07-29T18:35:31',\n  \t'hash_key': 'nelkf23223f'\n  },\n  {\n  \t'id':'2321',\n  \t'used': '1', 'timestamp':\n  \t'2015-07-29T18:35:31',\n  \t'hash_key': 'fe3df34',\n  \t'session_id':'3453'\n  }\n]","language":"text"}]},"params":[{"_id":"55b854ba6aa1a60d00ddf345","required":true,"desc":"The Barcode Array. This contains array of Barcode Checkin Dictionaries where the keys are explained below.","default":"","type":"array_mixed","name":"barcodes","in":"body"},{"_id":"55b9201ffeef5135009b7db0","required":true,"desc":"Barcode ID Key of Barcode Checkin Dictionary","default":"","type":"string","name":"id","in":"body"},{"_id":"55b9201ffeef5135009b7daf","required":true,"desc":"Used ID Key of Barcode Checkin Dictionary. Values are 1 or 0","default":"","type":"string","name":"used","in":"body"},{"_id":"55b9201ffeef5135009b7dae","required":true,"desc":"Timestamp Key of Barcode Checkin Dictionary. Needs to be sent in GMT. Format: 2015-07-29T18:35:31'","default":"","type":"string","name":"timestamp","in":"body"},{"_id":"55b9201ffeef5135009b7dad","default":"","desc":"Hash Key of Barcode Checkin Dictionary. When an attendee is checked-in on a local device, a check-in object gets created in the local database of the check-in device. This object is marked as \"to-be-synched\". In every synch cycle, these objects are sent to the backend. After receiving the check-in objects, the backend issues database IDs to these objects and sends back acknowledgements as a response to this method. Before sending the object to the backend, the local checkin object will not have an ID, so when we receive an acknowledgement, we don't know which object to mark as \"synched\" To solve this problem. we would create a random hashed key for each checkin object in our local database at the time of object creation. We send this checkin object to the backend with this hash key. After processing and assigning a database ID, the backend sends us the acknowledgement with Real Database ID for the checkin object and also it sends the Hash Key that we have created for this. When we receive the acknowledgement in our local device, we can find it easily with by looking up this checkin object with EventID and HashKey. After finding the object, we would assign it's real ID to the object and then we mark it as \"synched\" This method also solves duplicate processing in the backend. If you don't receive your acknowledgement in time, you might send the same checkin object to the database. The database checks the hashkey and decides if the checkin object needs to be processed as new or it is a duplicate. Regardless of which, it would send you the real database id and the hashkey that you sent.","name":"hash_key","required":true,"type":"string","in":"body"},{"_id":"55b9201ffeef5135009b7dac","required":false,"desc":"Optional Session ID Key of Barcode Checkin Dictionary. If this is sent, then the checkin is for a session.","default":"","type":"string","name":"session_id","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/guestlist/barcode_batch_update"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-07-29T18:39:02.514Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":11,"project":"54d2cbfc2ce0e00d007515e9","slug":"re-sending-registration-confirmation-1","sync_unique":"","title":"Batch Checkin Attendees/Barcodes","type":"post","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postBatch Checkin Attendees/Barcodes


barcodes:
required
array of mixed
The Barcode Array. This contains array of Barcode Checkin Dictionaries where the keys are explained below.
id:
required
string
Barcode ID Key of Barcode Checkin Dictionary
used:
required
string
Used ID Key of Barcode Checkin Dictionary. Values are 1 or 0
timestamp:
required
string
Timestamp Key of Barcode Checkin Dictionary. Needs to be sent in GMT. Format: 2015-07-29T18:35:31'
hash_key:
required
string
Hash Key of Barcode Checkin Dictionary. When an attendee is checked-in on a local device, a check-in object gets created in the local database of the check-in device. This object is marked as "to-be-synched". In every synch cycle, these objects are sent to the backend. After receiving the check-in objects, the backend issues database IDs to these objects and sends back acknowledgements as a response to this method. Before sending the object to the backend, the local checkin object will not have an ID, so when we receive an acknowledgement, we don't know which object to mark as "synched" To solve this problem. we would create a random hashed key for each checkin object in our local database at the time of object creation. We send this checkin object to the backend with this hash key. After processing and assigning a database ID, the backend sends us the acknowledgement with Real Database ID for the checkin object and also it sends the Hash Key that we have created for this. When we receive the acknowledgement in our local device, we can find it easily with by looking up this checkin object with EventID and HashKey. After finding the object, we would assign it's real ID to the object and then we mark it as "synched" This method also solves duplicate processing in the backend. If you don't receive your acknowledgement in time, you might send the same checkin object to the database. The database checks the hashkey and decides if the checkin object needs to be processed as new or it is a duplicate. Regardless of which, it would send you the real database id and the hashkey that you sent.
session_id:
string
Optional Session ID Key of Barcode Checkin Dictionary. If this is sent, then the checkin is for a session.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":12,"_id":"55e4720c830ec32300e1a302","api":{"auth":"required","examples":{"codes":[{"name":"","code":"Printing description of an example attendee dict:\n{\n    amount = 0;\n    created = \"2015-08-31 15:21:19\";\n    customQuestions =     (\n                {\n            answer = 76276;\n            qID = 1039930;\n            type = 1;\n        },\n                {\n            answer = 76278;\n            qID = 1039931;\n            type = 1;\n        },\n                {\n            answer = 76279;\n            qID = 1039931;\n            type = 1;\n        },\n                {\n            answer = Tradeshoe;\n            qID = 1046115;\n            type = 0;\n        }\n    );\n    defaultQuestions = \"{\\\"86\\\":{\\\"answer\\\":\\\"887766cell\\\",\\\"type\\\":\\\"0\\\"},\\\"55\\\":{\\\"answer\\\":\\\"woork\\\",\\\"type\\\":\\\"0\\\"},\\\"45\\\":{\\\"answer\\\":\\\"Pre\\\",\\\"type\\\":\\\"0\\\"},\\\"53\\\":{\\\"answer\\\":\\\"Bpo\\U00f6set\\\",\\\"type\\\":\\\"0\\\"},\\\"48\\\":{\\\"answer\\\":\\\"9176890352\\\",\\\"type\\\":\\\"0\\\"},\\\"46\\\":{\\\"answer\\\":\\\"Suf\\\",\\\"type\\\":\\\"0\\\"},\\\"54\\\":{\\\"answer\\\":\\\"Cto\\\",\\\"type\\\":\\\"0\\\"},\\\"49\\\":{\\\"answer\\\":\\\"M\\\",\\\"type\\\":\\\"0\\\"}}\";\n    email = \"Kerem@bom\";\n    eventID = 14403;\n    lastname = Baran;\n    name = Kerem;\n    paid = 10;\n    quantity = 1;\n    reservationTypeID = 133796;\n    reservations =     {\n        133796 =         {\n            amount = 0;\n            quantity = 1;\n        };\n    };\n    sourceID = 24;\n}","language":"text"}]},"params":[{"_id":"55e473d7830ec32300e1a30b","ref":"","in":"body","required":true,"desc":"Source ID of the registration. (Use 24)","default":"24","type":"int","name":"sourceID"},{"_id":"55b9201ffeef5135009b7dae","ref":"","in":"body","required":true,"desc":"Email of the attendee","default":"","type":"string","name":"email"},{"_id":"55b9201ffeef5135009b7dad","ref":"","in":"path","required":true,"desc":"Event ID String","default":"","type":"string","name":"eventID"},{"_id":"55b9201ffeef5135009b7dac","ref":"","in":"body","required":true,"desc":"First Name of the attendee","default":"","type":"string","name":"name"},{"_id":"55e473d7830ec32300e1a30d","ref":"","in":"body","required":true,"desc":"Last Name of the attendee","default":"","type":"string","name":"lastname"},{"_id":"565e401a413e06170093dd21","ref":"","in":"body","required":true,"desc":"Paid Type of the registration (Use 10)","default":"10","type":"int","name":"paid"},{"_id":"55e473d7830ec32300e1a30a","ref":"","in":"body","required":true,"desc":"The ID of the registration type that we would like to add the attendee under.","default":"","type":"string","name":"reservationTypeID"},{"_id":"55e473d7830ec32300e1a30c","ref":"","in":"body","required":true,"desc":"Mandatory reservations dict. It's structure is explained below","default":"","type":"string","name":"reservations"},{"_id":"55e4c473177b6e0d003330f5","ref":"","in":"body","required":false,"desc":"Custom Questions String which holds the responses of custom questions array in a json string. Every object of the array is a dictionary. It will be explained in below parts.","default":"()","type":"string","name":"defaultquestions"},{"_id":"55b9201ffeef5135009b7daf","ref":"","in":"body","required":false,"desc":"Custom Questions String which holds the responses of custom questions array in a json string. Every object of the array is a dictionary. Keys of the dictionary are (answer, qID (question ID), type)","default":"()","type":"string","name":"customquestions"},{"_id":"55b9201ffeef5135009b7db0","ref":"","in":"body","required":false,"desc":"Timestamp Key of Barcode Checkin Dictionary. Needs to be sent in GMT. Format: 2015-07-29T18:35:31'","default":"","type":"string","name":"created"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/guestlist/add_guest/:eventID"},"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Default Questions (defaultQuestions key)\",\n  \"body\": \"Default questions key is a Json string. It is a dictionary of dictionaries. Every dictionary contains data for default questions of the attendee such as Work Info, Job Title, Phone...\\n\\nFor Example below is a response which contains default question data\\n\\ndefaultQuestions = \\\"{\\\\\\\"86\\\\\\\":{\\\\\\\"answer\\\\\\\":\\\\\\\"9173333333\\\\\\\",\\\\\\\"type\\\\\\\":\\\\\\\"0\\\\\\\"},\\\\\\\"53\\\\\\\":{\\\\\\\"answer\\\\\\\":\\\\\\\"Boomset\\\\\\\",\\\\\\\"type\\\\\\\":\\\\\\\"0\\\\\\\"},\\\\\\\"54\\\\\\\":{\\\\\\\"answer\\\\\\\":\\\\\\\"CEO\\\\\\\",\\\\\\\"type\\\\\\\":\\\\\\\"0\\\\\\\"}}\\\"\\n\\nIn this example, the keys 86, 53 and 54 reflect Cellphone, Company Name and Job Title. In every dictionary, there are answer and type keys. Type is always 0 and answer contains the data for this question. The key list is below.\\n\\n45: Prefix\\n46: Suffix\\n47: Email\\n48: Phone\\n53: Company Name\\n54: Job Title\\n55: Work Phone\\n56: Website\\n86: Cellphone\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Custom Questions (customQuestions key)\",\n  \"body\": \"Custom questions key is a Json string. It is an array of dictionaries. Every dictionary contains data for default questions of the attendee such as Work Info, Job Title, Phone...\\n\\nFor Example below is a response which contains Custom question data\\n\\ncustomQuestions =     (\\n                {\\n            answer = 76276;\\n            qID = 1039930;\\n            type = 1;\\n        },\\n                {\\n            answer = 76278;\\n            qID = 1039931;\\n            type = 1;\\n        },\\n                {\\n            answer = 76279;\\n            qID = 1039931;\\n            type = 1;\\n        },\\n                {\\n            answer = Tradeshow;\\n            qID = 1046115;\\n            type = 0;\\n        }\\n    );\\n\\nIn every dictionary, answer contains the response to the question. If the type is 0, then the answer is a raw data and entered as string. If the type is 1, then the answer is an objectID for that specific question (Object IDs per question can be obtained from the API)\\nqID is the object ID of the question which also can be obtained from the API\"\n}\n[/block]","category":"55b84d57171b920d001e8d57","createdAt":"2015-08-31T15:26:04.705Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":13,"project":"54d2cbfc2ce0e00d007515e9","slug":"adding-an-attendee","sync_unique":"","title":"Adding an Attendee","type":"post","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postAdding an Attendee


sourceID:
required
integer24
Source ID of the registration. (Use 24)
email:
required
string
Email of the attendee
eventID:
required
string
Event ID String
name:
required
string
First Name of the attendee
lastname:
required
string
Last Name of the attendee
paid:
required
integer10
Paid Type of the registration (Use 10)
reservationTypeID:
required
string
The ID of the registration type that we would like to add the attendee under.
reservations:
required
string
Mandatory reservations dict. It's structure is explained below
defaultquestions:
string()
Custom Questions String which holds the responses of custom questions array in a json string. Every object of the array is a dictionary. It will be explained in below parts.
customquestions:
string()
Custom Questions String which holds the responses of custom questions array in a json string. Every object of the array is a dictionary. Keys of the dictionary are (answer, qID (question ID), type)
created:
string
Timestamp Key of Barcode Checkin Dictionary. Needs to be sent in GMT. Format: 2015-07-29T18:35:31'
[block:callout] { "type": "info", "title": "Default Questions (defaultQuestions key)", "body": "Default questions key is a Json string. It is a dictionary of dictionaries. Every dictionary contains data for default questions of the attendee such as Work Info, Job Title, Phone...\n\nFor Example below is a response which contains default question data\n\ndefaultQuestions = \"{\\\"86\\\":{\\\"answer\\\":\\\"9173333333\\\",\\\"type\\\":\\\"0\\\"},\\\"53\\\":{\\\"answer\\\":\\\"Boomset\\\",\\\"type\\\":\\\"0\\\"},\\\"54\\\":{\\\"answer\\\":\\\"CEO\\\",\\\"type\\\":\\\"0\\\"}}\"\n\nIn this example, the keys 86, 53 and 54 reflect Cellphone, Company Name and Job Title. In every dictionary, there are answer and type keys. Type is always 0 and answer contains the data for this question. The key list is below.\n\n45: Prefix\n46: Suffix\n47: Email\n48: Phone\n53: Company Name\n54: Job Title\n55: Work Phone\n56: Website\n86: Cellphone" } [/block] [block:callout] { "type": "info", "title": "Custom Questions (customQuestions key)", "body": "Custom questions key is a Json string. It is an array of dictionaries. Every dictionary contains data for default questions of the attendee such as Work Info, Job Title, Phone...\n\nFor Example below is a response which contains Custom question data\n\ncustomQuestions = (\n {\n answer = 76276;\n qID = 1039930;\n type = 1;\n },\n {\n answer = 76278;\n qID = 1039931;\n type = 1;\n },\n {\n answer = 76279;\n qID = 1039931;\n type = 1;\n },\n {\n answer = Tradeshow;\n qID = 1046115;\n type = 0;\n }\n );\n\nIn every dictionary, answer contains the response to the question. If the type is 0, then the answer is a raw data and entered as string. If the type is 1, then the answer is an objectID for that specific question (Object IDs per question can be obtained from the API)\nqID is the object ID of the question which also can be obtained from the API" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "title": "Default Questions (defaultQuestions key)", "body": "Default questions key is a Json string. It is a dictionary of dictionaries. Every dictionary contains data for default questions of the attendee such as Work Info, Job Title, Phone...\n\nFor Example below is a response which contains default question data\n\ndefaultQuestions = \"{\\\"86\\\":{\\\"answer\\\":\\\"9173333333\\\",\\\"type\\\":\\\"0\\\"},\\\"53\\\":{\\\"answer\\\":\\\"Boomset\\\",\\\"type\\\":\\\"0\\\"},\\\"54\\\":{\\\"answer\\\":\\\"CEO\\\",\\\"type\\\":\\\"0\\\"}}\"\n\nIn this example, the keys 86, 53 and 54 reflect Cellphone, Company Name and Job Title. In every dictionary, there are answer and type keys. Type is always 0 and answer contains the data for this question. The key list is below.\n\n45: Prefix\n46: Suffix\n47: Email\n48: Phone\n53: Company Name\n54: Job Title\n55: Work Phone\n56: Website\n86: Cellphone" } [/block] [block:callout] { "type": "info", "title": "Custom Questions (customQuestions key)", "body": "Custom questions key is a Json string. It is an array of dictionaries. Every dictionary contains data for default questions of the attendee such as Work Info, Job Title, Phone...\n\nFor Example below is a response which contains Custom question data\n\ncustomQuestions = (\n {\n answer = 76276;\n qID = 1039930;\n type = 1;\n },\n {\n answer = 76278;\n qID = 1039931;\n type = 1;\n },\n {\n answer = 76279;\n qID = 1039931;\n type = 1;\n },\n {\n answer = Tradeshow;\n qID = 1046115;\n type = 0;\n }\n );\n\nIn every dictionary, answer contains the response to the question. If the type is 0, then the answer is a raw data and entered as string. If the type is 1, then the answer is an objectID for that specific question (Object IDs per question can be obtained from the API)\nqID is the object ID of the question which also can be obtained from the API" } [/block]
{"__v":0,"_id":"565cd585ea82b00d00f94a80","api":{"auth":"required","examples":{"codes":[{"language":"text","code":""}]},"params":[{"_id":"55b854ba6aa1a60d00ddf345","default":"","desc":"The Reservation ID in a String Format","name":"reservation_id","required":true,"type":"string","in":"body"},{"_id":"55b9201ffeef5135009b7db0","default":"","desc":"The Session id that you would like to register the user to in a string format","name":"session_id","required":true,"type":"string","in":"body"}],"results":{"codes":[{"status":200,"language":"text","code":"If your request is successful, you will receive OK (200) and also The Attendee's final information in a dictionary so you can filter out all the sessions that he is registered to.\n\nIf your request is not successful, you will receive Bad Request (400)","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/eventsessions/update_reservation_session"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-11-30T23:02:29.715Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":999,"project":"54d2cbfc2ce0e00d007515e9","slug":"updating-attendee-session","sync_unique":"","title":"Updating Attendee Session","type":"post","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postUpdating Attendee Session


reservation_id:
required
string
The Reservation ID in a String Format
session_id:
required
string
The Session id that you would like to register the user to in a string format

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"56816a0f25ea3717002a02f5","api":{"auth":"required","examples":{"codes":[{"name":"","code":"reservations = [\n\t{\n\t\t'id':'1231312',\n \t \t'comment': 'This attendee has been upgraded to VIP. Hand her some VIP bags please',\n  \t'timestamp': '2015-07-29T18:35:31'\n  },\n  {\n  \t'id':'2321',\n  \t'comment': 'Lost her glasses, her phone is 912-213-1212. Call her if you find them',\n    'timestamp': '2015-07-29T18:35:31'\n  }\n]","language":"text"}]},"params":[{"_id":"55b854ba6aa1a60d00ddf345","required":true,"desc":"The Array which holds all the comments info. This contains array of Barcode Checkin Dictionaries where the keys are explained below.","default":"","type":"array_mixed","name":"reservations","in":"body"},{"_id":"55b9201ffeef5135009b7db0","required":true,"desc":"Reservation ID Key of the Comment to be added to","default":"","type":"string","name":"id","in":"body"},{"_id":"55b9201ffeef5135009b7daf","required":true,"desc":"The string which contains the comment","default":"","type":"string","name":"comment","in":"body"},{"_id":"55b9201ffeef5135009b7dae","required":true,"desc":"Timestamp Key of Barcode Checkin Dictionary. Needs to be sent in GMT. Format: 2015-07-29T18:35:31'","default":"","type":"string","name":"timestamp","in":"body"}],"results":{"codes":[{"status":200,"language":"text","code":"USAGE & RESULTS FOR THIS FUNCTION IS VERY IMPORTANT! PLEASE READ BELOW;\n\nAdding comments can be done offline in your mobile device! When a user adds a comment, make sure you record the added timestamp in GMT and attach this comment to the reservation with a flag of (TO_BE_SYNCED = 1)\n\nWhen you are doing your sync cycles, you can lookup all the TO_BE_SYNCED = 1 comments and send them all at once to this endpoint. After receiving this array of comment and successfully adding them to the database, this endpoint retrieves you acknowledgements by their timestamps. \n\nLet's say you sent that function three comments like following; \nComment1 - Timestamp1 - Reservation1\nComment2 - Timestamp2 - Reservation1\nComment3 - Timestamp3 - Reservation2\n\nIn this example, we have two comments for Reservation 1 and also one comment for reservation 2\n\nThis endpoint will return you three serialized comment objects with their Database IDs and sent timestamps. By looking at their timestamps and registrations, you can identify the NOT SYNCED OBJECT in your database and then add it's received database ID to this object and finally make its TO_BE_SYNCED to 0. This way, it won't keep trying to sync after the successful sync. \n\nImagine you received Comment1 from the results. It will look like \nComment1 - DB_ID_of_Comment1 - Timestamp1 - Reservation1\n\nWhen you lookup your local database with the search key of Reservation1 & Timestamp1 & To_Be_Synced=1, it should return you only one comment object. You will add the real db ID to to this object and make its to_be_synced to '0'. \n\n\n\n{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/guestlist/comments/batch_add"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-12-28T16:57:51.712Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":999,"project":"54d2cbfc2ce0e00d007515e9","slug":"batch-add-comments","sync_unique":"","title":"Batch Add Comments","type":"post","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postBatch Add Comments


reservations:
required
array of mixed
The Array which holds all the comments info. This contains array of Barcode Checkin Dictionaries where the keys are explained below.
id:
required
string
Reservation ID Key of the Comment to be added to
comment:
required
string
The string which contains the comment
timestamp:
required
string
Timestamp Key of Barcode Checkin Dictionary. Needs to be sent in GMT. Format: 2015-07-29T18:35:31'

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"56816d7c96e9980d0093db7d","api":{"auth":"required","examples":{"codes":[{"name":"","code":"comments = [\n\t{\n\t\t'id':'1231312'\n  },\n  {\n  \t'id':'2321'\n  }\n]","language":"text"}]},"params":[{"_id":"55b854ba6aa1a60d00ddf345","required":true,"desc":"The Array which holds all the comments info. This contains array of Barcode Checkin Dictionaries where the keys are explained below.","default":"","type":"array_mixed","name":"comments","in":"body"},{"_id":"55b9201ffeef5135009b7db0","required":true,"desc":"ID Key of the Comment to be deleted","default":"","type":"string","name":"id","in":"body"}],"results":{"codes":[{"status":200,"language":"text","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/guestlist/comments/batch_delete"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-12-28T17:12:28.046Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":999,"project":"54d2cbfc2ce0e00d007515e9","slug":"batch-delete-comments","sync_unique":"","title":"Batch Delete Comments","type":"post","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postBatch Delete Comments


comments:
required
array of mixed
The Array which holds all the comments info. This contains array of Barcode Checkin Dictionaries where the keys are explained below.
id:
required
string
ID Key of the Comment to be deleted

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



{"project":"54d2cbfc2ce0e00d007515e9","version":"54d2cbfd2ce0e00d007515ec","category":"55b84d57171b920d001e8d57","_id":"5682cff7eb6f4c0d00e89dd8","user":"54d968913268702d007d9458","updates":[],"createdAt":"2015-12-29T18:24:55.484Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"text","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"examples":{"codes":[{"name":"","code":"","language":"text"}]},"auth":"required","params":[],"url":"/restapi/reservation/settings/:reservationID/send_ticket"},"order":999,"body":"","excerpt":"","slug":"re-sending-ticket-confirmation","type":"post","title":"Re-Sending Ticket Confirmation","__v":0,"childrenPages":[]}

postRe-Sending Ticket Confirmation



User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


{"__v":0,"_id":"5682d7efcb4d190d00276922","api":{"auth":"required","examples":{"codes":[{"name":"","code":"{\n \t\"reservations\":\n  [\n\t\t{\n\t\t\t\"contact\": {\n\t\t\t\t\"first_name\": \"John\",\n\t\t\t\t\"last_name\": \"Smith1\"\n\t\t\t},\n\t\t\t\"hash\": 3903562782,\n\t\t\t\"id\": 7915250\n\t\t},\n\t\t{\n\t\t\t\"contact\": {\n\t\t\t\t\"email\": \"test@boomset.comk\"\n\t\t\t},\n\t\t\t\"hash\": 1840002590,\n\t\t\t\"id\": 7915250\n\t\t},\n\t\t{\n\t\t\t\"contact\": {\n\t\t\t\t\"phone\" = 09\n\t\t\t},\n\t\t\t\"hash\": 184964638,\n\t\t\t\"id\": 7915250\n\t\t},\n\t\t{\n\t\t\t\"work_info\": {\n\t\t\t\t\"company\" = \"Aspiration Station2\"\n\t\t\t},\n\t\t\t\"hash\": 1820593694,\n\t\t\t\"id\": 10313893\n    },\n\t\t{\n\t\t\t\"given_answers\": [{\n      \t\"question_id\": 2340923,\n        \"answer_raw\": \"Up and over.\"\n      }],\n      \"hash\": 242534456645634543,\n      \"id\": 7915250\n\t\t}\n\t]\n}","language":"json"}]},"params":[{"_id":"55b854ba6aa1a60d00ddf345","required":true,"desc":"The Changes Array. This contains array of Registration Info Change Dictionaries where the keys are explained below.","default":"","type":"array_mixed","name":"reservations","in":"body"},{"_id":"55b9201ffeef5135009b7db0","required":true,"desc":"Reservation ID of the Attendee","default":"","type":"string","name":"id","in":"body"},{"_id":"55b9201ffeef5135009b7dad","required":true,"desc":"Hash Key of the update Dictionary. When an attendee is updated on a local device, an update object gets created in the local database of the check-in device. This object is marked as \"to-be-synched\". In every sync cycle, these objects are sent to the backend. After receiving the update objects, the backend makes these changes and sends back acknowledgements as a response to this method. When we receive an acknowledgement, we find this update object in the local database and delete it because it is successfully processed.","default":"","type":"string","name":"hash","in":"body"},{"_id":"55b9201ffeef5135009b7dac","default":"","desc":"Contact Key. This is a Dictionary and can only include first_name and last_name, email, phone,prefix,suffix,cell_phone,","name":"contact","required":false,"type":"mixed","in":"body"},{"_id":"5682d7efcb4d190d00276924","default":"","desc":"work_info Key. Dictionary which Contains company, title, website,blog,work_phone","name":"work_info","required":false,"type":"mixed","in":"body"},{"_id":"5682d7efcb4d190d00276923","default":"","desc":"Given answers array. Each member of this array has keys such as question_id, answer_raw,  answer_id. Question ID is mandatory. If your answer is an open text, then you only need to fill out answer_raw. If not, then you need to fill out answer_id","name":"given_answers","required":false,"type":"array_mixed","in":"body"}],"results":{"codes":[{"name":"","code":"[7915250,10313893]","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/restapi/guestlist/contacts/update"},"body":"","category":"55b84d57171b920d001e8d57","createdAt":"2015-12-29T18:58:55.118Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":999,"project":"54d2cbfc2ce0e00d007515e9","slug":"batch-update-attendee-info","sync_unique":"","title":"Batch Update Attendee Info","type":"post","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postBatch Update Attendee Info


reservations:
required
array of mixed
The Changes Array. This contains array of Registration Info Change Dictionaries where the keys are explained below.
id:
required
string
Reservation ID of the Attendee
hash:
required
string
Hash Key of the update Dictionary. When an attendee is updated on a local device, an update object gets created in the local database of the check-in device. This object is marked as "to-be-synched". In every sync cycle, these objects are sent to the backend. After receiving the update objects, the backend makes these changes and sends back acknowledgements as a response to this method. When we receive an acknowledgement, we find this update object in the local database and delete it because it is successfully processed.
contact:
mixed
Contact Key. This is a Dictionary and can only include first_name and last_name, email, phone,prefix,suffix,cell_phone,
work_info:
mixed
work_info Key. Dictionary which Contains company, title, website,blog,work_phone
given_answers:
array of mixed
Given answers array. Each member of this array has keys such as question_id, answer_raw, answer_id. Question ID is mandatory. If your answer is an open text, then you only need to fill out answer_raw. If not, then you need to fill out answer_id

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":1,"_id":"5717c0806e78c8190011022d","api":{"auth":"required","examples":{"codes":[{"language":"text","code":"","name":""}]},"params":[{"_id":"55b854ba6aa1a60d00ddf345","ref":"","required":true,"desc":"has to be exact: kioskselfie.boomset.com/<barcodeID>.png OR kiosksignature.boomset.com/<barcodeID>.png","default":"","type":"string","name":"filename","in":"body"},{"_id":"55b9201ffeef5135009b7db0","ref":"","required":true,"desc":"the ID of the event","default":"","type":"string","name":"eventId","in":"body"},{"_id":"55b9201ffeef5135009b7dad","default":"","desc":"this should contain the file and the name of the file has to be <barcodeID>.png","name":"file","ref":"","required":true,"type":"object","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/restapi/events/file_upload/"},"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"In this call, you have to send Multipart Form Data with No Parameters.\\n\\nYour form information is above adding a screenshot of an example call below\",\n  \"title\": \"Warning, this endpoint accepts a Multiparm Form Data with NO Parameters\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/jxnwuJMUQIGMmVgZn5Ur_Screen%20Shot%202016-01-26%20at%202.16.56%20AM.png\",\n        \"Screen Shot 2016-01-26 at 2.16.56 AM.png\",\n        \"1436\",\n        \"368\",\n        \"#72a8ef\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","category":"55b84d57171b920d001e8d57","createdAt":"2016-04-20T17:46:40.186Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":999,"project":"54d2cbfc2ce0e00d007515e9","slug":"selfie-and-signature-upload-file-upload","sync_unique":"","title":"Selfie and Signature Upload - File Upload","type":"post","updates":[],"user":"54d968913268702d007d9458","version":"54d2cbfd2ce0e00d007515ec","childrenPages":[]}

postSelfie and Signature Upload - File Upload


filename:
required
string
has to be exact: kioskselfie.boomset.com/<barcodeID>.png OR kiosksignature.boomset.com/<barcodeID>.png
eventId:
required
string
the ID of the event
file:
required
object
this should contain the file and the name of the file has to be <barcodeID>.png
[block:callout] { "type": "info", "body": "In this call, you have to send Multipart Form Data with No Parameters.\n\nYour form information is above adding a screenshot of an example call below", "title": "Warning, this endpoint accepts a Multiparm Form Data with NO Parameters" } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/jxnwuJMUQIGMmVgZn5Ur_Screen%20Shot%202016-01-26%20at%202.16.56%20AM.png", "Screen Shot 2016-01-26 at 2.16.56 AM.png", "1436", "368", "#72a8ef", "" ] } ] } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}


[block:callout] { "type": "info", "body": "In this call, you have to send Multipart Form Data with No Parameters.\n\nYour form information is above adding a screenshot of an example call below", "title": "Warning, this endpoint accepts a Multiparm Form Data with NO Parameters" } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/jxnwuJMUQIGMmVgZn5Ur_Screen%20Shot%202016-01-26%20at%202.16.56%20AM.png", "Screen Shot 2016-01-26 at 2.16.56 AM.png", "1436", "368", "#72a8ef", "" ] } ] } [/block]