{"_id":"5c237f84151c7d0019bffbda","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c237f4e6a53d00056a2d07e","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-12-26T13:17:56.562Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"token\": \"4f81fed8ec862793b0abb9318b2066c47439bb13\"\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5c23a42208d9e4000e39647b","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"username"},{"_id":"5c23a42208d9e4000e39647a","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"password"}],"url":"/apps/api/auth","examples":{"codes":[]},"method":"post"},"isReference":false,"order":0,"body":"The Boomset Public API allows you to integrate the Boomset solution to organize and customize your events. It's designed around [**Rest**](http://en.wikipedia.org/wiki/Representational_State_Transfer) with resource-oriented URLs, and uses HTTP response codes to indicate API errors.\n[block:api-header]\n{\n  \"title\": \"HTTP Status Code Summary\"\n}\n[/block]\nBoomset Public API uses conventional HTTP response codes to indicate the success or failure of an API request.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Status Code\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"200 - OK\",\n    \"0-1\": \"Request is valid and processed successfully.\",\n    \"1-0\": \"201 - OK\",\n    \"1-1\": \"Object created successfully.\",\n    \"2-0\": \"400 - Bad Request\",\n    \"2-1\": \"The request was unacceptable, often due to a missing required parameter.\",\n    \"3-0\": \"401 - Unauthorized\",\n    \"3-1\": \"No valid API Auth Token given.\",\n    \"4-0\": \"404 - Not Found\",\n    \"4-1\": \"The requested resource was not found.\",\n    \"5-0\": \"500, 502, 503, 504 - Server Errors\",\n    \"5-1\": \"Something went wrong on Boomset's end.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","excerpt":"","slug":"introduction-1","type":"basic","title":"Introduction","__v":5,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Introduction


The Boomset Public API allows you to integrate the Boomset solution to organize and customize your events. It's designed around [**Rest**](http://en.wikipedia.org/wiki/Representational_State_Transfer) with resource-oriented URLs, and uses HTTP response codes to indicate API errors. [block:api-header] { "title": "HTTP Status Code Summary" } [/block] Boomset Public API uses conventional HTTP response codes to indicate the success or failure of an API request. [block:parameters] { "data": { "h-0": "Status Code", "h-1": "Description", "0-0": "200 - OK", "0-1": "Request is valid and processed successfully.", "1-0": "201 - OK", "1-1": "Object created successfully.", "2-0": "400 - Bad Request", "2-1": "The request was unacceptable, often due to a missing required parameter.", "3-0": "401 - Unauthorized", "3-1": "No valid API Auth Token given.", "4-0": "404 - Not Found", "4-1": "The requested resource was not found.", "5-0": "500, 502, 503, 504 - Server Errors", "5-1": "Something went wrong on Boomset's end." }, "cols": 2, "rows": 6 } [/block]
The Boomset Public API allows you to integrate the Boomset solution to organize and customize your events. It's designed around [**Rest**](http://en.wikipedia.org/wiki/Representational_State_Transfer) with resource-oriented URLs, and uses HTTP response codes to indicate API errors. [block:api-header] { "title": "HTTP Status Code Summary" } [/block] Boomset Public API uses conventional HTTP response codes to indicate the success or failure of an API request. [block:parameters] { "data": { "h-0": "Status Code", "h-1": "Description", "0-0": "200 - OK", "0-1": "Request is valid and processed successfully.", "1-0": "201 - OK", "1-1": "Object created successfully.", "2-0": "400 - Bad Request", "2-1": "The request was unacceptable, often due to a missing required parameter.", "3-0": "401 - Unauthorized", "3-1": "No valid API Auth Token given.", "4-0": "404 - Not Found", "4-1": "The requested resource was not found.", "5-0": "500, 502, 503, 504 - Server Errors", "5-1": "Something went wrong on Boomset's end." }, "cols": 2, "rows": 6 } [/block]
{"_id":"5c23a50351ec1e001ff05975","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c23a4c900dba90051530856","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-12-26T15:57:55.012Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"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  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"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/v2.0/docs/login).\"\n}\n[/block]","excerpt":"","slug":"authentication","type":"basic","title":"Authentication","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"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" }, "cols": 2, "rows": 2 } [/block] [block:callout] { "type": "info", "body": "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/v2.0/docs/login)." } [/block]
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" }, "cols": 2, "rows": 2 } [/block] [block:callout] { "type": "info", "body": "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/v2.0/docs/login)." } [/block]
{"_id":"5c23a4a80511410031d69821","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c23a4c900dba90051530856","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-12-26T15:56:24.369Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"token\": \"4f81fed8ec862793b0abb9318b2066c47439bb13\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"never","params":[{"_id":"5c23a4a80511410031d69823","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"username"},{"_id":"5c23a4a80511410031d69822","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"password"}],"url":"/apps/api/auth"},"isReference":false,"order":1,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"With this endpoint you can login and retrieve your API key. With your key, you can authenticate all of your requests to the Boomset API. Alternatively, you may also retrieve your API key from your profile on the Boomset web platform.\",\n  \"title\": \"\"\n}\n[/block]","excerpt":"","slug":"login","type":"post","title":"Login","__v":5,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postLogin


Body Params

username:
required
string
password:
required
string
[block:callout] { "type": "info", "body": "With this endpoint you can login and retrieve your API key. With your key, you can authenticate all of your requests to the Boomset API. Alternatively, you may also retrieve your API key from your profile on the Boomset web platform.", "title": "" } [/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



[block:callout] { "type": "info", "body": "With this endpoint you can login and retrieve your API key. With your key, you can authenticate all of your requests to the Boomset API. Alternatively, you may also retrieve your API key from your profile on the Boomset web platform.", "title": "" } [/block]
{"_id":"5cb82cbb8183050024c4fe7b","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5ca5da0952feca0050276a63","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-18T07:52:27.897Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":"","method":"get"},"isReference":false,"order":0,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Field Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Field Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Yes\",\n    \"0-3\": \"Name of your group.\",\n    \"1-0\": \"email\",\n    \"1-1\": \"String\",\n    \"1-2\": \"No\",\n    \"1-3\": \"Contact email address for the company.\",\n    \"2-0\": \"phone\",\n    \"2-1\": \"String\",\n    \"2-2\": \"No\",\n    \"2-3\": \"Contact phone number.\",\n    \"3-0\": \"website\",\n    \"3-1\": \"String\",\n    \"3-2\": \"No\",\n    \"3-3\": \"Website if applicable for group.\",\n    \"4-0\": \"type\",\n    \"4-1\": \"String\",\n    \"4-2\": \"No\",\n    \"4-3\": \"Group type choice that used to describe group working area.\",\n    \"5-0\": \"parent_id\",\n    \"5-1\": \"Integer\",\n    \"5-2\": \"No\",\n    \"5-3\": \"Parent group id that used to link new sub group to main one.\"\n  },\n  \"cols\": 4,\n  \"rows\": 6\n}\n[/block]","excerpt":"","slug":"groups","type":"basic","title":"Groups","__v":0,"parentDoc":null,"updatedAt":"2019-07-09T12:18:21.764Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Groups


[block:parameters] { "data": { "h-0": "Field", "h-1": "Field Type", "h-2": "Required", "h-3": "Field Description", "0-0": "name", "0-1": "String", "0-2": "Yes", "0-3": "Name of your group.", "1-0": "email", "1-1": "String", "1-2": "No", "1-3": "Contact email address for the company.", "2-0": "phone", "2-1": "String", "2-2": "No", "2-3": "Contact phone number.", "3-0": "website", "3-1": "String", "3-2": "No", "3-3": "Website if applicable for group.", "4-0": "type", "4-1": "String", "4-2": "No", "4-3": "Group type choice that used to describe group working area.", "5-0": "parent_id", "5-1": "Integer", "5-2": "No", "5-3": "Parent group id that used to link new sub group to main one." }, "cols": 4, "rows": 6 } [/block]
[block:parameters] { "data": { "h-0": "Field", "h-1": "Field Type", "h-2": "Required", "h-3": "Field Description", "0-0": "name", "0-1": "String", "0-2": "Yes", "0-3": "Name of your group.", "1-0": "email", "1-1": "String", "1-2": "No", "1-3": "Contact email address for the company.", "2-0": "phone", "2-1": "String", "2-2": "No", "2-3": "Contact phone number.", "3-0": "website", "3-1": "String", "3-2": "No", "3-3": "Website if applicable for group.", "4-0": "type", "4-1": "String", "4-2": "No", "4-3": "Group type choice that used to describe group working area.", "5-0": "parent_id", "5-1": "Integer", "5-2": "No", "5-3": "Parent group id that used to link new sub group to main one." }, "cols": 4, "rows": 6 } [/block]
{"_id":"5ca5daa56f38be000eb30ef5","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5ca5da0952feca0050276a63","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-04T10:21:25.288Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"{\n\t\"name\": \"Boomset Group\",\n\t\"email\": \"developer@boomset.com\",\n\t\"phone\": \"1-860-266-6738\",\n\t\"website\": \"https://www.boomset.com\",\n\t\"parent_id\": \"\",\n\t\"type\": \"Conference\"\n}","language":"json"}]},"results":{"codes":[{"name":"","code":"{\n    \"id\": 1\n}","language":"json","status":201},{"name":"","code":"{}","language":"json","status":400}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5ca5dc8d614bdb0033e1204b","ref":"","in":"query","required":true,"desc":"Name of your group","default":"","type":"string","name":"name"},{"_id":"5ca5de18f8739500564b80d1","ref":"","in":"query","required":false,"desc":"Contact email address for the company","default":"","type":"string","name":"email"},{"_id":"5ca5de18f8739500564b80d0","ref":"","in":"query","required":false,"desc":"Contact phone number","default":"","type":"string","name":"phone"},{"_id":"5ca5de18f8739500564b80cf","ref":"","in":"query","required":false,"desc":"Website if applicable for group","default":"","type":"string","name":"website"},{"_id":"5cac8f553718b800325c5711","ref":"","in":"query","required":false,"desc":"Group type choices","default":"Event Planner","type":"string","name":"type"},{"_id":"5cac8f553718b800325c5710","ref":"","in":"query","required":false,"desc":"Parent group id that used to link new sub group to main one.","default":"","type":"int","name":"parent_id"}],"url":"/groups","method":"post"},"isReference":false,"order":1,"body":"This request allows you to define your group details on Boomset. In addition you are able to create sub-groups by setting `parent_id` while sending request.\n\nFollowings are used to define your group type. Default type of group is `Event Planner`.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Group Type\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Event Planner\",\n    \"1-0\": \"Charity / Fundraiser\",\n    \"2-0\": \"Gastronomy\",\n    \"3-0\": \"Venue\",\n    \"4-0\": \"Music Band\",\n    \"5-0\": \"Conference\",\n    \"6-0\": \"Sports\",\n    \"7-0\": \"Meetup\",\n    \"8-0\": \"Tech\",\n    \"9-0\": \"Corporate\",\n    \"10-0\": \"Promoter\"\n  },\n  \"cols\": 1,\n  \"rows\": 11\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Responses\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"detail\\\": \\\"Your session has expired. Please relogin\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"401 - unauthorized\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": [\\n        \\\"This field is required.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #1\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"type\\\": [\\n        \\\"Invalid type. Followings are valid: Conference, Event Planner, Venue, Promoter, Sports, Meetup, Gastronomy, Music Band, Tech, Corporate, Charity / Fundraiser\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #2\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"parent_id\\\": [\\n        \\\"Invalid parent_id.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #3\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"email\\\": [\\n        \\\"Enter a valid email address.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #4\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"create-group","type":"post","title":"Create Group","__v":24,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postCreate Group


Query Params

name:
required
string
Name of your group
email:
string
Contact email address for the company
phone:
string
Contact phone number
website:
string
Website if applicable for group
type:
stringEvent Planner
Group type choices
parent_id:
integer
Parent group id that used to link new sub group to main one.
This request allows you to define your group details on Boomset. In addition you are able to create sub-groups by setting `parent_id` while sending request. Followings are used to define your group type. Default type of group is `Event Planner`. [block:parameters] { "data": { "h-0": "Group Type", "h-1": "Description", "0-0": "Event Planner", "1-0": "Charity / Fundraiser", "2-0": "Gastronomy", "3-0": "Venue", "4-0": "Music Band", "5-0": "Conference", "6-0": "Sports", "7-0": "Meetup", "8-0": "Tech", "9-0": "Corporate", "10-0": "Promoter" }, "cols": 1, "rows": 11 } [/block] [block:api-header] { "title": "Responses" } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"type\": [\n \"Invalid type. Followings are valid: Conference, Event Planner, Venue, Promoter, Sports, Meetup, Gastronomy, Music Band, Tech, Corporate, Charity / Fundraiser\"\n ]\n}", "language": "json", "name": "400 - Bad Request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"parent_id\": [\n \"Invalid parent_id.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #3" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"email\": [\n \"Enter a valid email address.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #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 request allows you to define your group details on Boomset. In addition you are able to create sub-groups by setting `parent_id` while sending request. Followings are used to define your group type. Default type of group is `Event Planner`. [block:parameters] { "data": { "h-0": "Group Type", "h-1": "Description", "0-0": "Event Planner", "1-0": "Charity / Fundraiser", "2-0": "Gastronomy", "3-0": "Venue", "4-0": "Music Band", "5-0": "Conference", "6-0": "Sports", "7-0": "Meetup", "8-0": "Tech", "9-0": "Corporate", "10-0": "Promoter" }, "cols": 1, "rows": 11 } [/block] [block:api-header] { "title": "Responses" } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"type\": [\n \"Invalid type. Followings are valid: Conference, Event Planner, Venue, Promoter, Sports, Meetup, Gastronomy, Music Band, Tech, Corporate, Charity / Fundraiser\"\n ]\n}", "language": "json", "name": "400 - Bad Request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"parent_id\": [\n \"Invalid parent_id.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #3" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"email\": [\n \"Enter a valid email address.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #4" } ] } [/block]
{"_id":"5ca5e622661810003fca01a6","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5ca5da0952feca0050276a63","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-04T11:10:26.027Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[{"code":"{\n  \"name\": \"Boomset Group Update\",\n  \"email\": \"developer@boomset.com\",\n  \"phone\": \"1-860-266-6738\",\n  \"website\": \"https://www.boomset.com\",\n  \"parent_id\": \"1\",\n  \"type\": \"Venue\"\n}","language":"json","name":"update-group"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 1\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5ca5e7431ea898002cd9c73c","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"group_id"},{"_id":"5ca5e76e1a8cb10025a60325","ref":"","in":"query","required":false,"desc":"Name of your group","default":"","type":"string","name":"name"},{"_id":"5ca5e76e1a8cb10025a60323","ref":"","in":"query","required":false,"desc":"Contact email address for the company","default":"","type":"string","name":"email"},{"_id":"5ca5e76e1a8cb10025a60322","ref":"","in":"query","required":false,"desc":"Contact phone number","default":"","type":"string","name":"phone"},{"_id":"5ca5e76e1a8cb10025a60321","ref":"","in":"query","required":false,"desc":"Website if applicable for group","default":"","type":"string","name":"website"},{"_id":"5cbd7f704368e500142eb320","ref":"","in":"query","required":false,"desc":"Group type choices","default":"","type":"string","name":"type"},{"_id":"5cbd7f704368e500142eb31f","ref":"","in":"query","required":false,"desc":"Parent group id that used to link new sub group to main one.","default":"","type":"int","name":"parent_id"}],"url":"/groups/:group_id"},"isReference":false,"order":2,"body":"This request is used to update an group by defined `group_id` at url.","excerpt":"","slug":"update-group","type":"put","title":"Update Group","__v":14,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putUpdate Group


Path Params

group_id:
required
integer

Query Params

name:
string
Name of your group
email:
string
Contact email address for the company
phone:
string
Contact phone number
website:
string
Website if applicable for group
type:
string
Group type choices
parent_id:
integer
Parent group id that used to link new sub group to main one.
This request is used to update an group by defined `group_id` at url.

User Information

Try It Out

put
{{ 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 request is used to update an group by defined `group_id` at url.
{"_id":"5ca5df627b10eb0044897c90","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5ca5da0952feca0050276a63","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-04T10:41:38.521Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n    \"count\": 2,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 2,\n            \"name\": \"Last Boomset Group\",\n            \"email\": \"developer@boomset.com\",\n            \"phone\": \"1-860-266-6738\",\n            \"website\": \"https://www.boomset.com\",\n            \"type\": \"Conference\",\n            \"parent_id\": 1\n        },\n        {\n            \"id\": 1,\n            \"name\": \"First Boomset Group\",\n            \"email\": \"developer@boomset.com\",\n            \"phone\": \"1-860-266-6738\",\n            \"website\": \"https://www.boomset.com\",\n            \"type\": \"Conference\",\n            \"parent_id\": null\n        }\n    ],\n    \"next\": null\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5cb483a4499954025e64b6c8","ref":"","in":"query","required":false,"desc":"List sub groups according to parent group id.","default":"","type":"int","name":"parent_id"}],"url":"/groups"},"isReference":false,"order":3,"body":"This request is used to list paginated result for groups.","excerpt":"","slug":"list-of-groups","type":"get","title":"List of Groups","__v":8,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getList of Groups


Query Params

parent_id:
integer
List sub groups according to parent group id.
This request is used to list paginated result for groups.

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 request is used to list paginated result for groups.
{"_id":"5ca5e91852feca0050276bed","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5ca5da0952feca0050276a63","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-04T11:23:04.781Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": 2,\n    \"name\": \"Boomset Group\",\n    \"email\": \"developer@boomset.com\",\n    \"phone\": \"1-860-266-6738\",\n    \"website\": \"https://www.boomset.com\",\n    \"type\": \"Conference\",\n    \"parent_id\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5ca5e983f8739500564b820a","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"group_id"}],"url":"/groups/:group_id"},"isReference":false,"order":4,"body":"This request is used list details of unique group by defining `group_id` at url.","excerpt":"","slug":"group-detail","type":"get","title":"Group Detail","__v":7,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getGroup Detail


Path Params

group_id:
required
integer
This request is used list details of unique group by defining `group_id` at url.

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 request is used list details of unique group by defining `group_id` at url.
{"_id":"5cb82e6a7cdabc002a8375ce","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5ca5dfc64e227d0020ec6ae9","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-18T07:59:38.175Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Field Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Field Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Yes\",\n    \"0-3\": \"Name of event.\",\n    \"1-0\": \"starts\",\n    \"1-1\": \"Datetime\",\n    \"1-2\": \"Yes\",\n    \"1-3\": \"Event starts at in your timezone. eg. 2019-05-03T15:00\",\n    \"2-0\": \"ends\",\n    \"2-1\": \"Datetime\",\n    \"2-2\": \"Yes\",\n    \"2-3\": \"Event ends at in your timezone. eg. 2019-05-09T16:00\",\n    \"3-0\": \"timezone\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Yes\",\n    \"3-3\": \"Event's timezone this is based on the location of your event. eg.US/Hawaii\",\n    \"4-0\": \"group_id\",\n    \"4-1\": \"Integer\",\n    \"4-2\": \"Yes\",\n    \"4-3\": \"Points to the event's group.\"\n  },\n  \"cols\": 4,\n  \"rows\": 5\n}\n[/block]","excerpt":"","slug":"events","type":"basic","title":"Events","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Events


[block:parameters] { "data": { "h-0": "Field", "h-1": "Field Type", "h-2": "Required", "h-3": "Field Description", "0-0": "name", "0-1": "String", "0-2": "Yes", "0-3": "Name of event.", "1-0": "starts", "1-1": "Datetime", "1-2": "Yes", "1-3": "Event starts at in your timezone. eg. 2019-05-03T15:00", "2-0": "ends", "2-1": "Datetime", "2-2": "Yes", "2-3": "Event ends at in your timezone. eg. 2019-05-09T16:00", "3-0": "timezone", "3-1": "String", "3-2": "Yes", "3-3": "Event's timezone this is based on the location of your event. eg.US/Hawaii", "4-0": "group_id", "4-1": "Integer", "4-2": "Yes", "4-3": "Points to the event's group." }, "cols": 4, "rows": 5 } [/block]
[block:parameters] { "data": { "h-0": "Field", "h-1": "Field Type", "h-2": "Required", "h-3": "Field Description", "0-0": "name", "0-1": "String", "0-2": "Yes", "0-3": "Name of event.", "1-0": "starts", "1-1": "Datetime", "1-2": "Yes", "1-3": "Event starts at in your timezone. eg. 2019-05-03T15:00", "2-0": "ends", "2-1": "Datetime", "2-2": "Yes", "2-3": "Event ends at in your timezone. eg. 2019-05-09T16:00", "3-0": "timezone", "3-1": "String", "3-2": "Yes", "3-3": "Event's timezone this is based on the location of your event. eg.US/Hawaii", "4-0": "group_id", "4-1": "Integer", "4-2": "Yes", "4-3": "Points to the event's group." }, "cols": 4, "rows": 5 } [/block]
{"_id":"5ca5dfda7c1f8f004470aaff","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5ca5dfc64e227d0020ec6ae9","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-04T10:43:38.905Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"code":"{\n  \"name\": \"Boomset Test Event\",\n  \"group_id\": 1,\n  \"timezone\": \"US/Eastern\",\n  \"starts\": \"2019-05-03T15:00:00\",\n  \"ends\": \"2019-07-05T12:00:00\"\n}","language":"json","name":"create event"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"id\": 1\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5ca5e8a3614bdb0033e12190","ref":"","in":"body","required":true,"desc":"Name of event","default":"","type":"string","name":"name"},{"_id":"5ca5e8a3614bdb0033e1218f","ref":"","in":"body","required":true,"desc":"Event starts at in your timezone","default":"","type":"timestamp","name":"starts"},{"_id":"5ca5e8a3614bdb0033e1218e","ref":"","in":"body","required":true,"desc":"Event ends at in your timezone","default":"","type":"timestamp","name":"ends"},{"_id":"5ca5e8a3614bdb0033e1218d","ref":"","in":"body","required":true,"desc":"Event's timezone this is based on the location of your event","default":"","type":"string","name":"timezone"},{"_id":"5ca5ea64f8739500564b821b","ref":"","in":"body","required":true,"desc":"Points to the event's group","default":"","type":"int","name":"group_id"}],"url":"/events"},"isReference":false,"order":1,"body":"This request is used to create an event under a group by defining `group_id` in request data.\n\nFollowings are used to define event's timezone.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Timezone\",\n    \"0-0\": \"Pacific/Kwajalein\",\n    \"1-0\": \"Pacific/Midway\",\n    \"2-0\": \"US/Hawaii\",\n    \"3-0\": \"US/Alaska\",\n    \"4-0\": \"US/Pacific\",\n    \"5-0\": \"US/Mountain\",\n    \"6-0\": \"US/Central\",\n    \"7-0\": \"US/Eastern\",\n    \"8-0\": \"Atlantic/Bermuda\",\n    \"9-0\": \"America/Argentina/Buenos_Aires\",\n    \"10-0\": \"Atlantic/South_Georgia\",\n    \"11-0\": \"GMT\",\n    \"12-0\": \"Europe/London\",\n    \"13-0\": \"Europe/Amsterdam\",\n    \"14-0\": \"Europe/Belgrade\",\n    \"15-0\": \"Europe/Brussels\",\n    \"16-0\": \"Europe/Sarajevo\",\n    \"17-0\": \"Europe/Athens\",\n    \"18-0\": \"Europe/Moscow\",\n    \"19-0\": \"Asia/Tehran\",\n    \"20-0\": \"Asia/Baku\",\n    \"21-0\": \"Asia/Kabul\",\n    \"22-0\": \"Asia/Karachi\",\n    \"23-0\": \"Asia/Calcutta\",\n    \"24-0\": \"Asia/Kathmandu\",\n    \"25-0\": \"Asia/Almaty\",\n    \"26-0\": \"Asia/Rangoon\",\n    \"27-0\": \"Asia/Bangkok\",\n    \"28-0\": \"Asia/Singapore\",\n    \"29-0\": \"Asia/Tokyo\",\n    \"30-0\": \"Australia/Adelaide\",\n    \"31-0\": \"Australia/Brisbane\",\n    \"32-0\": \"Australia/Canberra\",\n    \"33-0\": \"Asia/Magadan\",\n    \"34-0\": \"Pacific/Fiji\",\n    \"35-0\": \"Pacific/Auckland\",\n    \"36-0\": \"Asia/Istanbul\",\n    \"37-0\": \"US/Arizona\"\n  },\n  \"cols\": 1,\n  \"rows\": 38\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Responses\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"detail\\\": \\\"Your session has expired. Please relogin\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"401 - unauthorized\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": [\\n        \\\"This field is required.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #1\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"details\\\": \\\"Group not found.\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #2\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"timezone\\\": [\\n        \\\"Invalid timezone. Followings are valid: Asia/Tokyo, Asia/Karachi, Asia/Calcutta, Atlantic/South_Georgia, Europe/London, Asia/Magadan, Asia/Istanbul, Australia/Canberra, Europe/Amsterdam, Atlantic/Bermuda, US/Pacific, Asia/Tehran, Asia/Baku, Asia/Bangkok, US/Mountain, Asia/Almaty, Europe/Moscow, Australia/Brisbane, Europe/Belgrade, US/Hawaii, Asia/Kathmandu, Pacific/Kwajalein, America/Argentina/Buenos_Aires, US/Eastern, US/Central, Asia/Singapore, Pacific/Fiji, Asia/Kabul, GMT, Australia/Adelaide, Europe/Brussels, Europe/Athens, Asia/Rangoon, US/Arizona, Atlantic/Azores, Pacific/Auckland, Pacific/Midway, Europe/Sarajevo, US/Alaska\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #3\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"starts\\\": [\\n        \\\"Datetime has wrong format. Use one of these formats instead: YYYY-MM-DDThh:mm\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #4\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"ends\\\": [\\n        \\\"Datetime has wrong format. Use one of these formats instead: YYYY-MM-DDThh:mm\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #5\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"create-event","type":"post","title":"Create Event","__v":22,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postCreate Event


Body Params

name:
required
string
Name of event
starts:
required
timestamp
Event starts at in your timezone
ends:
required
timestamp
Event ends at in your timezone
timezone:
required
string
Event's timezone this is based on the location of your event
group_id:
required
integer
Points to the event's group
This request is used to create an event under a group by defining `group_id` in request data. Followings are used to define event's timezone. [block:parameters] { "data": { "h-0": "Timezone", "0-0": "Pacific/Kwajalein", "1-0": "Pacific/Midway", "2-0": "US/Hawaii", "3-0": "US/Alaska", "4-0": "US/Pacific", "5-0": "US/Mountain", "6-0": "US/Central", "7-0": "US/Eastern", "8-0": "Atlantic/Bermuda", "9-0": "America/Argentina/Buenos_Aires", "10-0": "Atlantic/South_Georgia", "11-0": "GMT", "12-0": "Europe/London", "13-0": "Europe/Amsterdam", "14-0": "Europe/Belgrade", "15-0": "Europe/Brussels", "16-0": "Europe/Sarajevo", "17-0": "Europe/Athens", "18-0": "Europe/Moscow", "19-0": "Asia/Tehran", "20-0": "Asia/Baku", "21-0": "Asia/Kabul", "22-0": "Asia/Karachi", "23-0": "Asia/Calcutta", "24-0": "Asia/Kathmandu", "25-0": "Asia/Almaty", "26-0": "Asia/Rangoon", "27-0": "Asia/Bangkok", "28-0": "Asia/Singapore", "29-0": "Asia/Tokyo", "30-0": "Australia/Adelaide", "31-0": "Australia/Brisbane", "32-0": "Australia/Canberra", "33-0": "Asia/Magadan", "34-0": "Pacific/Fiji", "35-0": "Pacific/Auckland", "36-0": "Asia/Istanbul", "37-0": "US/Arizona" }, "cols": 1, "rows": 38 } [/block] [block:api-header] { "title": "Responses" } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"details\": \"Group not found.\"\n}", "language": "json", "name": "400 - Bad Request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"timezone\": [\n \"Invalid timezone. Followings are valid: Asia/Tokyo, Asia/Karachi, Asia/Calcutta, Atlantic/South_Georgia, Europe/London, Asia/Magadan, Asia/Istanbul, Australia/Canberra, Europe/Amsterdam, Atlantic/Bermuda, US/Pacific, Asia/Tehran, Asia/Baku, Asia/Bangkok, US/Mountain, Asia/Almaty, Europe/Moscow, Australia/Brisbane, Europe/Belgrade, US/Hawaii, Asia/Kathmandu, Pacific/Kwajalein, America/Argentina/Buenos_Aires, US/Eastern, US/Central, Asia/Singapore, Pacific/Fiji, Asia/Kabul, GMT, Australia/Adelaide, Europe/Brussels, Europe/Athens, Asia/Rangoon, US/Arizona, Atlantic/Azores, Pacific/Auckland, Pacific/Midway, Europe/Sarajevo, US/Alaska\"\n ]\n}", "language": "json", "name": "400 - Bad Request #3" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"starts\": [\n \"Datetime has wrong format. Use one of these formats instead: YYYY-MM-DDThh:mm\"\n ]\n}", "language": "json", "name": "400 - Bad Request #4" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"ends\": [\n \"Datetime has wrong format. Use one of these formats instead: YYYY-MM-DDThh:mm\"\n ]\n}", "language": "json", "name": "400 - Bad Request #5" } ] } [/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 request is used to create an event under a group by defining `group_id` in request data. Followings are used to define event's timezone. [block:parameters] { "data": { "h-0": "Timezone", "0-0": "Pacific/Kwajalein", "1-0": "Pacific/Midway", "2-0": "US/Hawaii", "3-0": "US/Alaska", "4-0": "US/Pacific", "5-0": "US/Mountain", "6-0": "US/Central", "7-0": "US/Eastern", "8-0": "Atlantic/Bermuda", "9-0": "America/Argentina/Buenos_Aires", "10-0": "Atlantic/South_Georgia", "11-0": "GMT", "12-0": "Europe/London", "13-0": "Europe/Amsterdam", "14-0": "Europe/Belgrade", "15-0": "Europe/Brussels", "16-0": "Europe/Sarajevo", "17-0": "Europe/Athens", "18-0": "Europe/Moscow", "19-0": "Asia/Tehran", "20-0": "Asia/Baku", "21-0": "Asia/Kabul", "22-0": "Asia/Karachi", "23-0": "Asia/Calcutta", "24-0": "Asia/Kathmandu", "25-0": "Asia/Almaty", "26-0": "Asia/Rangoon", "27-0": "Asia/Bangkok", "28-0": "Asia/Singapore", "29-0": "Asia/Tokyo", "30-0": "Australia/Adelaide", "31-0": "Australia/Brisbane", "32-0": "Australia/Canberra", "33-0": "Asia/Magadan", "34-0": "Pacific/Fiji", "35-0": "Pacific/Auckland", "36-0": "Asia/Istanbul", "37-0": "US/Arizona" }, "cols": 1, "rows": 38 } [/block] [block:api-header] { "title": "Responses" } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"details\": \"Group not found.\"\n}", "language": "json", "name": "400 - Bad Request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"timezone\": [\n \"Invalid timezone. Followings are valid: Asia/Tokyo, Asia/Karachi, Asia/Calcutta, Atlantic/South_Georgia, Europe/London, Asia/Magadan, Asia/Istanbul, Australia/Canberra, Europe/Amsterdam, Atlantic/Bermuda, US/Pacific, Asia/Tehran, Asia/Baku, Asia/Bangkok, US/Mountain, Asia/Almaty, Europe/Moscow, Australia/Brisbane, Europe/Belgrade, US/Hawaii, Asia/Kathmandu, Pacific/Kwajalein, America/Argentina/Buenos_Aires, US/Eastern, US/Central, Asia/Singapore, Pacific/Fiji, Asia/Kabul, GMT, Australia/Adelaide, Europe/Brussels, Europe/Athens, Asia/Rangoon, US/Arizona, Atlantic/Azores, Pacific/Auckland, Pacific/Midway, Europe/Sarajevo, US/Alaska\"\n ]\n}", "language": "json", "name": "400 - Bad Request #3" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"starts\": [\n \"Datetime has wrong format. Use one of these formats instead: YYYY-MM-DDThh:mm\"\n ]\n}", "language": "json", "name": "400 - Bad Request #4" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"ends\": [\n \"Datetime has wrong format. Use one of these formats instead: YYYY-MM-DDThh:mm\"\n ]\n}", "language": "json", "name": "400 - Bad Request #5" } ] } [/block]
{"_id":"5ca5e6624e227d0020ec6b90","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5ca5dfc64e227d0020ec6ae9","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-04T11:11:30.828Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[{"name":"update event","language":"json","code":"{\n  \"name\": \"Boomset Test Update\",\n  \"group_id\": 1,\n  \"timezone\": \"Asia/Istanbul\",\n  \"starts\": \"2019-05-03T15:00:00\",\n  \"ends\": \"2019-07-05T12:00:00\"\n}"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 1\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5ca5eb8b3c3edb00337b2025","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"event_id"}],"url":"/events/:event_id"},"isReference":false,"order":2,"body":"","excerpt":"","slug":"update-event","type":"put","title":"Update Event","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putUpdate Event


Path Params

event_id:
required
integer

User Information

Try It Out

put
{{ 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



{"_id":"5ca5dfed731f7200135f7869","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5ca5dfc64e227d0020ec6ae9","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-04T10:43:57.191Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"count\": 1,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 1,\n            \"name\": \"Boomset Test Update\",\n            \"group_id\": 1,\n            \"timezone\": \"Asia/Istanbul\",\n            \"starts\": \"2019-05-03T15:00:00\",\n            \"ends\": \"2019-07-05T12:00:00\"\n        }\n    ],\n    \"next\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5ca5eb164cb5c3004a344ad1","ref":"","in":"query","required":true,"desc":"","default":"","type":"int","name":"group_id"}],"url":"/events"},"isReference":false,"order":3,"body":"","excerpt":"","slug":"list-of-events","type":"get","title":"List of Events","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getList of Events


Query Params

group_id:
required
integer

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



{"_id":"5cb4855dc606540014828d61","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5ca5dfc64e227d0020ec6ae9","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-15T13:21:33.558Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"5c4062101d67d6001477c60a","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 1,\n  \"name\": \"Boomset Test Update\",\n  \"group_id\": 1,\n  \"timezone\": \"Asia/Istanbul\",\n  \"starts\": \"2019-05-03T15:00:00\",\n  \"ends\": \"2019-07-05T12:00:00\"\n}","name":"event detail"},{"status":400,"language":"json","code":"{}","name":""}]},"examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":"/events/:event_id"},"isReference":false,"order":4,"body":"","excerpt":"","slug":"event-detail","type":"get","title":"Event Detail","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getEvent Detail



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



{"_id":"5d08ed16d18693005d83a3f3","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5ca5dfc64e227d0020ec6ae9","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-18T13:54:30.236Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"5c4062101d67d6001477c60a","results":{"codes":[{"name":"","code":"{\n  \"details\": \"We got your request, shortly you will receive an email\"\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"examples":{"codes":[{"name":"duplicate event","language":"json","code":"{\n  \"quantity\": 1\n}"}]},"method":"post","auth":"required","params":[{"_id":"5ca5e8a3614bdb0033e12190","ref":"","in":"body","required":false,"desc":"The number of how many you want to duplicate this event","default":"1","type":"int","name":"quantity"}],"url":"/events/:event_id/duplicate_event"},"isReference":false,"order":5,"body":"This request is used to duplicate an event. Quantity parameter is to help consider the number of the event you want to duplicate.\n\nSystem sends an information email after the duplication process ends successfully. \n[block:api-header]\n{\n  \"title\": \"Responses\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"detail\\\": \\\"Your session has expired. Please relogin\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"401 - unauthorized\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"detail\\\": \\\"Event not found.\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"404 - not found\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"duplicate-event","type":"post","title":"Duplicate Event","__v":6,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postDuplicate Event


Body Params

quantity:
integer1
The number of how many you want to duplicate this event
This request is used to duplicate an event. Quantity parameter is to help consider the number of the event you want to duplicate. System sends an information email after the duplication process ends successfully. [block:api-header] { "title": "Responses" } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Event not found.\"\n}", "language": "json", "name": "404 - not found" } ] } [/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 request is used to duplicate an event. Quantity parameter is to help consider the number of the event you want to duplicate. System sends an information email after the duplication process ends successfully. [block:api-header] { "title": "Responses" } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Event not found.\"\n}", "language": "json", "name": "404 - not found" } ] } [/block]
{"_id":"5c2f4f42385758001f1669be","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c2f548019bd8f004be2df9b","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-04T12:19:14.362Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"code":"{\n    \"type\": \"ticket\",\n    \"name\": \"Registration type for test\",\n    \"starts\": \"2019-10-22T18:17\",\n    \"ends\": \"2019-10-22T18:17\",\n    \"minorder\": 1,\n    \"maxorder\": 20,\n    \"quantity\": 120,\n    \"price\": \"0\",\n    \"door\": true,\n    \"online\": true,\n    \"description\": \"Example description\"\n}","language":"json","name":null}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n    \"id\": 172\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5c2f562f6d5f4a0168e6016f","ref":"","in":"path","required":true,"desc":"Event ID","default":"","type":"int","name":"event_id"},{"_id":"5c2f4f42385758001f1669cd","ref":"","in":"body","required":true,"desc":"'donation', 'ticket'","default":"'ticket'","type":"string","name":"type"},{"_id":"5c2f4f42385758001f1669cc","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"name"},{"_id":"5c2f4f42385758001f1669c2","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"description"},{"_id":"5c2f4f42385758001f1669ca","ref":"","in":"body","required":false,"desc":"Accepts %Y-%m-%dT%H:%M format","default":"","type":"datetime","name":"starts"},{"_id":"5c2f4f42385758001f1669c9","ref":"","in":"body","required":false,"desc":"Accepts %Y-%m-%dT%H:%M format","default":"","type":"datetime","name":"ends"},{"_id":"5c2f4f42385758001f1669c6","ref":"","in":"body","required":false,"desc":"Minimum purchase","default":"","type":"int","name":"minorder"},{"_id":"5c2f4f42385758001f1669c5","ref":"","in":"body","required":false,"desc":"Maximum purchase","default":"","type":"int","name":"maxorder"},{"_id":"5c2f4f42385758001f1669c4","ref":"","in":"body","required":false,"desc":"","default":"","type":"float","name":"price"},{"_id":"5c2f4f42385758001f1669c3","ref":"","in":"body","required":false,"desc":"Registration capacity","default":"","type":"int","name":"quantity"},{"_id":"5c2f501b5503e9003017bdc8","ref":"","in":"body","required":false,"desc":"Boolean for door sales","default":"","type":"boolean","name":"door"},{"_id":"5c2f501b5503e9003017bdc7","ref":"","in":"body","required":false,"desc":"Boolean for online sales","default":"","type":"boolean","name":"online"}],"url":"/events/:event_id/registration_types"},"isReference":false,"order":0,"body":"This request is used to create a registration type for an [event](https://boomset-public-api.readme.io/docs/listing-events). Registration types are needed for adding [attendees](https://boomset-public-api.readme.io/docs/listing-attendees).\n[block:api-header]\n{\n  \"title\": \"Responses\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"detail\\\": \\\"Your session has expired. Please relogin\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"401 - unauthorized\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"type\\\": [\\n        \\\"This field is required.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #1\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": [\\n        \\\"This field is required.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #2\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": [\\n        \\\"This field may not be blank.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #3\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"description\\\": [\\n        \\\"This field is required.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #4\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"details\\\": [\\n        \\\"Error while creating registration type due to data integrity.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #5\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"add-reservation-type","type":"post","title":"Add Registration Type","__v":38,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postAdd Registration Type


Path Params

event_id:
required
integer
Event ID

Body Params

type:
required
string'ticket'
'donation', 'ticket'
name:
required
string
description:
required
string
starts:
datetime
Accepts %Y-%m-%dT%H:%M format
ends:
datetime
Accepts %Y-%m-%dT%H:%M format
minorder:
integer
Minimum purchase
maxorder:
integer
Maximum purchase
price:
float
quantity:
integer
Registration capacity
door:
boolean
Boolean for door sales
online:
boolean
Boolean for online sales
This request is used to create a registration type for an [event](https://boomset-public-api.readme.io/docs/listing-events). Registration types are needed for adding [attendees](https://boomset-public-api.readme.io/docs/listing-attendees). [block:api-header] { "title": "Responses" } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"type\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": [\n \"This field may not be blank.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #3" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"description\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #4" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"details\": [\n \"Error while creating registration type due to data integrity.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #5" } ] } [/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 request is used to create a registration type for an [event](https://boomset-public-api.readme.io/docs/listing-events). Registration types are needed for adding [attendees](https://boomset-public-api.readme.io/docs/listing-attendees). [block:api-header] { "title": "Responses" } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"type\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": [\n \"This field may not be blank.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #3" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"description\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #4" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"details\": [\n \"Error while creating registration type due to data integrity.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #5" } ] } [/block]
{"_id":"5c2f6f2e300f3c0057294db7","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c2f548019bd8f004be2df9b","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-04T14:35:26.261Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n    \"id\": 161,\n    \"event\": 1,\n    \"minorder\": 1,\n    \"maxorder\": 20,\n    \"starts\": \"2019-10-22T18:17:00\",\n    \"ends\": \"2019-10-22T18:17:00\",\n    \"price\": \"0.00\",\n    \"source\": \"api\",\n    \"type\": \"ticket\",\n    \"created\": \"2019-01-09T07:26:04\",\n    \"objstatus\": \"1\",\n    \"name\": \"Registration type for test 2\",\n    \"description\": \"Example description\",\n    \"quantity\": 140,\n    \"online\": true,\n    \"door\": true\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5c2f71a1e8ab14003fcb8aa2","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"event_id"},{"_id":"5c2f71a1e8ab14003fcb8aa1","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"registration_type_id"}],"url":"/events/:event_id/registration_types/:registration_type_id"},"isReference":false,"order":1,"body":"This request is used to get details on a registration type for an event.\n[block:api-header]\n{\n  \"title\": \"Responses\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 159,\\n    \\\"event\\\": 1,\\n    \\\"minorder\\\": 1,\\n    \\\"maxorder\\\": 20,\\n    \\\"starts\\\": \\\"2019-10-22T18:17\\\",\\n    \\\"ends\\\": \\\"2019-10-22T18:17\\\",\\n    \\\"price\\\": \\\"0.00\\\",\\n    \\\"source\\\": \\\"api\\\",\\n    \\\"type\\\": \\\"ticket\\\",\\n    \\\"created\\\": \\\"2019-01-08T14:00:42.991436\\\",\\n    \\\"objstatus\\\": \\\"1\\\",\\n    \\\"name\\\": \\\"registration type for test\\\",\\n    \\\"description\\\": \\\"Example description\\\",\\n    \\\"quantity\\\": 120,\\n    \\\"online\\\": true,\\n    \\\"door\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 - OK\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"details\\\": \\\"Registration type not found.\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"404 - Not found\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"reservation-type-detail","type":"get","title":"Registration Type Detail","__v":13,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRegistration Type Detail


Path Params

event_id:
required
integer
registration_type_id:
required
integer
This request is used to get details on a registration type for an event. [block:api-header] { "title": "Responses" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": 159,\n \"event\": 1,\n \"minorder\": 1,\n \"maxorder\": 20,\n \"starts\": \"2019-10-22T18:17\",\n \"ends\": \"2019-10-22T18:17\",\n \"price\": \"0.00\",\n \"source\": \"api\",\n \"type\": \"ticket\",\n \"created\": \"2019-01-08T14:00:42.991436\",\n \"objstatus\": \"1\",\n \"name\": \"registration type for test\",\n \"description\": \"Example description\",\n \"quantity\": 120,\n \"online\": true,\n \"door\": true\n}", "language": "json", "name": "200 - OK" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"details\": \"Registration type not found.\"\n}", "language": "json", "name": "404 - Not found" } ] } [/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 request is used to get details on a registration type for an event. [block:api-header] { "title": "Responses" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": 159,\n \"event\": 1,\n \"minorder\": 1,\n \"maxorder\": 20,\n \"starts\": \"2019-10-22T18:17\",\n \"ends\": \"2019-10-22T18:17\",\n \"price\": \"0.00\",\n \"source\": \"api\",\n \"type\": \"ticket\",\n \"created\": \"2019-01-08T14:00:42.991436\",\n \"objstatus\": \"1\",\n \"name\": \"registration type for test\",\n \"description\": \"Example description\",\n \"quantity\": 120,\n \"online\": true,\n \"door\": true\n}", "language": "json", "name": "200 - OK" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"details\": \"Registration type not found.\"\n}", "language": "json", "name": "404 - Not found" } ] } [/block]
{"_id":"5c2f790a873ada003fb91b09","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c2f548019bd8f004be2df9b","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-04T15:17:30.650Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n    \"count\": 3,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 160,\n            \"event\": 1,\n            \"minorder\": 1,\n            \"maxorder\": 20,\n            \"starts\": \"2019-10-22T18:17:00\",\n            \"ends\": \"2019-10-22T18:17:00\",\n            \"price\": \"0.00\",\n            \"source\": \"api\",\n            \"type\": \"ticket\",\n            \"created\": \"2019-01-09T07:25:51\",\n            \"objstatus\": \"1\",\n            \"name\": \"Registration type for test 1\",\n            \"description\": \"Example description\",\n            \"quantity\": 120,\n            \"online\": true,\n            \"door\": true\n        },\n        {\n            \"id\": 161,\n            \"event\": 1,\n            \"minorder\": 1,\n            \"maxorder\": 20,\n            \"starts\": \"2019-10-22T18:17:00\",\n            \"ends\": \"2019-10-22T18:17:00\",\n            \"price\": \"0.00\",\n            \"source\": \"api\",\n            \"type\": \"ticket\",\n            \"created\": \"2019-01-09T07:26:04\",\n            \"objstatus\": \"1\",\n            \"name\": \"Registration type for test 2\",\n            \"description\": \"Example description\",\n            \"quantity\": 140,\n            \"online\": true,\n            \"door\": true\n        },\n        {\n            \"id\": 162,\n            \"event\": 1,\n            \"minorder\": 1,\n            \"maxorder\": 20,\n            \"starts\": \"2019-10-22T18:17:00\",\n            \"ends\": \"2019-10-22T18:17:00\",\n            \"price\": \"0.00\",\n            \"source\": \"api\",\n            \"type\": \"ticket\",\n            \"created\": \"2019-01-09T07:26:13\",\n            \"objstatus\": \"1\",\n            \"name\": \"Registration type for test 3\",\n            \"description\": \"Example description\",\n            \"quantity\": 150,\n            \"online\": true,\n            \"door\": true\n        }\n    ],\n    \"next\": null\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5c2f790a873ada003fb91b0d","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"event_id"},{"_id":"5c2f790a873ada003fb91b0c","ref":"","in":"query","required":false,"desc":"","default":"","type":"int","name":"page"},{"_id":"5c2f790a873ada003fb91b0b","ref":"","in":"query","required":false,"desc":"max 1000","default":"250","type":"int","name":"page_size"},{"_id":"5c2f790a873ada003fb91b0a","ref":"","in":"query","required":false,"desc":"last page's start_time key","default":"","type":"timestamp","name":"timestamp"},{"_id":"5c4239820bd7200043b4db9d","ref":"","in":"header","required":true,"desc":"","default":"Token <key>","type":"string","name":"Authorization"}],"url":"/events/:event_id/registration_types/"},"isReference":false,"order":2,"body":"","excerpt":"","slug":"reservation-type-list","type":"get","title":"Registration Type List","__v":11,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getRegistration Type List


Path Params

event_id:
required
integer

Query Params

page:
integer
page_size:
integer250
max 1000
timestamp:
timestamp
last page's start_time key

Headers

Authorization:
required
stringToken <key>

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



{"_id":"5c389e515b72f500563e36a7","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c2f558026e61400f9125bcd","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-11T13:46:57.300Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Field Type\",\n    \"h-2\": \"Required?\",\n    \"h-3\": \"Field Description\",\n    \"0-0\": \"question\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Yes\",\n    \"0-3\": \"Question or field that you want answer options for\",\n    \"1-0\": \"type\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Yes\",\n    \"1-3\": \"Question type can be one of the following;\\n  * text\\n  * dropdown\\n  * radio\\n  * checkbox\",\n    \"2-0\": \"choices\",\n    \"2-1\": \"List of Objects\",\n    \"2-2\": \"No\",\n    \"2-3\": \"If your question is one of the following types: dropdown, radio buttons, or checkbox, then question must have a set of answer options.\\nIf your question is answerable with a text field, then there is no need for answer options in request data.\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]","excerpt":"Custom Questions are used when a field does not match/map to a default field in Boomset.","slug":"custom-questions","type":"basic","title":"Custom Questions","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Custom Questions

Custom Questions are used when a field does not match/map to a default field in Boomset.

[block:parameters] { "data": { "h-0": "Field", "h-1": "Field Type", "h-2": "Required?", "h-3": "Field Description", "0-0": "question", "0-1": "String", "0-2": "Yes", "0-3": "Question or field that you want answer options for", "1-0": "type", "1-1": "String", "1-2": "Yes", "1-3": "Question type can be one of the following;\n * text\n * dropdown\n * radio\n * checkbox", "2-0": "choices", "2-1": "List of Objects", "2-2": "No", "2-3": "If your question is one of the following types: dropdown, radio buttons, or checkbox, then question must have a set of answer options.\nIf your question is answerable with a text field, then there is no need for answer options in request data." }, "cols": 4, "rows": 3 } [/block]
[block:parameters] { "data": { "h-0": "Field", "h-1": "Field Type", "h-2": "Required?", "h-3": "Field Description", "0-0": "question", "0-1": "String", "0-2": "Yes", "0-3": "Question or field that you want answer options for", "1-0": "type", "1-1": "String", "1-2": "Yes", "1-3": "Question type can be one of the following;\n * text\n * dropdown\n * radio\n * checkbox", "2-0": "choices", "2-1": "List of Objects", "2-2": "No", "2-3": "If your question is one of the following types: dropdown, radio buttons, or checkbox, then question must have a set of answer options.\nIf your question is answerable with a text field, then there is no need for answer options in request data." }, "cols": 4, "rows": 3 } [/block]
{"_id":"5c35cb7e99fe2f00105eaf51","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c2f558026e61400f9125bcd","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-09T10:22:54.411Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"name":"add_custom_question","language":"json","code":"{\n    \"question\": \"What is your favorite animal?\",\n    \"type\": \"checkbox\",\n    \"choices\": [\n        {\n            \"answer\": \"cat\"\n        },\n        {\n            \"answer\": \"dog\"\n        }\n    ]\n}"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n    \"id\": 78,\n    \"question\": \"What is your favorite animal?\",\n    \"type\": \"checkbox\",\n    \"choices\": [\n        {\n            \"answer\": \"cat\",\n            \"id\": 43\n        },\n        {\n            \"answer\": \"dog\",\n            \"id\": 44\n        }\n    ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5c35cd494fbe0300575e742a","ref":"","in":"body","required":true,"desc":"Question asked to guest.","default":"","type":"string","name":"question"},{"_id":"5c35cd494fbe0300575e7429","ref":"","in":"body","required":true,"desc":"Type of question. It can be text or multiple choices.","default":"","type":"string","name":"type"},{"_id":"5c35cd494fbe0300575e7428","ref":"","in":"body","required":false,"desc":"Default answer alternatives.","default":"","type":"array_object","name":"choices"}],"url":"/events/:event_id/custom_questions"},"isReference":false,"order":1,"body":"The following are used to add custom question type.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"type\",\n    \"h-1\": \"description\",\n    \"0-0\": \"text\",\n    \"0-1\": \"Text based questions.\",\n    \"1-0\": \"radio\",\n    \"1-1\": \"Used for multiple choices but allows only one selection.\",\n    \"2-0\": \"drop_down\",\n    \"2-1\": \"Used for multiple choices but allows only one selection.\",\n    \"3-0\": \"checkbox\",\n    \"3-1\": \"Used for multiple choices and allows to multiple selections.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Responses\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"detail\\\": \\\"Your session has expired. Please relogin\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"401 - unauthorized\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"type\\\": [\\n        \\\"Invalid type. Please use following one : checkbox, text, drop_down, radio\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad request #1\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"details\\\": [\\n        \\\"Following types require choices : dropdown, checkbox, radio\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad request #2\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"question\\\": [\\n        \\\"This field is required.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad request #3\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"add-custom-question","type":"post","title":"Add Custom Question","__v":17,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postAdd Custom Question


Body Params

question:
required
string
Question asked to guest.
type:
required
string
Type of question. It can be text or multiple choices.
choices:
array of objects
Default answer alternatives.
The following are used to add custom question type. [block:parameters] { "data": { "h-0": "type", "h-1": "description", "0-0": "text", "0-1": "Text based questions.", "1-0": "radio", "1-1": "Used for multiple choices but allows only one selection.", "2-0": "drop_down", "2-1": "Used for multiple choices but allows only one selection.", "3-0": "checkbox", "3-1": "Used for multiple choices and allows to multiple selections." }, "cols": 2, "rows": 4 } [/block] [block:api-header] { "title": "Responses" } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"type\": [\n \"Invalid type. Please use following one : checkbox, text, drop_down, radio\"\n ]\n}", "language": "json", "name": "400 - Bad request #1" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"details\": [\n \"Following types require choices : dropdown, checkbox, radio\"\n ]\n}", "language": "json", "name": "400 - Bad request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"question\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad request #3" } ] } [/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



The following are used to add custom question type. [block:parameters] { "data": { "h-0": "type", "h-1": "description", "0-0": "text", "0-1": "Text based questions.", "1-0": "radio", "1-1": "Used for multiple choices but allows only one selection.", "2-0": "drop_down", "2-1": "Used for multiple choices but allows only one selection.", "3-0": "checkbox", "3-1": "Used for multiple choices and allows to multiple selections." }, "cols": 2, "rows": 4 } [/block] [block:api-header] { "title": "Responses" } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"type\": [\n \"Invalid type. Please use following one : checkbox, text, drop_down, radio\"\n ]\n}", "language": "json", "name": "400 - Bad request #1" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"details\": [\n \"Following types require choices : dropdown, checkbox, radio\"\n ]\n}", "language": "json", "name": "400 - Bad request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"question\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad request #3" } ] } [/block]
{"_id":"5c35ce4841e6ac001a07f828","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c2f558026e61400f9125bcd","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-09T10:34:48.931Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": 78,\n    \"question\": \"What is your favorite animal?\",\n    \"type\": \"checkbox\",\n    \"choices\": [\n        {\n            \"answer\": \"cat\",\n            \"id\": 43\n        },\n        {\n            \"answer\": \"dog\",\n            \"id\": 44\n        }\n    ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5c35e42d1b89e4083290037a","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"event_id"},{"_id":"5c35e42d1b89e40832900379","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"custom_question_id"}],"url":"/events/:event_id/custom_questions/:custom_question_id"},"isReference":false,"order":2,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 80,\\n    \\\"question\\\": \\\"What is your favorite furite ?\\\",\\n    \\\"type\\\": \\\"radio\\\",\\n    \\\"choices\\\": [\\n        {\\n            \\\"answer\\\": \\\"apple\\\",\\n            \\\"id\\\": 45\\n        },\\n        {\\n            \\\"answer\\\": \\\"orange\\\",\\n            \\\"id\\\": 46\\n        },\\n        {\\n            \\\"answer\\\": \\\"watermelon\\\",\\n            \\\"id\\\": 47\\n        }\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 - OK\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"details\\\": \\\"Custom question not found.\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"404 - Not found\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"custom-question-detail","type":"get","title":"Custom Question Detail","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getCustom Question Detail


Path Params

event_id:
required
integer
custom_question_id:
required
string
[block:code] { "codes": [ { "code": "{\n \"id\": 80,\n \"question\": \"What is your favorite furite ?\",\n \"type\": \"radio\",\n \"choices\": [\n {\n \"answer\": \"apple\",\n \"id\": 45\n },\n {\n \"answer\": \"orange\",\n \"id\": 46\n },\n {\n \"answer\": \"watermelon\",\n \"id\": 47\n }\n ]\n}", "language": "json", "name": "200 - OK" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"details\": \"Custom question not found.\"\n}", "language": "json", "name": "404 - Not found" } ] } [/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



[block:code] { "codes": [ { "code": "{\n \"id\": 80,\n \"question\": \"What is your favorite furite ?\",\n \"type\": \"radio\",\n \"choices\": [\n {\n \"answer\": \"apple\",\n \"id\": 45\n },\n {\n \"answer\": \"orange\",\n \"id\": 46\n },\n {\n \"answer\": \"watermelon\",\n \"id\": 47\n }\n ]\n}", "language": "json", "name": "200 - OK" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"details\": \"Custom question not found.\"\n}", "language": "json", "name": "404 - Not found" } ] } [/block]
{"_id":"5c35e3681b89e40832900376","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c2f558026e61400f9125bcd","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-09T12:04:56.385Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"count\": 4,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 78,\n            \"question\": \"What is your favorite animal?\",\n            \"type\": \"checkbox\",\n            \"choices\": [\n                {\n                    \"answer\": \"cat\",\n                    \"id\": 43\n                },\n                {\n                    \"answer\": \"dog\",\n                    \"id\": 44\n                }\n            ]\n        },\n        {\n            \"id\": 79,\n            \"question\": \"What is your pet's name ?\",\n            \"type\": \"text\",\n            \"choices\": []\n        },\n        {\n            \"id\": 80,\n            \"question\": \"What is your favorite furite ?\",\n            \"type\": \"radio\",\n            \"choices\": [\n                {\n                    \"answer\": \"apple\",\n                    \"id\": 45\n                },\n                {\n                    \"answer\": \"orange\",\n                    \"id\": 46\n                },\n                {\n                    \"answer\": \"watermelon\",\n                    \"id\": 47\n                }\n            ]\n        },\n        {\n            \"id\": 81,\n            \"question\": \"What is your favorite film ?\",\n            \"type\": \"drop_down\",\n            \"choices\": [\n                {\n                    \"answer\": \"pulp fiction\",\n                    \"id\": 48\n                },\n                {\n                    \"answer\": \"grandfather\",\n                    \"id\": 49\n                },\n                {\n                    \"answer\": \"black water\",\n                    \"id\": 50\n                }\n            ]\n        }\n    ],\n    \"next\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5c35e3e59b1e5b06d1d4772c","ref":"","in":"query","required":false,"desc":"","default":"","type":"int","name":"page"},{"_id":"5c35e3e59b1e5b06d1d4772b","ref":"","in":"query","required":false,"desc":"max 1000","default":"250","type":"int","name":"page_size"},{"_id":"5c35e3e59b1e5b06d1d4772a","ref":"","in":"query","required":false,"desc":"last page's start_time key","default":"","type":"timestamp","name":"timestamp"}],"url":"/events/:event_id/custom_questions"},"isReference":false,"order":3,"body":"","excerpt":"","slug":"custom-question-list","type":"get","title":"Custom Question List","__v":2,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getCustom Question List


Query Params

page:
integer
page_size:
integer250
max 1000
timestamp:
timestamp
last page's start_time key

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



{"_id":"5c3896cfe2135f002b26bbfd","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c00ff326becd803658cb36e","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-11T13:14:55.469Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Field Type\",\n    \"0-0\": \"registration_type\",\n    \"0-1\": \"Integer\",\n    \"h-2\": \"Required?\",\n    \"0-2\": \"Yes\",\n    \"1-0\": \"first_name\",\n    \"1-1\": \"String\",\n    \"2-0\": \"last_name\",\n    \"3-0\": \"email\",\n    \"4-0\": \"prefix\",\n    \"5-0\": \"suffix\",\n    \"6-0\": \"phone\",\n    \"7-0\": \"cell_phone\",\n    \"8-0\": \"company\",\n    \"9-0\": \"job_title\",\n    \"10-0\": \"work_phone\",\n    \"14-0\": \"nfc_tag\",\n    \"15-0\": \"custom_questions\",\n    \"12-0\": \"website\",\n    \"13-0\": \"barcode\",\n    \"11-0\": \"blog\",\n    \"2-1\": \"String\",\n    \"1-2\": \"Yes\",\n    \"h-3\": \"Field Description\",\n    \"0-3\": \"See \\\"Registration Types\\\" for more information\",\n    \"1-3\": \"Guest first name\",\n    \"2-2\": \"Yes\",\n    \"2-3\": \"Guest last name\",\n    \"3-1\": \"String\",\n    \"4-1\": \"String\",\n    \"5-1\": \"String\",\n    \"6-1\": \"String\",\n    \"7-1\": \"String\",\n    \"8-1\": \"String\",\n    \"9-1\": \"String\",\n    \"10-1\": \"String\",\n    \"11-1\": \"String\",\n    \"12-1\": \"String\",\n    \"13-1\": \"String\",\n    \"14-1\": \"String\",\n    \"3-2\": \"Yes\",\n    \"4-2\": \"No\",\n    \"5-2\": \"No\",\n    \"6-2\": \"No\",\n    \"7-2\": \"No\",\n    \"8-2\": \"No\",\n    \"9-2\": \"No\",\n    \"10-2\": \"No\",\n    \"11-2\": \"No\",\n    \"12-2\": \"No\",\n    \"13-2\": \"No\",\n    \"14-2\": \"No\",\n    \"15-2\": \"No\",\n    \"15-1\": \"List of Objects\",\n    \"3-3\": \"Guest email\",\n    \"4-3\": \"Guest prefix\",\n    \"5-3\": \"Guest  suffix\",\n    \"6-3\": \"Guest phone number\",\n    \"7-3\": \"Guest cell phone number\",\n    \"8-3\": \"Guest company name\",\n    \"9-3\": \"Guest job title\",\n    \"10-3\": \"Guest work phone number\",\n    \"11-3\": \"Guest blog url\",\n    \"12-3\": \"Guest website url\",\n    \"13-3\": \"Guest barcode:\\nIf you are adding a guest, make sure you have unique barcode data - otherwise guest cannot be added.\\n**This field is not required but value cannot be empty or null. If nothing is imported, Boomset will automatically create an unique barcode for each guest**\",\n    \"14-3\": \"Guest NFC tag:\\nIf you are adding a guest, make sure you have unique NFC tag data otherwise guest cannot be added.\\n**This field is not required but value cannot be empty or null.**\",\n    \"15-3\": \"Guest answers for event custom questions:\\nThere are couple of rules for adding guests: \\n  * If the custom question type is dropdown or radio, then answer must be the corresponding Answer ID integer\\n  * If the type is checkbox, then answer must be a list of integers, even if guest selects only one choice\\n  * If the type is text, then answer must be in text, even if guest’s answer is an integer\\n\\nSee an example on the “Add Guest” section\"\n  },\n  \"cols\": 4,\n  \"rows\": 16\n}\n[/block]","excerpt":"Guest details are used when importing attendee information into default fields in Boomset.","slug":"guests","type":"basic","title":"Guests","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Guests

Guest details are used when importing attendee information into default fields in Boomset.

[block:parameters] { "data": { "h-0": "Field", "h-1": "Field Type", "0-0": "registration_type", "0-1": "Integer", "h-2": "Required?", "0-2": "Yes", "1-0": "first_name", "1-1": "String", "2-0": "last_name", "3-0": "email", "4-0": "prefix", "5-0": "suffix", "6-0": "phone", "7-0": "cell_phone", "8-0": "company", "9-0": "job_title", "10-0": "work_phone", "14-0": "nfc_tag", "15-0": "custom_questions", "12-0": "website", "13-0": "barcode", "11-0": "blog", "2-1": "String", "1-2": "Yes", "h-3": "Field Description", "0-3": "See \"Registration Types\" for more information", "1-3": "Guest first name", "2-2": "Yes", "2-3": "Guest last name", "3-1": "String", "4-1": "String", "5-1": "String", "6-1": "String", "7-1": "String", "8-1": "String", "9-1": "String", "10-1": "String", "11-1": "String", "12-1": "String", "13-1": "String", "14-1": "String", "3-2": "Yes", "4-2": "No", "5-2": "No", "6-2": "No", "7-2": "No", "8-2": "No", "9-2": "No", "10-2": "No", "11-2": "No", "12-2": "No", "13-2": "No", "14-2": "No", "15-2": "No", "15-1": "List of Objects", "3-3": "Guest email", "4-3": "Guest prefix", "5-3": "Guest suffix", "6-3": "Guest phone number", "7-3": "Guest cell phone number", "8-3": "Guest company name", "9-3": "Guest job title", "10-3": "Guest work phone number", "11-3": "Guest blog url", "12-3": "Guest website url", "13-3": "Guest barcode:\nIf you are adding a guest, make sure you have unique barcode data - otherwise guest cannot be added.\n**This field is not required but value cannot be empty or null. If nothing is imported, Boomset will automatically create an unique barcode for each guest**", "14-3": "Guest NFC tag:\nIf you are adding a guest, make sure you have unique NFC tag data otherwise guest cannot be added.\n**This field is not required but value cannot be empty or null.**", "15-3": "Guest answers for event custom questions:\nThere are couple of rules for adding guests: \n * If the custom question type is dropdown or radio, then answer must be the corresponding Answer ID integer\n * If the type is checkbox, then answer must be a list of integers, even if guest selects only one choice\n * If the type is text, then answer must be in text, even if guest’s answer is an integer\n\nSee an example on the “Add Guest” section" }, "cols": 4, "rows": 16 } [/block]
[block:parameters] { "data": { "h-0": "Field", "h-1": "Field Type", "0-0": "registration_type", "0-1": "Integer", "h-2": "Required?", "0-2": "Yes", "1-0": "first_name", "1-1": "String", "2-0": "last_name", "3-0": "email", "4-0": "prefix", "5-0": "suffix", "6-0": "phone", "7-0": "cell_phone", "8-0": "company", "9-0": "job_title", "10-0": "work_phone", "14-0": "nfc_tag", "15-0": "custom_questions", "12-0": "website", "13-0": "barcode", "11-0": "blog", "2-1": "String", "1-2": "Yes", "h-3": "Field Description", "0-3": "See \"Registration Types\" for more information", "1-3": "Guest first name", "2-2": "Yes", "2-3": "Guest last name", "3-1": "String", "4-1": "String", "5-1": "String", "6-1": "String", "7-1": "String", "8-1": "String", "9-1": "String", "10-1": "String", "11-1": "String", "12-1": "String", "13-1": "String", "14-1": "String", "3-2": "Yes", "4-2": "No", "5-2": "No", "6-2": "No", "7-2": "No", "8-2": "No", "9-2": "No", "10-2": "No", "11-2": "No", "12-2": "No", "13-2": "No", "14-2": "No", "15-2": "No", "15-1": "List of Objects", "3-3": "Guest email", "4-3": "Guest prefix", "5-3": "Guest suffix", "6-3": "Guest phone number", "7-3": "Guest cell phone number", "8-3": "Guest company name", "9-3": "Guest job title", "10-3": "Guest work phone number", "11-3": "Guest blog url", "12-3": "Guest website url", "13-3": "Guest barcode:\nIf you are adding a guest, make sure you have unique barcode data - otherwise guest cannot be added.\n**This field is not required but value cannot be empty or null. If nothing is imported, Boomset will automatically create an unique barcode for each guest**", "14-3": "Guest NFC tag:\nIf you are adding a guest, make sure you have unique NFC tag data otherwise guest cannot be added.\n**This field is not required but value cannot be empty or null.**", "15-3": "Guest answers for event custom questions:\nThere are couple of rules for adding guests: \n * If the custom question type is dropdown or radio, then answer must be the corresponding Answer ID integer\n * If the type is checkbox, then answer must be a list of integers, even if guest selects only one choice\n * If the type is text, then answer must be in text, even if guest’s answer is an integer\n\nSee an example on the “Add Guest” section" }, "cols": 4, "rows": 16 } [/block]
{"_id":"5c1281ee86cd39000e954e3e","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c00ff326becd803658cb36e","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-12-13T15:59:42.496Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":201,"language":"json","code":"{\n  \"id\": 3982\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5c1284dae175400013b28372","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"event_id"},{"_id":"5c1284dae175400013b2836f","ref":"","in":"body","required":true,"desc":"Guest registration type id in the event","default":"","type":"int","name":"registration_type"},{"_id":"5c224f9900c384006389fdc3","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"first_name"},{"_id":"5c224f9900c384006389fdc2","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"last_name"},{"_id":"5c224f9900c384006389fdc4","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"email"},{"_id":"5c224f9900c384006389fdbf","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"prefix"},{"_id":"5c224f9900c384006389fdbe","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"suffix"},{"_id":"5c224f9900c384006389fdc0","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"phone"},{"_id":"5c224f9900c384006389fdc6","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"cell_phone"},{"_id":"5c224f9900c384006389fdc5","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"company"},{"_id":"5c224f9900c384006389fdc1","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"job_title"},{"_id":"5c224f9900c384006389fdbc","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"work_phone"},{"_id":"5c224f9900c384006389fdc7","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"blog"},{"_id":"5c224f9900c384006389fdbd","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"website"},{"_id":"5c2f4f4e93851f0019fe522c","ref":"","in":"body","required":false,"desc":"event based unique identifier for a guest, cannot be sent empty.","default":"","type":"string","name":"barcode"},{"_id":"5c2f4f4e93851f0019fe522b","ref":"","in":"body","required":false,"desc":"event based unique identifier for a guest, cannot be sent empty.","default":"","type":"string","name":"nfc_tag"},{"_id":"5c224f9900c384006389fdbb","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_object","name":"custom_questions"}],"url":"/events/:event_id/guests","examples":{"codes":[{"code":"{\n  \"blog\": \"string\",\n  \"cell_phone\": \"string\",\n  \"company\": \"string\",\n  \"email\": \"string\",\n  \"first_name\": \"string\",\n  \"job_title\": \"string\",\n  \"last_name\": \"string\",\n  \"phone\": \"string\",\n  \"prefix\": \"string\",\n  \"suffix\": \"string\",\n  \"website\": \"string\",\n  \"work_phone\": \"string\",\n  \"registration_type\": Integer,\n  \"barcode\": \"string\",\n  \"nfc_tag\": \"string\",\n  \"custom_questions\": [\n  \t{\n  \t\t\"answer\": 38,\n  \t\t\"question_id\": 16\n\t\t},\n\t\t{\n      \"answer\": [45, 42],\n      \"question_id\": 17\n    },\n\t\t{\n      \"answer\": \"Boomset text answer\",\n      \"question_id\": 4\n    }\n  ]\n}","language":"json"}]},"method":"post"},"isReference":false,"order":1,"body":"Save a single guest for an event using a specific Event ID.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"detail\\\": \\\"Your session has expired. Please relogin\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"401 - unauthorized\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"registration_type\\\": [\\n        \\\"Event does not have registration_type.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #2\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"first_name\\\": [\\n        \\\"This field is required.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #3\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"first_name\\\": [\\n        \\\"This field may not be blank.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #4\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"question_id must be integer.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #5\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_question\\\": [\\n        \\\"question(98) does not exists.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #6\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"answer not found for question (9).\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #7\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"answer for question (9) must be integer.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #8\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"answer for question (8) must be a list.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #9\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"answer for question (8) must be a list of ids as integer.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #10\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"answer (56) not found for question (8).\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #11\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"question (8) defined multiple times.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #12\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"nfc_tag\\\": [\\n        \\\"NFC tag already exists in your guestlist.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #13\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"barcode\\\": [\\n        \\\"barcode already exists in your guestlist.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #14\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"nfc_tag\\\": [\\n        \\\"NFC tag cannot be empty\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #15\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"barcode\\\": [\\n        \\\"Barcode cannot be empty\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #16\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"barcode\\\": [\\n        \\\"Barcode already exists in your guestlist.\\\"\\n    ],\\n    \\\"conflicted_guest_id\\\": [\\n        \\\"260\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #17\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"add-guest","type":"post","title":"Add Guest","__v":29,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postAdd Guest


Path Params

event_id:
required
integer

Body Params

registration_type:
required
integer
Guest registration type id in the event
first_name:
required
string
last_name:
required
string
email:
required
string
prefix:
string
suffix:
string
phone:
string
cell_phone:
string
company:
string
job_title:
string
work_phone:
string
blog:
string
website:
string
barcode:
string
event based unique identifier for a guest, cannot be sent empty.
nfc_tag:
string
event based unique identifier for a guest, cannot be sent empty.
custom_questions:
array of objects
Save a single guest for an event using a specific Event ID. [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"registration_type\": [\n \"Event does not have registration_type.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"first_name\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #3" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"first_name\": [\n \"This field may not be blank.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #4" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"question_id must be integer.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #5" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_question\": [\n \"question(98) does not exists.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #6" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer not found for question (9).\"\n ]\n}", "language": "json", "name": "400 - Bad Request #7" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer for question (9) must be integer.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #8" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer for question (8) must be a list.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #9" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer for question (8) must be a list of ids as integer.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #10" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer (56) not found for question (8).\"\n ]\n}", "language": "json", "name": "400 - Bad Request #11" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"question (8) defined multiple times.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #12" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"nfc_tag\": [\n \"NFC tag already exists in your guestlist.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #13" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"barcode\": [\n \"barcode already exists in your guestlist.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #14" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"nfc_tag\": [\n \"NFC tag cannot be empty\"\n ]\n}", "language": "json", "name": "400 - Bad Request #15" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"barcode\": [\n \"Barcode cannot be empty\"\n ]\n}", "language": "json", "name": "400 - Bad Request #16" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"barcode\": [\n \"Barcode already exists in your guestlist.\"\n ],\n \"conflicted_guest_id\": [\n \"260\"\n ]\n}", "language": "json", "name": "400 - Bad Request #17" } ] } [/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



Save a single guest for an event using a specific Event ID. [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"registration_type\": [\n \"Event does not have registration_type.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"first_name\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #3" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"first_name\": [\n \"This field may not be blank.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #4" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"question_id must be integer.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #5" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_question\": [\n \"question(98) does not exists.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #6" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer not found for question (9).\"\n ]\n}", "language": "json", "name": "400 - Bad Request #7" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer for question (9) must be integer.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #8" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer for question (8) must be a list.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #9" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer for question (8) must be a list of ids as integer.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #10" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer (56) not found for question (8).\"\n ]\n}", "language": "json", "name": "400 - Bad Request #11" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"question (8) defined multiple times.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #12" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"nfc_tag\": [\n \"NFC tag already exists in your guestlist.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #13" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"barcode\": [\n \"barcode already exists in your guestlist.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #14" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"nfc_tag\": [\n \"NFC tag cannot be empty\"\n ]\n}", "language": "json", "name": "400 - Bad Request #15" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"barcode\": [\n \"Barcode cannot be empty\"\n ]\n}", "language": "json", "name": "400 - Bad Request #16" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"barcode\": [\n \"Barcode already exists in your guestlist.\"\n ],\n \"conflicted_guest_id\": [\n \"260\"\n ]\n}", "language": "json", "name": "400 - Bad Request #17" } ] } [/block]
{"_id":"5c2344c708d9e4000e394495","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c00ff326becd803658cb36e","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-12-26T09:07:19.882Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"text","code":""}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"website\": null,\n    \"cell_phone\": null,\n    \"first_name\": \"Developer\",\n    \"last_name\": \"Shay\",\n    \"suffix\": null,\n    \"job_title\": null,\n    \"work_phone\": null,\n    \"selfie\": \"\",\n    \"barcode\": \"2512201816003334\",\n    \"nfc_tag\": \"nfc2512234\",\n    \"objstatus\": \"1\",\n    \"event\": 1,\n    \"email\": \"developer@boomset.com\",\n    \"blog\": null,\n    \"phone\": null,\n    \"prefix\": null,\n    \"custom_questions\": [\n        {\n            \"question_text\": \"Text Question\",\n            \"answer\": [\n                {\n                    \"answer\": \"Boomset text answer\",\n                    \"id\": null\n                }\n            ],\n            \"question_id\": 4\n        },\n        {\n            \"question_text\": \"Radio Question\",\n            \"answer\": [\n                {\n                    \"answer\": \"Radio answer 1\",\n                    \"id\": \"9\"\n                }\n            ],\n            \"question_id\": 7\n        },\n        {\n            \"question_text\": \"Checkbox Question\",\n            \"answer\": [\n                {\n                    \"answer\": \"Checkbox answer 1\",\n                    \"id\": \"10\"\n                },\n                {\n                    \"answer\": \"Checkbox answer 3\",\n                    \"id\": \"12\"\n                }\n            ],\n            \"question_id\": 8\n        },\n        {\n            \"question_text\": \"Dropdown Question\",\n            \"answer\": [\n                {\n                    \"answer\": \"Dropdown answer 2\",\n                    \"id\": \"13\"\n                }\n            ],\n            \"question_id\": 9\n        }\n    ],\n    \"source\": \"27\",\n    \"company\": null,\n    \"id\": 3335,\n    \"registration_type\": 23\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5c23455a51ec1e001ff032d0","ref":"","in":"path","required":true,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5c2346c5582a11005178dc4f","ref":"","in":"path","required":true,"desc":"Guest id","default":"","type":"int","name":"guest_id"}],"url":"/events/:event_id/guests/:guest_id","method":"get"},"isReference":false,"order":2,"body":"Get data for a single attendee using specific Event and Guest IDs. Here is the description for keys in response data.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"selfie\",\n    \"0-1\": \"Selfie image url, if it is taken during the event\",\n    \"1-0\": \"barcode\",\n    \"1-1\": \"Barcode information, that field can be used as QR code or as barcode on event's badges\",\n    \"2-0\": \"nfc_tag\",\n    \"2-1\": \"NFC Tag information\",\n    \"3-0\": \"objstatus\",\n    \"3-1\": \"The status of that guest, possible values are;\\n1: Active\\n2: Inactive\",\n    \"4-0\": \"custom_questions\",\n    \"4-1\": \"Shows guest answers for event's questions;\\n4 type of questions answers can be found on example result.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","excerpt":"","slug":"guest-detail","type":"get","title":"Guest Detail","__v":13,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getGuest Detail


Path Params

event_id:
required
integer
Event id
guest_id:
required
integer
Guest id
Get data for a single attendee using specific Event and Guest IDs. Here is the description for keys in response data. [block:parameters] { "data": { "h-0": "Key", "h-1": "Description", "0-0": "selfie", "0-1": "Selfie image url, if it is taken during the event", "1-0": "barcode", "1-1": "Barcode information, that field can be used as QR code or as barcode on event's badges", "2-0": "nfc_tag", "2-1": "NFC Tag information", "3-0": "objstatus", "3-1": "The status of that guest, possible values are;\n1: Active\n2: Inactive", "4-0": "custom_questions", "4-1": "Shows guest answers for event's questions;\n4 type of questions answers can be found on example result." }, "cols": 2, "rows": 5 } [/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



Get data for a single attendee using specific Event and Guest IDs. Here is the description for keys in response data. [block:parameters] { "data": { "h-0": "Key", "h-1": "Description", "0-0": "selfie", "0-1": "Selfie image url, if it is taken during the event", "1-0": "barcode", "1-1": "Barcode information, that field can be used as QR code or as barcode on event's badges", "2-0": "nfc_tag", "2-1": "NFC Tag information", "3-0": "objstatus", "3-1": "The status of that guest, possible values are;\n1: Active\n2: Inactive", "4-0": "custom_questions", "4-1": "Shows guest answers for event's questions;\n4 type of questions answers can be found on example result." }, "cols": 2, "rows": 5 } [/block]
{"_id":"5c00ff326becd803658cb381","order":3,"title":"Event Guest List","editedParams":true,"hidden":false,"link_url":"","slug":"getting-guests","type":"get","__v":27,"body":"Get full guest list for an event ID. Here is the description for keys in response data.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"selfie\",\n    \"0-1\": \"Selfie image url, if it is taken during the event\",\n    \"1-0\": \"barcode\",\n    \"1-1\": \"Barcode information, that field can be used as QR code or as barcode on event's badges\",\n    \"2-0\": \"nfc_tag\",\n    \"2-1\": \"NFC Tag information.\",\n    \"3-0\": \"objstatus\",\n    \"3-1\": \"The status of that guest, possible values are;\\n1: Active\\n2: Inactive\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"5c00ff326becd803658cb36e","editedParams2":true,"excerpt":"","link_external":false,"updates":[],"user":"54d968913268702d007d9458","api":{"method":"get","params":[{"_id":"55b854ba6aa1a60d00ddf345","ref":"","in":"path","required":true,"desc":"Event ID","default":"","type":"int","name":"event_id"},{"_id":"5c12885502f6d30044af5a83","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"page"},{"_id":"5c12885502f6d30044af5a82","ref":"","in":"query","required":false,"desc":"max 1000","default":"250","type":"int","name":"page_size"},{"_id":"5c12885502f6d30044af5a81","ref":"","in":"query","required":false,"desc":"last page's start_time key","default":"","type":"timestamp","name":"timestamp"},{"_id":"5cb8676c7cdabc002a837c66","ref":"","in":"query","required":false,"desc":"List only checked in guests.","default":"","type":"boolean","name":"only_checkins"}],"results":{"codes":[{"language":"json","code":"{\n    \"count\": 2,\n    \"next\": \"http://localhost:8000/rest/events/1/guests?load_start=2018-12-26T09%3A17%3A06&page=2&page_size=2\",\n    \"previous\": null,\n    \"results\": [\n        {\n            \"website\": null,\n            \"cell_phone\": null,\n            \"first_name\": \"Developer\",\n            \"last_name\": \"Matthew\",\n            \"suffix\": null,\n            \"job_title\": null,\n            \"work_phone\": null,\n            \"selfie\": \"\",\n            \"barcode\": \"251161\",\n            \"nfc_tag\": \"tag251161\",\n            \"objstatus\": \"1\",\n            \"event\": 1,\n            \"email\": \"developer@boomset.com\",\n            \"blog\": null,\n            \"phone\": null,\n            \"prefix\": null,\n            \"custom_questions\": [\n                {\n                    \"question_text\": \"Customer Code\",\n                    \"answer\": [\n                        {\n                            \"answer\": \"126390\",\n                            \"id\": null\n                        }\n                    ],\n                    \"question_id\": 1\n                },\n                {\n                    \"question_text\": \"Reg Source\",\n                    \"answer\": [\n                        {\n                            \"answer\": \"CV\",\n                            \"id\": \"1\"\n                        }\n                    ],\n                    \"question_id\": 2\n                }\n            ],\n            \"source\": \"27\",\n            \"company\": \"Boomset INC\",\n            \"id\": 1,\n            \"registration_type\": 1\n        },\n        {\n            \"website\": null,\n            \"cell_phone\": null,\n            \"first_name\": \"Developer\",\n            \"last_name\": \"Tim\",\n            \"suffix\": null,\n            \"job_title\": \"President\",\n            \"work_phone\": null,\n            \"selfie\": \"\",\n            \"barcode\": \"251589\",\n            \"nfc_tag\": \"tag251589\",\n            \"objstatus\": \"1\",\n            \"event\": 1,\n            \"email\": \"b@boomset.com\",\n            \"blog\": null,\n            \"phone\": null,\n            \"prefix\": null,\n            \"custom_questions\": [\n                {\n                    \"question_text\": \"Customer Code\",\n                    \"answer\": [\n                        {\n                            \"answer\": \"136146\",\n                            \"id\": null\n                        }\n                    ],\n                    \"question_id\": 1\n                },\n                {\n                    \"question_text\": \"Reg Source\",\n                    \"answer\": [\n                        {\n                            \"answer\": \"CV\",\n                            \"id\": \"1\"\n                        }\n                    ],\n                    \"question_id\": 2\n                }\n            ],\n            \"source\": \"27\",\n            \"company\": \"Boomset INC\",\n            \"id\": 2,\n            \"registration_type\": 1\n        }\n    ],\n    \"page\": 1,\n    \"timestamp\": null,\n    \"start_time\": \"2018-12-26T09:17:06\",\n    \"end_time\": \"2018-12-26T09:17:06\"\n}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","url":"/events/:event_id/guests","auth":"required","examples":{"codes":[]}},"version":"5c00ff326becd803658cb394","createdAt":"2015-07-29T04:21:14.929Z","githubsync":"","project":"54d2cbfc2ce0e00d007515e9","sync_unique":"","parentDoc":null,"isReference":false,"next":{"description":"","pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getEvent Guest List


Path Params

event_id:
required
integer
Event ID

Query Params

page:
integer1
page_size:
integer250
max 1000
timestamp:
timestamp
last page's start_time key
only_checkins:
boolean
List only checked in guests.
Get full guest list for an event ID. Here is the description for keys in response data. [block:parameters] { "data": { "h-0": "Key", "h-1": "Description", "0-0": "selfie", "0-1": "Selfie image url, if it is taken during the event", "1-0": "barcode", "1-1": "Barcode information, that field can be used as QR code or as barcode on event's badges", "2-0": "nfc_tag", "2-1": "NFC Tag information.", "3-0": "objstatus", "3-1": "The status of that guest, possible values are;\n1: Active\n2: Inactive" }, "cols": 2, "rows": 4 } [/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



Get full guest list for an event ID. Here is the description for keys in response data. [block:parameters] { "data": { "h-0": "Key", "h-1": "Description", "0-0": "selfie", "0-1": "Selfie image url, if it is taken during the event", "1-0": "barcode", "1-1": "Barcode information, that field can be used as QR code or as barcode on event's badges", "2-0": "nfc_tag", "2-1": "NFC Tag information.", "3-0": "objstatus", "3-1": "The status of that guest, possible values are;\n1: Active\n2: Inactive" }, "cols": 2, "rows": 4 } [/block]
{"_id":"5c2377ef1116250044c75317","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c00ff326becd803658cb36e","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-12-26T12:45:35.651Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[{"name":"Success","code":"{\n  \"blog\": \"string\",\n  \"cell_phone\": \"string\",\n  \"company\": \"string\",\n  \"email\": \"string\",\n  \"first_name\": \"string\",\n  \"job_title\": \"string\",\n  \"last_name\": \"string\",\n  \"phone\": \"string\",\n  \"prefix\": \"string\",\n  \"suffix\": \"string\",\n  \"objstatus\": Integer,\n  \"website\": \"string\",\n  \"work_phone\": \"string\",\n  \"registration_type\": Integer,\n  \"barcode\": \"string\",\n  \"nfc_tag\": \"string\",\n  \"custom_questions\": [\n  \t{\n  \t\t\"answer\": 38,\n  \t\t\"question_id\": 16\n\t\t},\n\t\t{\n      \"answer\": [45, 42],\n      \"question_id\": 17\n    },\n\t\t{\n      \"answer\": \"New Boomset text answer\",\n      \"question_id\": 4\n    }\n  ]\n}","language":"json"}]},"settings":"5c4062101d67d6001477c60a","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 23188\n}","name":""}]},"auth":"required","params":[{"_id":"5c1284dae175400013b28372","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"event_id"},{"_id":"5c2377ef1116250044c75318","ref":"","in":"path","required":false,"desc":"","default":"","type":"int","name":"guest_id"},{"_id":"5c1284dae175400013b2836f","ref":"","in":"body","required":false,"desc":"Guest registration type id in the event","default":"","type":"int","name":"registration_type"},{"_id":"5c2f50356a8e26001900e467","ref":"","in":"body","required":false,"desc":"event based unique identifier for a guest, cannot be sent empty.","default":"","type":"string","name":"barcode"},{"_id":"5c2f50356a8e26001900e466","ref":"","in":"body","required":false,"desc":"event based unique identifier for a guest, cannot be sent empty.","default":"","type":"string","name":"nfc_tag"},{"_id":"5c5968f1b8c804002dbd61c1","ref":"","in":"body","required":false,"desc":"The status of guest. Active: 1, Inactive: 2","default":"","type":"int","name":"objstatus"},{"_id":"5c224f9900c384006389fdc7","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"blog"},{"_id":"5c224f9900c384006389fdc6","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"cell_phone"},{"_id":"5c224f9900c384006389fdc5","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"company"},{"_id":"5c224f9900c384006389fdc4","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"email"},{"_id":"5c224f9900c384006389fdc3","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"first_name"},{"_id":"5c224f9900c384006389fdc2","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"last_name"},{"_id":"5c224f9900c384006389fdc1","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"job_title"},{"_id":"5c224f9900c384006389fdc0","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"phone"},{"_id":"5c224f9900c384006389fdbf","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"prefix"},{"_id":"5c224f9900c384006389fdbe","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"suffix"},{"_id":"5c224f9900c384006389fdbd","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"website"},{"_id":"5c224f9900c384006389fdbc","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"work_phone"},{"_id":"5c224f9900c384006389fdbb","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_object","name":"custom_questions"}],"url":"/events/:event_id/guests/:guest_id"},"isReference":false,"order":4,"body":"Update a single guest for an event given a specific Event and Guest ID.\n\n# Responses\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\\"id\\\": 23188}\",\n      \"language\": \"json\",\n      \"name\": \"200 - OK\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"detail\\\": \\\"Your session has expired. Please relogin\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"401 - unauthorized\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"registration_type\\\": [\\n        \\\"Event does not have registration_type.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #2\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"first_name\\\": [\\n        \\\"This field is required.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #3\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"first_name\\\": [\\n        \\\"This field may not be blank.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #4\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"question_id must be integer.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #5\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_question\\\": [\\n        \\\"question(98) does not exists.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #6\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"answer not found for question (9).\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #7\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"answer for question (9) must be integer.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #8\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"answer for question (8) must be a list.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #9\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"answer for question (8) must be a list of ids as integer.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #10\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"answer (56) not found for question (8).\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #11\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"custom_questions\\\": [\\n        \\\"question (8) defined multiple times.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #12\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"nfc_tag\\\": [\\n        \\\"nfc_tag already exists in your guestlist.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #13\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"barcode\\\": [\\n        \\\"barcode already exists in your guestlist.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #14\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"nfc_tag\\\": [\\n        \\\"NFC tag cannot be empty\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #15\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"barcode\\\": [\\n        \\\"Barcode cannot be empty\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #16\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"barcode\\\": [\\n        \\\"Barcode already exists in your guestlist.\\\"\\n    ],\\n    \\\"conflicted_guest_id\\\": [\\n        \\\"260\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #17 \"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"update-guest","type":"put","title":"Update Guest","__v":27,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putUpdate Guest


Path Params

event_id:
required
integer
guest_id:
integer

Body Params

registration_type:
integer
Guest registration type id in the event
barcode:
string
event based unique identifier for a guest, cannot be sent empty.
nfc_tag:
string
event based unique identifier for a guest, cannot be sent empty.
objstatus:
integer
The status of guest. Active: 1, Inactive: 2
blog:
string
cell_phone:
string
company:
string
email:
string
first_name:
string
last_name:
string
job_title:
string
phone:
string
prefix:
string
suffix:
string
website:
string
work_phone:
string
custom_questions:
array of objects
Update a single guest for an event given a specific Event and Guest ID. # Responses [block:code] { "codes": [ { "code": "{\"id\": 23188}", "language": "json", "name": "200 - OK" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"registration_type\": [\n \"Event does not have registration_type.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"first_name\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #3" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"first_name\": [\n \"This field may not be blank.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #4" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"question_id must be integer.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #5" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_question\": [\n \"question(98) does not exists.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #6" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer not found for question (9).\"\n ]\n}", "language": "json", "name": "400 - Bad Request #7" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer for question (9) must be integer.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #8" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer for question (8) must be a list.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #9" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer for question (8) must be a list of ids as integer.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #10" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer (56) not found for question (8).\"\n ]\n}", "language": "json", "name": "400 - Bad Request #11" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"question (8) defined multiple times.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #12" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"nfc_tag\": [\n \"nfc_tag already exists in your guestlist.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #13" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"barcode\": [\n \"barcode already exists in your guestlist.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #14" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"nfc_tag\": [\n \"NFC tag cannot be empty\"\n ]\n}", "language": "json", "name": "400 - Bad Request #15" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"barcode\": [\n \"Barcode cannot be empty\"\n ]\n}", "language": "json", "name": "400 - Bad Request #16" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"barcode\": [\n \"Barcode already exists in your guestlist.\"\n ],\n \"conflicted_guest_id\": [\n \"260\"\n ]\n}", "language": "json", "name": "400 - Bad Request #17 " } ] } [/block]

User Information

Try It Out

put
{{ 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



Update a single guest for an event given a specific Event and Guest ID. # Responses [block:code] { "codes": [ { "code": "{\"id\": 23188}", "language": "json", "name": "200 - OK" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"registration_type\": [\n \"Event does not have registration_type.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"first_name\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #3" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"first_name\": [\n \"This field may not be blank.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #4" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"question_id must be integer.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #5" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_question\": [\n \"question(98) does not exists.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #6" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer not found for question (9).\"\n ]\n}", "language": "json", "name": "400 - Bad Request #7" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer for question (9) must be integer.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #8" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer for question (8) must be a list.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #9" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer for question (8) must be a list of ids as integer.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #10" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"answer (56) not found for question (8).\"\n ]\n}", "language": "json", "name": "400 - Bad Request #11" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"custom_questions\": [\n \"question (8) defined multiple times.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #12" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"nfc_tag\": [\n \"nfc_tag already exists in your guestlist.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #13" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"barcode\": [\n \"barcode already exists in your guestlist.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #14" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"nfc_tag\": [\n \"NFC tag cannot be empty\"\n ]\n}", "language": "json", "name": "400 - Bad Request #15" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"barcode\": [\n \"Barcode cannot be empty\"\n ]\n}", "language": "json", "name": "400 - Bad Request #16" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"barcode\": [\n \"Barcode already exists in your guestlist.\"\n ],\n \"conflicted_guest_id\": [\n \"260\"\n ]\n}", "language": "json", "name": "400 - Bad Request #17 " } ] } [/block]
{"_id":"5d0cc5567c2a1b00302bca45","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5c00ff326becd803658cb36e","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-21T11:53:58.501Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[{"name":"add-session","code":"{\n    \"attend\": true\n}","language":"json"}]},"results":{"codes":[{"name":"","code":"{\n    \"guest_id\": \"167751\",\n    \"status\": \"registered\",\n    \"session_id\": \"27\"\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5d0cb7b889fb2900383bad88","ref":"","in":"body","required":false,"desc":"Used to attend a guest in defined session.","default":"true","type":"boolean","name":"attend"},{"_id":"5d0cb80389fb2900383bad8f","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"session_id"},{"_id":"5d0cc889fdb6da005d4ad1b6","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"guest_id"}],"url":"/events/:event_id/guests/:guest_id/registration/session/:session_id"},"isReference":false,"order":5,"body":"Update a session by defining `event_id` and `session_id`.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"detail\\\": \\\"Your session has expired. Please relogin\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"401 - unauthorized\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"details\\\": \\\"Session is full!\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #1\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"update-guest-session","type":"put","title":"Update Guest Session","__v":7,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putUpdate Guest Session


Path Params

session_id:
required
integer
guest_id:
required
integer

Body Params

attend:
booleantrue
Used to attend a guest in defined session.
Update a session by defining `event_id` and `session_id`. [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"details\": \"Session is full!\"\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block]

User Information

Try It Out

put
{{ 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



Update a session by defining `event_id` and `session_id`. [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"details\": \"Session is full!\"\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block]
{"_id":"5d0cb35299eeef00144697ca","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d0cb30a89fb2900383bad20","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-21T10:37:06.408Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Datetime fields are in GMT Timezone.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"name\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Field Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Field Description\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Yes\",\n    \"0-3\": \"Name of session\",\n    \"1-0\": \"starts\",\n    \"1-1\": \"Datetime\",\n    \"1-2\": \"Yes\",\n    \"1-3\": \"Session starts in GMT timezone. eg. 2019-05-03T15:00\",\n    \"2-0\": \"ends\",\n    \"2-1\": \"Datetime\",\n    \"2-2\": \"Yes\",\n    \"2-3\": \"Session ends in GMT timezone. eg. 2019-05-08T15:00\",\n    \"3-0\": \"tags\",\n    \"3-1\": \"Array of string\",\n    \"3-2\": \"No\",\n    \"3-3\": \"Tags to group your sessions together. (e.g. Hair Cutting)\",\n    \"4-0\": \"access_control\",\n    \"4-1\": \"Boolean\",\n    \"4-2\": \"No\",\n    \"4-3\": \"Attendees need to register for this session in order to be checked-in\",\n    \"5-0\": \"capacity\",\n    \"5-1\": \"Integer\",\n    \"5-2\": \"No\",\n    \"5-3\": \"Capacity of sesssion. (Default number of capacity is 10000)\",\n    \"6-0\": \"auto_registration\",\n    \"6-1\": \"Boolean\",\n    \"6-2\": \"No\",\n    \"6-3\": \"Attendees registered instantly at the door based on access control.\",\n    \"7-0\": \"overbook_capacity\",\n    \"7-1\": \"Integer\",\n    \"7-2\": \"No\",\n    \"7-3\": \"Extra quantity for session over capacity. (Default number is 0)\",\n    \"8-0\": \"track_id\",\n    \"8-1\": \"Integer\",\n    \"8-2\": \"No\",\n    \"8-3\": \"Track to group your sessions together. (e.g. Morning Sessions)\",\n    \"9-0\": \"hidden_session\",\n    \"9-1\": \"Boolean\",\n    \"9-2\": \"No\",\n    \"9-3\": \"When enabled, this session will not appear on guest schedules, Kiosks or Smart Session Screens. (Default is false)\"\n  },\n  \"cols\": 4,\n  \"rows\": 10\n}\n[/block]","excerpt":"","slug":"sessions","type":"basic","title":"Sessions","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Sessions


Datetime fields are in GMT Timezone. [block:parameters] { "data": { "0-0": "name", "h-0": "Field", "h-1": "Field Type", "h-2": "Required", "h-3": "Field Description", "0-1": "String", "0-2": "Yes", "0-3": "Name of session", "1-0": "starts", "1-1": "Datetime", "1-2": "Yes", "1-3": "Session starts in GMT timezone. eg. 2019-05-03T15:00", "2-0": "ends", "2-1": "Datetime", "2-2": "Yes", "2-3": "Session ends in GMT timezone. eg. 2019-05-08T15:00", "3-0": "tags", "3-1": "Array of string", "3-2": "No", "3-3": "Tags to group your sessions together. (e.g. Hair Cutting)", "4-0": "access_control", "4-1": "Boolean", "4-2": "No", "4-3": "Attendees need to register for this session in order to be checked-in", "5-0": "capacity", "5-1": "Integer", "5-2": "No", "5-3": "Capacity of sesssion. (Default number of capacity is 10000)", "6-0": "auto_registration", "6-1": "Boolean", "6-2": "No", "6-3": "Attendees registered instantly at the door based on access control.", "7-0": "overbook_capacity", "7-1": "Integer", "7-2": "No", "7-3": "Extra quantity for session over capacity. (Default number is 0)", "8-0": "track_id", "8-1": "Integer", "8-2": "No", "8-3": "Track to group your sessions together. (e.g. Morning Sessions)", "9-0": "hidden_session", "9-1": "Boolean", "9-2": "No", "9-3": "When enabled, this session will not appear on guest schedules, Kiosks or Smart Session Screens. (Default is false)" }, "cols": 4, "rows": 10 } [/block]
Datetime fields are in GMT Timezone. [block:parameters] { "data": { "0-0": "name", "h-0": "Field", "h-1": "Field Type", "h-2": "Required", "h-3": "Field Description", "0-1": "String", "0-2": "Yes", "0-3": "Name of session", "1-0": "starts", "1-1": "Datetime", "1-2": "Yes", "1-3": "Session starts in GMT timezone. eg. 2019-05-03T15:00", "2-0": "ends", "2-1": "Datetime", "2-2": "Yes", "2-3": "Session ends in GMT timezone. eg. 2019-05-08T15:00", "3-0": "tags", "3-1": "Array of string", "3-2": "No", "3-3": "Tags to group your sessions together. (e.g. Hair Cutting)", "4-0": "access_control", "4-1": "Boolean", "4-2": "No", "4-3": "Attendees need to register for this session in order to be checked-in", "5-0": "capacity", "5-1": "Integer", "5-2": "No", "5-3": "Capacity of sesssion. (Default number of capacity is 10000)", "6-0": "auto_registration", "6-1": "Boolean", "6-2": "No", "6-3": "Attendees registered instantly at the door based on access control.", "7-0": "overbook_capacity", "7-1": "Integer", "7-2": "No", "7-3": "Extra quantity for session over capacity. (Default number is 0)", "8-0": "track_id", "8-1": "Integer", "8-2": "No", "8-3": "Track to group your sessions together. (e.g. Morning Sessions)", "9-0": "hidden_session", "9-1": "Boolean", "9-2": "No", "9-3": "When enabled, this session will not appear on guest schedules, Kiosks or Smart Session Screens. (Default is false)" }, "cols": 4, "rows": 10 } [/block]
{"_id":"5d0cb7b889fb2900383bad7f","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d0cb30a89fb2900383bad20","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-21T10:55:52.337Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"name":"add-session","code":"{\n    \"name\": \"test-session\",\n    \"starts\": \"2019-05-03T15:00\",\n    \"ends\": \"2019-07-06T15:00\",\n    \"tags\": [\"selfie\", \"photo\"],\n    \"access_control\": true,\n    \"capacity\": 2000,\n    \"auto_registration\": true,\n    \"overbook_capacity\": 10,\n  \t\"hidden_session\": false,\n  \t\"track_id\": 12\n}","language":"json"}]},"results":{"codes":[{"name":"","code":"{\n    \"id\": 28\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5d0cb7b889fb2900383bad88","ref":"","in":"body","required":true,"desc":"Name of session","default":"","type":"string","name":"name"},{"_id":"5d0cb7b889fb2900383bad87","ref":"","in":"body","required":true,"desc":"Session starts in GMT timezone. eg. 2019-05-03T15:00","default":"","type":"datetime","name":"starts"},{"_id":"5d0cb7b889fb2900383bad86","ref":"","in":"body","required":true,"desc":"Session ends in GMT timezone. eg. 2019-05-08T15:00","default":"","type":"datetime","name":"ends"},{"_id":"5d0cb7b889fb2900383bad85","ref":"","in":"body","required":false,"desc":"Tags to group your sessions together. (e.g. ['Hair Cutting', 'Styling'])","default":"","type":"array_string","name":"tags"},{"_id":"5d0cb7b889fb2900383bad84","ref":"","in":"body","required":false,"desc":"Attendees need to register for this session in order to be checked-in","default":"","type":"boolean","name":"access_control"},{"_id":"5d0cb7b889fb2900383bad83","ref":"","in":"body","required":false,"desc":"Capacity of sesssion.","default":"10000","type":"int","name":"capacity"},{"_id":"5d0cb7b889fb2900383bad82","ref":"","in":"body","required":false,"desc":"Attendees registered instantly at the door based on access control.","default":"","type":"boolean","name":"auto_registration"},{"_id":"5d0cb7b889fb2900383bad81","ref":"","in":"body","required":false,"desc":"Extra quantity for session over capacity.","default":"0","type":"int","name":"overbook_capacity"},{"_id":"5d0cb7b889fb2900383bad80","ref":"","in":"body","required":false,"desc":"Track to group your sessions together.","default":"","type":"int","name":"track_id"},{"_id":"5d0cb80389fb2900383bad8f","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"event_id"},{"_id":"5d0e5e434a126e00ec4794e8","ref":"","in":"body","required":false,"desc":"When enabled, this session will not appear on guest schedules, Kiosks or Smart Session Screens.","default":"false","type":"boolean","name":"hidden_session"}],"url":"/events/:event_id/sessions"},"isReference":false,"order":1,"body":"Create a session for defined event_id.\n\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"detail\\\": \\\"Your session has expired. Please relogin\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"401 - unauthorized\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": [\\n        \\\"This field is required.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #1\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"starts\\\": [\\n        \\\"This field is required.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #2\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"starts\\\": [\\n        \\\"Session start date cannot be later than end date.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #3\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"add-session","type":"post","title":"Add Session","__v":12,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postAdd Session


Path Params

event_id:
required
integer

Body Params

name:
required
string
Name of session
starts:
required
datetime
Session starts in GMT timezone. eg. 2019-05-03T15:00
ends:
required
datetime
Session ends in GMT timezone. eg. 2019-05-08T15:00
tags:
array of strings
Tags to group your sessions together. (e.g. ['Hair Cutting', 'Styling'])
access_control:
boolean
Attendees need to register for this session in order to be checked-in
capacity:
integer10000
Capacity of sesssion.
auto_registration:
boolean
Attendees registered instantly at the door based on access control.
overbook_capacity:
integer0
Extra quantity for session over capacity.
track_id:
integer
Track to group your sessions together.
hidden_session:
booleanfalse
When enabled, this session will not appear on guest schedules, Kiosks or Smart Session Screens.
Create a session for defined event_id. [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"starts\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"starts\": [\n \"Session start date cannot be later than end date.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #3" } ] } [/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



Create a session for defined event_id. [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"starts\": [\n \"This field is required.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #2" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"starts\": [\n \"Session start date cannot be later than end date.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #3" } ] } [/block]
{"_id":"5d0cc0a681b35d0010ece0c0","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d0cb30a89fb2900383bad20","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-21T11:33:58.995Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"text","code":""}]},"results":{"codes":[{"name":"","code":"{\n    \"id\": 26,\n    \"event_id\": 39,\n    \"name\": \"test-session\",\n    \"starts\": \"2019-05-03T15:00:00\",\n    \"ends\": \"2019-07-06T15:00:00\",\n    \"capacity\": 3000,\n    \"track_id\": 12,\n    \"tags\": [\n        \"selfie\",\n        \"photo\"\n    ],\n    \"access_control\": true,\n    \"auto_registration\": true,\n    \"hidden_session\": false,\n    \"overlap_enabled\": true,\n    \"overbook_capacity\": 10\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5d0cc28cf910b200241a8a97","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"event_id"},{"_id":"5d0cc28cf910b200241a8a96","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"session_id"}],"url":"/events/:event_id/sessions/:session_id","method":"get"},"isReference":false,"order":2,"body":"Retrieve details of a session by defining of `event_id` and `session_id`","excerpt":"","slug":"session-detail","type":"get","title":"Session Detail","__v":5,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getSession Detail


Path Params

event_id:
required
string
session_id:
required
string
Retrieve details of a session by defining of `event_id` and `session_id`

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



Retrieve details of a session by defining of `event_id` and `session_id`
{"_id":"5d0cc40144fbd7000e27f5c3","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d0cb30a89fb2900383bad20","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-21T11:48:17.048Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"count\": 2,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 28,\n            \"event_id\": 39,\n            \"name\": \"boomset-session\",\n            \"starts\": \"2019-05-03T15:00:00\",\n            \"ends\": \"2019-07-06T15:00:00\",\n            \"capacity\": 100,\n            \"track_id\": 12,\n            \"tags\": [\n                \"selfie\",\n                \"photo\"\n            ],\n            \"access_control\": true,\n            \"auto_registration\": true,\n            \"hidden_session\": false,\n            \"overlap_enabled\": true,\n            \"overbook_capacity\": 0\n        },\n        {\n            \"id\": 27,\n            \"event_id\": 39,\n            \"name\": \"test-session\",\n            \"starts\": \"2019-05-03T15:00:00\",\n            \"ends\": \"2019-07-06T15:00:00\",\n            \"capacity\": 230,\n            \"track_id\": 12,\n            \"tags\": [\n                \"selfie\",\n                \"photo\"\n            ],\n            \"access_control\": true,\n            \"auto_registration\": true,\n            \"hidden_session\": false,\n            \"overlap_enabled\": true,\n            \"overbook_capacity\": 10\n        }\n    ],\n    \"next\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5d0cc6d779301700454d6a67","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"event_id"}],"url":"/events/:event_id/sessions"},"isReference":false,"order":3,"body":"List details of sessions by defining `event_id`.","excerpt":"","slug":"session-list","type":"get","title":"Session List","__v":3,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getSession List


Path Params

event_id:
required
integer
List details of sessions by defining `event_id`.

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



List details of sessions by defining `event_id`.
{"_id":"5d0cc48c134956004360821d","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d0cb30a89fb2900383bad20","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-21T11:50:36.433Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"5c4062101d67d6001477c60a","results":{"codes":[{"name":"","code":"{\n    \"id\": 28\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"examples":{"codes":[{"language":"json","code":"{\n    \"name\": \"test-session-update\",\n    \"starts\": \"2019-05-03T15:00\",\n    \"ends\": \"2019-07-06T15:00\",\n    \"tags\": [\"selfie\", \"photo\"],\n    \"access_control\": false,\n    \"auto_registration\": true,\n    \"overbook_capacity\": 20,\n  \t\"track_id\": 12,\n  \t\"hidden_session\": true\n}","name":"add-session"}]},"method":"put","auth":"required","params":[{"_id":"5d0cb7b889fb2900383bad88","ref":"","in":"body","required":false,"desc":"Name of session","default":"","type":"string","name":"name"},{"_id":"5d0cb7b889fb2900383bad87","ref":"","in":"body","required":false,"desc":"Session starts in GMT timezone. eg. 2019-05-03T15:00","default":"","type":"datetime","name":"starts"},{"_id":"5d0cb7b889fb2900383bad86","ref":"","in":"body","required":false,"desc":"Session ends in GMT timezone. eg. 2019-05-08T15:00","default":"","type":"datetime","name":"ends"},{"_id":"5d0cb7b889fb2900383bad85","ref":"","in":"body","required":false,"desc":"Tags to group your sessions together. (e.g. ['Hair Cutting', 'Styling'])","default":"","type":"array_string","name":"tags"},{"_id":"5d0cb7b889fb2900383bad84","ref":"","in":"body","required":false,"desc":"Attendees need to register for this session in order to be checked-in","default":"","type":"boolean","name":"access_control"},{"_id":"5d0cb7b889fb2900383bad82","ref":"","in":"body","required":false,"desc":"Attendees registered instantly at the door based on access control.","default":"","type":"boolean","name":"auto_registration"},{"_id":"5d0cb7b889fb2900383bad81","ref":"","in":"body","required":false,"desc":"Extra quantity for session over capacity.","default":"0","type":"int","name":"overbook_capacity"},{"_id":"5d0cb7b889fb2900383bad80","ref":"","in":"body","required":false,"desc":"Track to group your sessions together.","default":"","type":"int","name":"track_id"},{"_id":"5d0cb80389fb2900383bad8f","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"event_id"},{"_id":"5d0cc76679301700454d6a82","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"session_id"},{"_id":"5d0e5e0f0f8b09000e7910e1","ref":"","in":"body","required":false,"desc":"When enabled, this session will not appear on guest schedules, Kiosks or Smart Session Screens.","default":"false","type":"boolean","name":"hidden_session"}],"url":"/events/:event_id/sessions/:session_id"},"isReference":false,"order":4,"body":"Update a session by defining `event_id` and `session_id`.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"detail\\\": \\\"Your session has expired. Please relogin\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"401 - unauthorized\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"starts\\\": [\\n        \\\"Session start date cannot be later than end date.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #1\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"update-session","type":"put","title":"Update Session","__v":12,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putUpdate Session


Path Params

event_id:
required
integer
session_id:
required
integer

Body Params

name:
string
Name of session
starts:
datetime
Session starts in GMT timezone. eg. 2019-05-03T15:00
ends:
datetime
Session ends in GMT timezone. eg. 2019-05-08T15:00
tags:
array of strings
Tags to group your sessions together. (e.g. ['Hair Cutting', 'Styling'])
access_control:
boolean
Attendees need to register for this session in order to be checked-in
auto_registration:
boolean
Attendees registered instantly at the door based on access control.
overbook_capacity:
integer0
Extra quantity for session over capacity.
track_id:
integer
Track to group your sessions together.
hidden_session:
booleanfalse
When enabled, this session will not appear on guest schedules, Kiosks or Smart Session Screens.
Update a session by defining `event_id` and `session_id`. [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"starts\": [\n \"Session start date cannot be later than end date.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block]

User Information

Try It Out

put
{{ 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



Update a session by defining `event_id` and `session_id`. [block:code] { "codes": [ { "code": "{\n \"detail\": \"Your session has expired. Please relogin\"\n}", "language": "json", "name": "401 - unauthorized" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"starts\": [\n \"Session start date cannot be later than end date.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block]
{"_id":"5d10ce6139a31a018e5d8eb2","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d0cb30a89fb2900383bad20","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-24T13:21:37.835Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"delete","settings":"5c4062101d67d6001477c60a","results":{"codes":[{"name":"","code":"","language":"json","status":204},{"name":"","code":"{}","language":"json","status":400}]},"examples":{"codes":[{"language":"text","code":""}]},"auth":"required","params":[{"_id":"5d0cc28cf910b200241a8a97","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"event_id"},{"_id":"5d0cc28cf910b200241a8a96","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"session_id"}],"url":"/events/:event_id/sessions/:session_id"},"isReference":false,"order":999,"body":"Deletes a session by defining of `event_id` and `session_id`.","excerpt":"","slug":"session-delete","type":"delete","title":"Session Delete","__v":2,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

deleteSession Delete


Path Params

event_id:
required
string
session_id:
required
string
Deletes a session by defining of `event_id` and `session_id`.

User Information

Try It Out

delete
{{ 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 }}


Deletes a session by defining of `event_id` and `session_id`.
{"_id":"5d0cca31b1efd500434571db","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d0cca1290e4c301a878b548","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-21T12:14:41.673Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Field Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Field Description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Yes\",\n    \"0-3\": \"Name of session track.\",\n    \"1-0\": \"starts\",\n    \"1-1\": \"Datetime\",\n    \"1-2\": \"Yes\",\n    \"1-3\": \"Session track starts in GMT timezone. eg. 2019-05-03T15:00\",\n    \"2-0\": \"ends\",\n    \"2-1\": \"Datetime\",\n    \"2-2\": \"Yes\",\n    \"2-3\": \"Session track ends in GMT timezone. eg. 2019-05-03T15:00\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]","excerpt":"","slug":"session-tracks","type":"basic","title":"Session Tracks","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Session Tracks


[block:parameters] { "data": { "h-0": "Field", "h-1": "Field Type", "h-2": "Required", "h-3": "Field Description", "0-0": "name", "0-1": "String", "0-2": "Yes", "0-3": "Name of session track.", "1-0": "starts", "1-1": "Datetime", "1-2": "Yes", "1-3": "Session track starts in GMT timezone. eg. 2019-05-03T15:00", "2-0": "ends", "2-1": "Datetime", "2-2": "Yes", "2-3": "Session track ends in GMT timezone. eg. 2019-05-03T15:00" }, "cols": 4, "rows": 3 } [/block]
[block:parameters] { "data": { "h-0": "Field", "h-1": "Field Type", "h-2": "Required", "h-3": "Field Description", "0-0": "name", "0-1": "String", "0-2": "Yes", "0-3": "Name of session track.", "1-0": "starts", "1-1": "Datetime", "1-2": "Yes", "1-3": "Session track starts in GMT timezone. eg. 2019-05-03T15:00", "2-0": "ends", "2-1": "Datetime", "2-2": "Yes", "2-3": "Session track ends in GMT timezone. eg. 2019-05-03T15:00" }, "cols": 4, "rows": 3 } [/block]
{"_id":"5d0cdfe5d0eb9900505f854a","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d0cca1290e4c301a878b548","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-21T13:47:17.793Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n    \"name\": \"session-track\",\n    \"starts\": \"2019-05-03T15:00\",\n    \"ends\": \"2019-07-06T15:00\"\n}"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": 19\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5d0ce01c607df1001fde3169","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"event_id"},{"_id":"5d0e5c81bf14b0005668660b","ref":"","in":"body","required":true,"desc":"Name of session track","default":"","type":"string","name":"name"},{"_id":"5d0e5c81bf14b0005668660a","ref":"","in":"body","required":true,"desc":"Session track starts in GMT timezone. eg. 2019-05-03T15:00","default":"","type":"datetime","name":"starts"},{"_id":"5d0e5c81bf14b00056686609","ref":"","in":"body","required":true,"desc":"Session track ends in GMT timezone. eg. 2019-05-08T15:00","default":"","type":"datetime","name":"ends"}],"url":"/events/:event_id/sessions/tracks","method":"post"},"isReference":false,"order":1,"body":"Create session track for an event by defining `event_id`.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"starts\\\": [\\n        \\\"Track start date cannot be later than end date.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"400 - Bad Request #1\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"add-session-track","type":"post","title":"Add Session Track","__v":7,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postAdd Session Track


Path Params

event_id:
required
integer

Body Params

name:
required
string
Name of session track
starts:
required
datetime
Session track starts in GMT timezone. eg. 2019-05-03T15:00
ends:
required
datetime
Session track ends in GMT timezone. eg. 2019-05-08T15:00
Create session track for an event by defining `event_id`. [block:code] { "codes": [ { "code": "{\n \"starts\": [\n \"Track start date cannot be later than end date.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/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



Create session track for an event by defining `event_id`. [block:code] { "codes": [ { "code": "{\n \"starts\": [\n \"Track start date cannot be later than end date.\"\n ]\n}", "language": "json", "name": "400 - Bad Request #1" } ] } [/block]
{"_id":"5d0ce04ec31a28005c0a7289","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d0cca1290e4c301a878b548","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-21T13:49:02.259Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"count\": 2,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 19,\n            \"name\": \"session-track\",\n            \"event_id\": 39,\n            \"starts\": \"2019-05-03T15:00:00\",\n            \"ends\": \"2019-07-06T15:00:00\"\n        },\n        {\n            \"id\": 18,\n            \"name\": \"other-track\",\n            \"event_id\": 39,\n            \"starts\": \"2019-05-03T15:00:00\",\n            \"ends\": \"2019-07-06T15:00:00\"\n        }\n    ],\n    \"next\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5d0ce076f22047004b0c0b24","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"event_id"}],"url":"/events/:event_id/sessions/tracks","method":"get"},"isReference":false,"order":2,"body":"","excerpt":"","slug":"session-track-list","type":"get","title":"Session Track List","__v":3,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getSession Track List


Path Params

event_id:
required
integer

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



{"_id":"5d25defa3c2c3b00e68abdc8","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d2325568e56e9003a4f7d89","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-10T12:50:02.121Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"code\",\n    \"0-1\": \"String\",\n    \"1-0\": \"discount_type\",\n    \"2-0\": \"discount_amount\",\n    \"3-0\": \"quantity\",\n    \"4-0\": \"starts\",\n    \"5-0\": \"ends\",\n    \"6-0\": \"registration_types\",\n    \"7-0\": \"available_only\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Field Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Field Description\",\n    \"0-2\": \"Yes\",\n    \"1-2\": \"Yes\",\n    \"2-2\": \"Yes\",\n    \"3-2\": \"Yes\",\n    \"4-2\": \"No\",\n    \"5-2\": \"No\",\n    \"6-2\": \"No\",\n    \"7-2\": \"No\",\n    \"2-1\": \"Float\",\n    \"3-1\": \"Integer\",\n    \"4-1\": \"Datetime\",\n    \"5-1\": \"Datetime\",\n    \"6-1\": \"List of integers\",\n    \"7-1\": \"Boolean\",\n    \"6-3\": \"Promotion can only be applied listed registration types\",\n    \"5-3\": \"Promotion validity end date need to be GMT\",\n    \"4-3\": \"Promotion validity start date need to be GMT\",\n    \"3-3\": \"How many times this promotion\",\n    \"2-3\": \"How much discount is planned for this code\",\n    \"1-3\": \"Discount can be either flat or percent\",\n    \"0-3\": \"Promotion code itself, alphanumeric code would be hard to guess\",\n    \"1-1\": \"String\"\n  },\n  \"cols\": 4,\n  \"rows\": 8\n}\n[/block]","excerpt":"","slug":"promotion-codes","type":"basic","title":"Promotion Codes","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Promotion Codes


[block:parameters] { "data": { "0-0": "code", "0-1": "String", "1-0": "discount_type", "2-0": "discount_amount", "3-0": "quantity", "4-0": "starts", "5-0": "ends", "6-0": "registration_types", "7-0": "available_only", "h-0": "Field", "h-1": "Field Type", "h-2": "Required", "h-3": "Field Description", "0-2": "Yes", "1-2": "Yes", "2-2": "Yes", "3-2": "Yes", "4-2": "No", "5-2": "No", "6-2": "No", "7-2": "No", "2-1": "Float", "3-1": "Integer", "4-1": "Datetime", "5-1": "Datetime", "6-1": "List of integers", "7-1": "Boolean", "6-3": "Promotion can only be applied listed registration types", "5-3": "Promotion validity end date need to be GMT", "4-3": "Promotion validity start date need to be GMT", "3-3": "How many times this promotion", "2-3": "How much discount is planned for this code", "1-3": "Discount can be either flat or percent", "0-3": "Promotion code itself, alphanumeric code would be hard to guess", "1-1": "String" }, "cols": 4, "rows": 8 } [/block]
[block:parameters] { "data": { "0-0": "code", "0-1": "String", "1-0": "discount_type", "2-0": "discount_amount", "3-0": "quantity", "4-0": "starts", "5-0": "ends", "6-0": "registration_types", "7-0": "available_only", "h-0": "Field", "h-1": "Field Type", "h-2": "Required", "h-3": "Field Description", "0-2": "Yes", "1-2": "Yes", "2-2": "Yes", "3-2": "Yes", "4-2": "No", "5-2": "No", "6-2": "No", "7-2": "No", "2-1": "Float", "3-1": "Integer", "4-1": "Datetime", "5-1": "Datetime", "6-1": "List of integers", "7-1": "Boolean", "6-3": "Promotion can only be applied listed registration types", "5-3": "Promotion validity end date need to be GMT", "4-3": "Promotion validity start date need to be GMT", "3-3": "How many times this promotion", "2-3": "How much discount is planned for this code", "1-3": "Discount can be either flat or percent", "0-3": "Promotion code itself, alphanumeric code would be hard to guess", "1-1": "String" }, "cols": 4, "rows": 8 } [/block]
{"_id":"5d25df1f30a1d300187fdc42","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d2325568e56e9003a4f7d89","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-10T12:50:39.934Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"name":null,"language":"json","code":"{\n  'name': 'Boomset Easybird',\n  'code': 'Boomset1881code',\n  'discount_type': 'flat',\n  'discount_amount': 10.00,\n  'quantity': 3,\n  'starts': '2019-07-21T16:00',\n  'ends': '2019-08-01T16:00',\n  'registration_types': [837249, 837250],\n  'available_only': false\n}"}]},"results":{"codes":[{"name":"","code":"{\n  'id': 287382\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[{"_id":"5d25e13179660e0012c781db","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"event_id"},{"_id":"5d274a18fadc0b007317bd8f","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"name"},{"_id":"5d25e13179660e0012c781da","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"code"},{"_id":"5d25e23e997965025ed35d99","ref":"","in":"body","required":true,"desc":"Either flat or percentage","default":"","type":"string","name":"discount_type"},{"_id":"5d25e23e997965025ed35d98","ref":"","in":"body","required":true,"desc":"","default":"","type":"float","name":"discount_amount"},{"_id":"5d25e23e997965025ed35d97","ref":"","in":"body","required":true,"desc":"","default":"","type":"int","name":"quantity"},{"_id":"5d25e23e997965025ed35d96","ref":"","in":"body","required":false,"desc":"","default":"","type":"datetime","name":"starts"},{"_id":"5d25e23e997965025ed35d95","ref":"","in":"body","required":false,"desc":"","default":"","type":"datetime","name":"ends"},{"_id":"5d25e23e997965025ed35d94","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_int","name":"registration_types"},{"_id":"5d25e23e997965025ed35d93","ref":"","in":"body","required":false,"desc":"","default":"","type":"boolean","name":"available_only"}],"url":"/events/:event_id/promotion"},"isReference":false,"order":999,"body":"","excerpt":"","slug":"add-promotion-code","type":"post","title":"Add Promotion Code","__v":8,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postAdd Promotion Code


Path Params

event_id:
required
integer

Body Params

name:
required
string
code:
required
string
discount_type:
required
string
Either flat or percentage
discount_amount:
required
float
quantity:
required
integer
starts:
datetime
ends:
datetime
registration_types:
array of integers
available_only:
boolean

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



{"_id":"5d25df703c2c3b00e68abdd3","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d2325568e56e9003a4f7d89","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-10T12:52:00.787Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  'id': 287382,\n  'name': 'Boomset Easybird',\n  'code': 'Boomset1881code',\n  'discount_type': 'flat',\n  'discount_amount': 10.00,\n  'quantity': 3,\n  'starts': '2019-07-21 16:00:00',\n  'ends': '2019-08-01 16:00:00',\n  'registration_types': [837249, 837250],\n  'available_only': false\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[],"url":"/events/:event_id/promotion/:promotion_id"},"isReference":false,"order":999,"body":"","excerpt":"","slug":"promotion-code-detail","type":"get","title":"Promotion Code Detail","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getPromotion Code Detail



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



{"_id":"5d25dfa204930002f8e4a24b","project":"54d2cbfc2ce0e00d007515e9","version":"5c00ff326becd803658cb394","category":"5d2325568e56e9003a4f7d89","user":"54d968913268702d007d9458","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-10T12:52:50.039Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5c4062101d67d6001477c60a","auth":"required","params":[],"url":"/events/:event_id/promotions"},"isReference":false,"order":999,"body":"","excerpt":"","slug":"promotion-code-list","type":"get","title":"Promotion Code List","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getPromotion Code List



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