{"info":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","description":"

Introduction

This documentation describes the API that can be used to access the Eventicious content management system.

The API allows to edit the event schedule, as well as to add, edit, or change sessions, locations, session tags, speakers and attendees.

In order to test running the queries presented in the documentation using Postman, you must create an account and import a collection of queries by clicking Run in Postman above and then Fork/Import Collection.

Postman provides the ability to get code in many programming languages to submit queries.

Setting variables

After copying the collection to your account, you will have the Eventicious External API collection and the Eventicious External API environment. For correct work of collection queries and code samples generation, you need to set up collection and environment variables (see Defining collection variables and Editing environment variables for details).

In collection and environment it is necessary to set client_id and client_secret parameters, more details on how to get and use it are described in the Authentication section below.

Authentication

The API Authentication uses a secret key. A key is a pair of values client_id and client_secret. To obtain the key, please contact the Event Rocks content department.

Each event is assigned its own key. The key can be used to make requests using the following Authorization header format: Authorization: Bearer {bearer_token}

Relations between objects

When making a request, make sure to specify internal IDs of the objects in your system. These IDs must also be used when defining relations between objects.

For example:

You have created a speaker with id=15. When creating a presentation with this speaker, you need to specify an array containing this id(15) in the speakersIds field.

Adding content in several languages

The Eventicious Public API also allows to add event content translated into several languages. To do that, follow these general rules:

POST requests always create entities in the main language of the conference.
\n
Any PUT request can have the language field added to it, and the required locale should be passed in that field. Use en-US for the English language:
\n
1. If this field is absent, editing will be performed in the main language.
  \n
2. If this field is present, but the passed language is not one of the event languages or is invalid, editing will be performed in the main language.
  \n
3. If this field is present and the passed locale matches one of the conference languages, editing will be performed in that language.
  \n
\n

General information

If a request is succeeded, a response code 200 will be returned.

If the field accepts a link to the image (in particular, externalImagePath), the link must be provided as a valid URL. The server response, when accessed by URL, must contain the content-type header. For images it is supported

content-type: image/jpeg
\n
content-type: image/png
\n

Some fields, specifically, the description field in attendee profile and in event details, the privateinfo field in attendee profile, and the details field in exhibitor card, support text formatting.

The following tags are supported:

text
\n
< ul >< li >marked list< /li >< /ul >
\n
< ol >< li >numeric list< /li >< /ol >
\n
Large text
\n
Small text
\n
< div>Header< /div >
\n
bold
\n
italic
\n
underline
\n
< a title=\"header\" href=\"https://ya.ru/\">hyperlink< /a >
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Setting variables","slug":"setting-variables"},{"content":"Authentication","slug":"authentication"},{"content":"Relations between objects","slug":"relations-between-objects"},{"content":"Adding content in several languages","slug":"adding-content-in-several-languages"},{"content":"General information","slug":"general-information"}],"owner":"36445713","collectionId":"3a51a583-325a-44fd-8ed7-26ce86b43829","publishedId":"2sA3XV7Jnq","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-06-20T10:30:20.000Z"},"item":[{"name":"Authentication and authorization","item":[{"name":"Obtaining token","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"544baa78-cff6-47c3-ad98-5a8bdab8a731"}}],"id":"45621a48-600c-4d3b-97d7-af87bfe344b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"cl-21-234181dd-d87c-4244-b480-fe1b6b31fab8","type":"text"},{"key":"client_secret","value":"cs-21-aa26ba97-17d3-4ad0-abba-6082d4a6d46a","type":"text"}]},"url":"https://api-integration.eventicious.ru/connect/token","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"041f503f-97cf-4510-90ac-5ccecd037472","id":"041f503f-97cf-4510-90ac-5ccecd037472","name":"Authentication and authorization","type":"folder"}},"urlObject":{"path":["connect","token"],"host":["https://api-integration.eventicious.ru"],"query":[],"variable":[]}},"response":[],"_postman_id":"45621a48-600c-4d3b-97d7-af87bfe344b4"}],"id":"041f503f-97cf-4510-90ac-5ccecd037472","description":"

To use External API version v2 and higher, you need to send a special Bearer token in each request in the Authorization header. To get the Bearer token you need to send a request. Token lifetime is 1 hour. The description of the required fields for the request is given below.

Field reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
client_id	string	key identifier
client_secret	string	key password

To obtain the client_id and client_secret, please contact the Event Rocks content department.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"ccccc396-f3ba-4520-a74a-25966cecce1d"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"0553b30c-a7fe-4723-aa33-2533006b39ed"}}],"_postman_id":"041f503f-97cf-4510-90ac-5ccecd037472"},{"name":"Working with locations","item":[{"name":"Creating","id":"b4fed805-b461-49f4-af4c-fa94045cc556","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"position\": 3,\r\n \"name\": \"Location Name Example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/locations/create","description":"

Allows to create a location.

Allows to edit a previously created location with the identifier {id}.

Allows to delete a location with the identifier {id}.

Field reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
id	int	location identifier in your system
name	string	location name
position*	int	location’s sequence number (must be unique)
language	string	editing language (for PUT requests only)

*the system does not validate location sequence numbers. If a multi-stream schedule is used, locations will be displayed in the mobile application in accordance with their sequence numbers.

\n","_postman_id":"76ff78f6-1541-4967-8af4-bca45115e2c0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}}},{"name":"Working with speakers/attendees","item":[{"name":"Creating","id":"3f25e6d0-2dfe-46f6-8f6b-ccb28f5a106e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"users\": [\r\n {\r\n \"id\": 1,\r\n \"firstName\": \"First Name Example\",\r\n \"lastName\": \"Last Name Example\",\r\n \"position\": \"CEO\",\r\n \"region\": \"Greater London\",\r\n \"location\": \"London\",\r\n \"interests\": \"AI, Space\",\r\n \"addInfo\": \"Cybersecurity, Embedded\",\r\n \"telegram\": \"https://t.me/johndoe\",\r\n \"vk\": \"https://vk.com/johndoe\",\r\n \"twitter\": \"https://twitter.com/johndoe\", \r\n \"linkedIn\": \"https://www.linkedin.com/in/johndoe\",\r\n \"socialMediaLink1\": \"https://vk.com/johndoe1\",\r\n \"socialMediaLink2\": \"https://vk.com/johndoe2\",\r\n \"email\": \"admin@example.com\",\r\n \"phone\": \"+79999999999\",\r\n \"date1\": \"2024-08-01\",\r\n \"date2\": \"2024-08-01\",\r\n \"description\": \"Description Example:

marked list

numeric list

marked list

numeric list

Allows to create several attendees/speakers.

The following information about an attendee is returned:

pinCode — attendee ID (personal code for accessing the application)
\n
qrCode - string for generating the attendee’s QR-code
\n
autoLogin - automatically generated login
\n
User external ID
\n

marked list

numeric list

marked list

numeric list

bold italic underline hyperlink\",\r\n \"externalImagePath\": \"https://www.w3schools.com/w3images/avatar2.png\",\r\n \"isSpeaker\": false,\r\n \"company\": \"Acme Corporation\",\r\n \"division\": \"Financial managment\",\r\n \"department\": \"Internal finance\",\r\n \"withdrawn\": false,\r\n \"privateInfo\": \"Private info\",\r\n \"aclGroupIds\": [\r\n 100,\r\n 200,\r\n 300\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/users/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"users\": [\n {\n \"id\": 1,\n \"pinCode\": \"1013\",\n \"autoLogin\": \"itp2vwbl\",\n \"qrCode\": \"BEGIN:VCARD\\nVERSION:3.0\\nN:Last Name Example;First Name Example;;;\\nFN:First Name Example Last Name Example\\nORG:Acme Corporation\\nTITLE:CEO\\nTEL:+79999999999\\nEMAIL:admin@example.com\\nX-EVQR:v2\\\\,First Name Example Last Name Example\\\\,3280433\\\\,97ED4E35DDE080F50C85\\nX-SOCIALPROFILE;type=vk:https://vk.com/johndoe\\nX-SOCIALPROFILE;type=linkedIn:https://www.linkedin.com/in/johndoe\\nX-SOCIALPROFILE;type=twitter:https://twitter.com/johndoe\\nX-SOCIALPROFILE;type=telegram:https://t.me/johndoe\\nEND:VCARD\\n\"\n },\n {\n \"id\": 2,\n \"pinCode\": \"1014\",\n \"autoLogin\": \"24irv9xq\",\n \"qrCode\": \"BEGIN:VCARD\\nVERSION:3.0\\nN:Last Name Example;First Name Example;;;\\nFN:First Name Example Last Name Example\\nORG:Acme Corporation\\nTITLE:CEO\\nTEL:+79999999999\\nEMAIL:admin@example.com\\nX-EVQR:v2\\\\,First Name Example Last Name Example\\\\,3280434\\\\,292497A617883046C058\\nX-SOCIALPROFILE;type=vk:https://vk.com/johndoe\\nX-SOCIALPROFILE;type=linkedIn:https://www.linkedin.com/in/johndoe\\nX-SOCIALPROFILE;type=twitter:https://twitter.com/johndoe\\nX-SOCIALPROFILE;type=telegram:https://t.me/johndoe\\nEND:VCARD\\n\"\n }\n ]\n}"}],"_postman_id":"3f25e6d0-2dfe-46f6-8f6b-ccb28f5a106e"},{"name":"Editing","id":"a83bc780-2d7d-47c8-b837-eb579080b221","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"users\": [\r\n {\r\n \"id\": 1,\r\n \"firstName\": \"First Name Example\",\r\n \"lastName\": \"Last Name Example\",\r\n \"position\": \"CEO\",\r\n \"region\": \"Greater London\",\r\n \"location\": \"London\",\r\n \"interests\": \"AI, Space\",\r\n \"addInfo\": \"Cybersecurity, Embedded\",\r\n \"telegram\": \"https://t.me/johndoe\",\r\n \"vk\": \"https://vk.com/johndoe\",\r\n \"twitter\": \"https://twitter.com/johndoe\", \r\n \"linkedIn\": \"https://www.linkedin.com/in/johndoe\",\r\n \"socialMediaLink1\": \"https://vk.com/johndoe1\",\r\n \"socialMediaLink2\": \"https://vk.com/johndoe2\",\r\n \"email\": \"admin@example.com\",\r\n \"phone\": \"+79999999999\",\r\n \"date1\": \"2024-08-01\",\r\n \"date2\": \"2024-08-01\",\r\n \"description\": \"Description Example:

marked list

numeric list

marked list

numeric list

Allows to edit info about several attendees/speakers at once.

The following information about an attendee is returned:

pinCode — attendee ID (personal code for accessing the application)
\n
qrCode - string for generating the attendee’s QR-code
\n
autoLogin - automatically generated login
\n
User external ID
\n

marked list

numeric list

marked list

numeric list

bold italic underline hyperlink\",\r\n \"externalImagePath\": \"https://www.w3schools.com/w3images/avatar2.png\",\r\n \"isSpeaker\": false,\r\n \"company\": \"Acme Corporation\",\r\n \"division\": \"Financial managment\",\r\n \"department\": \"Internal finance\",\r\n \"withdrawn\": false,\r\n \"privateInfo\": \"Private info\",\r\n \"aclGroupIds\": [\r\n 100,\r\n 200,\r\n 300\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/users/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"users\": [\n {\n \"id\": 1,\n \"pinCode\": \"1013\",\n \"autoLogin\": \"itp2vwbl\",\n \"qrCode\": \"BEGIN:VCARD\\nVERSION:3.0\\nN:Last Name Example;First Name Example;;;\\nFN:First Name Example Last Name Example\\nORG:Acme Corporation\\nTITLE:CEO\\nTEL:+79999999999\\nEMAIL:admin@example.com\\nX-EVQR:v2\\\\,First Name Example Last Name Example\\\\,3280433\\\\,97ED4E35DDE080F50C85\\nX-SOCIALPROFILE;type=vk:https://vk.com/johndoe\\nX-SOCIALPROFILE;type=linkedIn:https://www.linkedin.com/in/johndoe\\nX-SOCIALPROFILE;type=twitter:https://twitter.com/johndoe\\nX-SOCIALPROFILE;type=telegram:https://t.me/johndoe\\nEND:VCARD\\n\"\n },\n {\n \"id\": 2,\n \"pinCode\": \"1014\",\n \"autoLogin\": \"24irv9xq\",\n \"qrCode\": \"BEGIN:VCARD\\nVERSION:3.0\\nN:Last Name Example;First Name Example;;;\\nFN:First Name Example Last Name Example\\nORG:Acme Corporation\\nTITLE:CEO\\nTEL:+79999999999\\nEMAIL:admin@example.com\\nX-EVQR:v2\\\\,First Name Example Last Name Example\\\\,3280434\\\\,292497A617883046C058\\nX-SOCIALPROFILE;type=vk:https://vk.com/johndoe\\nX-SOCIALPROFILE;type=linkedIn:https://www.linkedin.com/in/johndoe\\nX-SOCIALPROFILE;type=twitter:https://twitter.com/johndoe\\nX-SOCIALPROFILE;type=telegram:https://t.me/johndoe\\nEND:VCARD\\n\"\n }\n ]\n}"}],"_postman_id":"a83bc780-2d7d-47c8-b837-eb579080b221"},{"name":"Deleting","id":"db7933d6-ec48-4e19-833a-d4794b89bf83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"userIds\": [ 2005, 2006, 3 ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/users/delete","description":"

Allows to delete several attendees/speakers at once.

Note:

In the Eventicious system, each speaker is also an attendee, that is, “speaker” is just an attribute of an attendee.
\n
Attendee profile is customizable: it is possible to rename and hide existing fields, as well as creating new ones. Renaming a field does not affect the ability to transfer data via the API, however, when configuring, it is important to refer to the initial field name. As for the newly created fields, data transfer via API is currently unavailable.
\n
If auto publish of attendees is enabled in the conference, the number of requests for any changes to attendees (create / update / delete) is limited to 10 requests per minute.
\n

Maximum number of speakers/attendees for each type of request: 200

Field reference

*required field

**read-only field (cannot be used in the create and edit requests)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
id*	int	speaker/attendee identifier in your system (externalID in Eventicious)
firstName*	string	first name
lastName*	string	last name
email	string	email
phone	string	phone number
company	string	company name
division	string	division or branch
department	string	department
position	string	position
description	string	about (bio, description)
interests	string	text for ‘I'm looking for’ field
addInfo	string	text for ‘I can help with’ field
region	string	region
location	string	city
date1	string	field for setting an arbitrary date - date of birth, date of employment, etc.
date2	string	field for setting an arbitrary date - date of birth, date of employment, etc.
externalImagePath	string	link to an image file with user’s photo (URL)
language	string	editing language (for PUT requests only)
aclGroupsIds	int	array of group IDs for this attendee in your system (groups must be created in advance, see the Working with groups section of this document)
showEmail**	bool	whether to show the attendee’s email address to other attendees
showPhone**	bool	whether to show the attendee’s phone number to other attendees
qrCode**	string	string for generating the attendee’s QR-code
pinCode**	string	attendee ID (personal code for accessing the application)
privateInfo	string	private information (accessible to only this attendee after logging into the application)
moderated**	bool	attendee has passed pre-moderation
confirmed**	bool	attendee has logged in to the application (this is similar to ‘authorized’ and is needed for compatibility with older application versions)
autoLogin	string	automatically generated login

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0cbd473d-9db5-4daa-bc42-d89f87b4e9c1"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"47cfd4da-369a-4fac-b2dd-c5da15ea7294"}}],"_postman_id":"2c35f3d2-7c0c-43c0-ad08-a9e73c0e3776","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}}},{"name":"Blocking attendees","item":[{"name":"Blocking","id":"787dae7d-a1e5-4d3f-b524-cda5937e5cef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"userIds\": [\r\n 1,\r\n 2,\r\n 3\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/users/block","description":"

Allows to block the attendees with the specified {id}.

Allows to unblock the attendees with the specified {id}.

The methods described below allow to mass block or unblock several attendees. If it is necessary to close access to the system, an attendee can be blocked.

One request can include a maximum of 200 attendees.

\n","_postman_id":"9fa33032-78b2-4659-92e8-2c1270392cdc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}}},{"name":"Working with attendee groups","item":[{"name":"Creating","id":"56f3b431-7cf7-4df2-9084-c43887da8fd2","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": {id},\r\n \"name\": \"Group Name\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/aclgroups/create","description":"

Allows to create an attendee group.

Allows to edit the attendee group with identifier{id}.

Allows to delete the attendee group with the identifier {id}.

Allows you to get a list of all event groups except system groups. The id field contains the ID of the group in your system. If this parameter is not configured for a group, null will be specified instead of id.

Allows to add/remove several attendees from the attendee groups at once.

Maximum number of attendees in one request: 200

Field reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
userIds	int[]	array of attendee / speaker IDs in the event
groupIdsAddTo	int[]	array of attendee groups IDs, to which attendees / speakers will be added
groupIdsRemoveFrom	int[]	array of attendee groups IDs, from which attendees / speakers will be removed

Example

This request will add three attendees / speakers with IDs 1, 2 and 3 to two attendee groups at once - with IDs 1 and 2, and then remove the same attendees / speakers from attendee groups with IDs 3 and 4.

Important: All fields must be specified in the query. If you do not want to add / remove attendees from groups, specify an empty list in this field.

For example:

{\n  \"userIds\":[1,2,3],\n  \"groupIdsAddTo\":[1,2], \n  \"groupIdsRemoveFrom\":[]\n}\n\n

On the Eventicious platform it is possible to unite attendees into groups (interest groups, groups for companies, departments, cities, etc.). The methods described below allow you to manage such groups.

Field reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
id	int	group identifier in your system
name	string	name of the attendee group

","_postman_id":"d086ee8d-f290-4f23-b374-a450ee2a9477","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}}},{"name":"Working with mentors","item":[{"name":"Assigning","id":"183ef3db-4d6c-4079-82af-5f89b3f57ea5","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"mentorId\": {mentorId},\r\n \"menteeIds\": [\r\n\t\t{menteeId_1},\r\n {menteeId_2}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/users/mentor","description":"

Assings mentor {mentorId} to mentees specified in {menteeIds}

Removes mentor {mentorId} from mentees specified in {menteeIds}

Field reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
mentorId	int	mentor identifier
menteeIds	int[]	mentee identifiers

","_postman_id":"42122f02-0f63-4638-9a1b-f121fd128d9e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}}},{"name":"Working with schedule events","item":[{"name":"Creating","id":"6aad7378-b2a5-42fb-924c-7eac3b631a76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"title\": \"Title Example\",\r\n \"description\": \"Description Example:

marked list

numeric list

Allows to create a schedule event.

marked list

numeric list

bold italic underline hyperlink\",\r\n \"startTime\": \"2022-02-14T10:00\",\r\n \"endTime\": \"2022-02-18T18:00\",\r\n \"color\": \"#FF3B30\",\r\n \"tagIds\": [\r\n 1\r\n ],\r\n \"speakersIds\": [\r\n 1,\r\n 2,\r\n 3\r\n ],\r\n \"locationsIds\": [\r\n 1\r\n ],\r\n \"aclGroupsIds\":[\r\n 1\r\n ],\r\n \"type\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/sessions/create"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"65"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Instance-GUID","value":"5491b6db-cc26-4d30-9e8d-9d1c4c58b3d8"},{"key":"X-Region-Info","value":"Germany West Central"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 15 Feb 2022 20:46:30 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Session with this id already exists in the database\"\n}"},{"id":"45dc9995-b1b1-43aa-9fb2-c4c8c498b6f5","name":"Creating","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"title\": \"Title Example\",\r\n \"description\": \"Description Example:

marked list

numeric list

bold italic underline hyperlink\",\r\n \"startTime\": \"2022-02-14T13:00\",\r\n \"endTime\": \"2022-02-14T15:00\",\r\n \"externalImagePath\": \"https://www.w3schools.com/html/pic_trulli.jpg\",\r\n \"color\": \"#FF3B30\",\r\n \"tagIds\": [\r\n 1\r\n ],\r\n \"speakersIds\": [\r\n 3\r\n ],\r\n \"locationsIds\": [\r\n 1\r\n ],\r\n \"aclGroupsIds\":[\r\n 1\r\n ],\r\n \"type\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/sessions/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"542"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Instance-GUID","value":"5491b6db-cc26-4d30-9e8d-9d1c4c58b3d8"},{"key":"X-Region-Info","value":"Germany West Central"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 16 Feb 2022 07:06:36 GMT"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": 1,\n \"title\": \"Title Example\",\n \"description\": \"Description Example:

marked list

numeric list

bold italic underline hyperlink\",\n \"startTime\": \"2022-02-14T13:00:00\",\n \"endTime\": \"2022-02-14T15:00:00\",\n \"displayStartTime\": null,\n \"displayEndTime\": null,\n \"color\": \"#FF3B30\",\n \"trackId\": null,\n \"speakersIds\": [\n 3\n ],\n \"locationsIds\": [\n 1\n ],\n \"aclGroupsIds\": [],\n \"tagIds\": [\n 1\n ],\n \"dayId\": 108608,\n \"type\": 0,\n \"externalImagePath\": \"https://www.w3schools.com/html/pic_trulli.jpg\",\n \"externalThumbnailPath\": null,\n \"language\": \"ru-RU\"\n}"}],"_postman_id":"6aad7378-b2a5-42fb-924c-7eac3b631a76"},{"name":"Editing","id":"afad9446-c318-4455-871a-793cced67311","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Updated Title Example\",\r\n \"description\": \"Updated Description Example\",\r\n \"startTime\": \"2022-02-14T13:00\",\r\n \"endTime\": \"2022-02-14T15:00\",\r\n \"color\": \"#FF3B30\",\r\n \"tagIds\": [\r\n 1\r\n ],\r\n \"speakersIds\": [\r\n 4\r\n ],\r\n \"locationsIds\": [\r\n 1\r\n ],\r\n \"aclGroupsIds\":[\r\n 1\r\n ],\r\n \"type\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/sessions/update/{id}","description":"

Allows to edit the schedule event with the identifier {id}.

Allows to delete the schedule event with the identifier {id}.

IMPORTANT: The session must not overlap in time and place with an existing session. If there are overlapping sessions in time and place, an error will occur when publishing content in the admin panel.

Описание полей

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
id	int	event identifier in your system
title	string	event name
description	string	event description
startTime	DateTime?	start time
endTime	DateTime?	end time
tagIds	int[]	array of tag IDs
speakerIds	int[]	array of speaker IDs
locationIds	int[]	array of location IDs
type	int	event type 0 - session, presentation 1 - coffee break, lunch, or another general event 2 - filler (a small announcement with no time specified) Coffee breaks and fillers do not have descriptions or speakers, they are just a schedule cell with a name. Fillers are also displayed without time (they are used only to set a position in the schedule), so you can create notification events without specifying time.
externalImagePath	string	link to an image file for the session (displayed on the screen with session’s details; only applied to event type of 0 - sessions/presentation)
aclGroupsIds	int[]	array of group IDs in your system (groups must be created in advance, see the Working with groups section of this document). The event will be visible only to the authenticated attendees who belong to the specified groups.
language	string	editing language (only for PUT requests)

","_postman_id":"c85e66c6-993d-47a4-a71a-b909fe328345","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}}},{"name":"Working with session topics (tags)","item":[{"name":"Creating","id":"1dcd5f09-4a77-4520-89a0-a662ed642b89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"name\": \"Name Example\",\r\n \"color\": \"#111\",\r\n \"visibilityFlag\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/tags/create","description":"

Allows to create a new tag.

Allows to edit the tag with the identidier {id}.

Allows to delete the tag with the identifier{id}.

You can specify tags (Business, Economy, Training, etc.) for events in the schedule. The methods described below allow you to manage these tags.

Field reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
id	int	tag identifier in your system
name	string	tag name
color	int	tag color, a string in the HEX format, for example, `#ABCDEF` if the \"color\" parameter is absent or invalid, the color `#FF3B30` will be used
visibilityFlag	int	tag visibility in the schedule grid; can take values 0 and 1. 0 - do not show the tag in the schedule (it will be displayed only in presentation details), 1 - show the tag in the schedule, in the session box If this parameter is absent or invalid, the 0 value will be used
language	string	editing language (for PUT requests only)

","_postman_id":"5477c501-4ae3-46a0-bdf2-27d586e563cf","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}}},{"name":"Working with session materials (links)","item":[{"name":"Creating","id":"ce3f42f5-3f46-4288-900b-aebf26f904b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"title\": \"Title Example\",\r\n \"url\": \"https://www.w3schools.com/html/pic_trulli.jpg\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/sessions/{sessionId}/attachments/create","description":"

Allows to create an attachment to the session {sessionId}.

The ID of the attachment to be created must be unique within the entire event.

Allows to edit the attachment with the identifier {id} in the session with the identifier {sessionId}.

Allows to delete the attachment with the identifier {id} in the session with the identifier {sessionId}.

You can attach materials and links (presentation on the speech, link to the speaker's website, etc.) to the sessions in the schedule. The methods described below allow you to manage attachments.

Field reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
id*	int	identifier of the session material in your system
title*	string	title of the material
url*	string	link to the material
language	string	editing language (for PUT requests only)
sessionId	int	identifier of the session in your system

*required fields

\n","_postman_id":"f49a0fea-2bb7-44bc-b599-682fde452f98","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}}},{"name":"Synchronizing attendee changes with external system","item":[{"name":"Creating","id":"c951a87a-3709-4e1d-91ad-c9650bfa2415","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"sample string 3\",\r\n \"lastName\": \"sample string 4\",\r\n \"company\": \"sample string 5\",\r\n \"position\": \"sample string 6\",\r\n \"location\": \"sample string 7\",\r\n \"telegram\": \"sample string 8\",\r\n \"vk\": \"sample string 9\",\r\n \"twitter\": \"sample string 10\",\r\n \"socialMediaLink1\": \"sample string 11\",\r\n \"socialMediaLink2\": \"sample string 12\",\r\n \"description\": \"sample string 13\",\r\n \"division\": \"sample string 14\",\r\n \"department\": \"sample string 15\",\r\n \"region\": \"sample string 16\",\r\n \"date1\": \"2019-07-20\",\r\n \"date2\": \"2019-07-20\",\r\n \"isSpeaker\": false,\r\n \"externalImagePath\": \"https://eventicious.com/images/some_img.png\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your api base path}/create","description":"

Is called when an attendee has been created in our system .

Please note: when creating an attendee, we do not know their ID in your system, so this method will wait for your server to return a response with the attendee’s ID in your system.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7e79503d-d8a7-4147-966e-d3f5935dc209","id":"7e79503d-d8a7-4147-966e-d3f5935dc209","name":"Synchronizing attendee changes with external system","type":"folder"}},"urlObject":{"path":["create"],"host":["{your api base path}"],"query":[],"variable":[]}},"response":[{"id":"9c3cd8ab-d9e5-4c93-861f-1d8a3cd58f37","name":"Creating","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"sample string 3\",\r\n \"lastName\": \"sample string 4\",\r\n \"company\": \"sample string 5\",\r\n \"position\": \"sample string 6\",\r\n \"location\": \"sample string 7\",\r\n \"telegram\": \"sample string 8\",\r\n \"vk\": \"sample string 9\",\r\n \"twitter\": \"sample string 10\",\r\n \"socialMediaLink1\": \"sample string 11\",\r\n \"socialMediaLink2\": \"sample string 12\",\r\n \"description\": \"sample string 13\",\r\n \"division\": \"sample string 14\",\r\n \"department\": \"sample string 15\",\r\n \"region\": \"sample string 16\",\r\n \"date1\": \"2019-07-20\",\r\n \"date2\": \"2019-07-20\",\r\n \"isSpeaker\": false,\r\n \"externalImagePath\": \"https://eventicious.com/images/some_img.png\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your api base path}/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1234\r\n}\r\n"}],"_postman_id":"c951a87a-3709-4e1d-91ad-c9650bfa2415"},{"name":"Editing","id":"73f08c96-958a-4ca9-90df-e3b6369f95d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"firstName\": \"sample string 3\",\r\n \"lastName\": \"sample string 4\",\r\n \"company\": \"sample string 5\",\r\n \"position\": \"sample string 6\",\r\n \"location\": \"sample string 7\",\r\n \"telegram\": \"sample string 8\",\r\n \"vk\": \"sample string 9\",\r\n \"twitter\": \"sample string 10\",\r\n \"socialMediaLink1\": \"sample string 11\",\r\n \"socialMediaLink2\": \"sample string 12\",\r\n \"description\": \"sample string 13\",\r\n \"division\": \"sample string 14\",\r\n \"department\": \"sample string 15\",\r\n \"region\": \"sample string 16\",\r\n \"date1\": \"2019-07-20\",\r\n \"date2\": \"2019-07-20\",\r\n \"isSpeaker\": false,\r\n \"externalImagePath\": \"https://eventicious.com/images/some_img.png\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{your api base path}/update/{id}","description":"

Is called when an attendee has been edited in our system.

Is called when an attendee has been deleted in our system.

Note:

The Eventicious platform allows to synchronize changes made to attendees with an external system. Any time a change has been made to an attendee/speaker in the mobile application or in the Administrator panel, a request will be sent to the specified URL.
\n
Contact the Event Rocks Support Team and let them know the URL to be called when any changes have been made to attendees, for example, https://yoursystem.com/eventicious_callback. Different methods will be called when creating/changing/editing attendees.
\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"e7a6514d-358e-487b-a788-74b567944fb0"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"3abe04a6-3693-4a84-a614-a1b0b6b1506d"}}],"_postman_id":"7e79503d-d8a7-4147-966e-d3f5935dc209"},{"name":"Synchronizing attendees’ Favorites in the schedule","item":[{"name":"Passing information about favorites to the mobile app","id":"a05ca497-ea39-4db0-89d5-c150f127035c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"create\": [\r\n {\r\n \"sessionId\": 1,\r\n \"userId\": 12\r\n }\r\n ],\r\n \"delete\": [\r\n {\r\n \"sessionId\": 2,\r\n \"userId\": 21\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/favorites/sessions","description":"

Allows to pass information about actions performed with favorites. After logging in to the mobile application, attendees will see (in the Favorites section of the app) the events they previously marked as favorites on the website.

Field reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
sessionId	int	event identifier in your system
userId	int	attendee identifier in your system
status	string	the result of the operation, takes the values \"success\" or \"errorNotFound\"

The request object contains two arrays: create and delete. Each array contains a list of objects in the format specified above. For the query to work correctly, both arrays must be specified - even if one of them is empty.

Getting started

Contact the Event Rocks Support Team and let them know the URL to be called when any changes have been made to Favorites, for example:

https://yoursystem.com/eventicious_callback

When any actions with Favorites are performed in the mobile app, a PUT request containing JSON data will be made to the specified URL (see parameter descriptions earlier in this document).

\n","urlObject":{"host":["{your api base path}"],"query":[],"variable":[]}},"response":[{"id":"99861cbc-3c1a-4e49-8c72-f46051738aec","name":"Receiving information about Favorites from the mobile app","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer token"}],"body":{"mode":"raw","raw":"{\r\n \"create\": [\r\n {\r\n \"sessionId\": 6777,\r\n \"userId\": 1\r\n }\r\n ],\r\n \"delete\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"{your api base path}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"266c2ba9-7a37-4908-8868-66a19be73455"},{"name":"Retrieving stats for sessions added to Favorites","id":"3ce952e5-5a7b-41c8-a286-abdabf64ddb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-integration.eventicious.ru/api/external/v2/reports/favorites","description":"

Allows to retrieve a list of presentations and stats for sessions added to Favorites. The session name and the number of users who added this session to their Favorites are specified for each session.

Allows you to retrieve a list of questions for speakers with the number of \"likes\". For each question it will be indicated how many \"likes\" it has received.

If the event website has a schedule where authenticated attendees can mark presentations they find interesting, you can sync attendees’ «Favorites» between the mobile application and website.

Before you can do that, you need to set up transfering of the schedule and attendees in order to create connections between objects.

Information will be synchronized for events created using this API. Information will not be synchronized for other events.

\n","_postman_id":"f1d44138-086d-4676-a182-f1c24639b42d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}}},{"name":"Working with exhibitors (companies)","item":[{"name":"Creating","id":"cf1d6096-43cd-456f-90d2-e20f7d8ca041","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 3,\r\n \"language\": \"en-US\", \r\n \"name\": \"name\",\r\n \"address\": \"address\",\r\n \"site\": \"site\",\r\n \"email\": \"email\",\r\n \"phone\": \"phone\",\r\n \"details\": \"

details

Allows to create an exhibitor (company).

details

\",\r\n \"externalImagePath\": \"https://eventicious.com/images/some_img.png\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/expo/create"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cf1d6096-43cd-456f-90d2-e20f7d8ca041"},{"name":"Editing","id":"7ea80326-948a-4ab4-941a-4bc1af85b1cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"language\": \"en-US\", \r\n \"name\": \"name\",\r\n \"address\": \"address\",\r\n \"site\": \"site\",\r\n \"email\": \"email\",\r\n \"phone\": \"phone\",\r\n \"details\": \"

details

The request and response formats are the same as when creating a company. However, only the fields present in the request object will be changed. If a field is present in the request body, but its value is null or an empty string, the value of this field in the admin interface will be reset.

details

\",\r\n \"externalImagePath\": \"https://eventicious.com/images/some_img.png\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/expo/update/{id}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7ea80326-948a-4ab4-941a-4bc1af85b1cd"},{"name":"Deleting","id":"be202e87-f70e-407e-9a64-556e9dc2ab3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api-integration.eventicious.ru/api/external/v2/expo/delete/{id}","description":"

Allows to delete a previously created exhibitor (company).

Field reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
id	int	company identifier in your system
name	string	company name
address	string	company address
site	string	company website
email	string	company email address
phone	string	company phone number
details	string	description
externalImagePath	string	link to an image file (with company logo)
language	string	editing language (for PUT requests only)
representativesIds	int[]	company representatives — array of IDs for these attendees in your system (attendees, whose profile shall be displayed on the screen with company’s details)

","_postman_id":"0e7cb15e-c987-4493-8ef9-939916f8ef4f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}}},{"name":"Gamification","item":[{"name":"Manual point charging","id":"2bf645e9-3fb8-4bfe-a4bc-adefae711380","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"externalId\": 456,\r\n \"scores\": 123,\r\n \"reason\": \"Charging reason\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integration.eventicious.ru/api/external/v2/gamification/add-manual-charge","description":"

Manual charging of points with indicating the reason for charging.

The Eventicious platform has the ability to synchronize manual charges of points to attendees with an external system. Any time some points have been charged to an attendee from the Administrator panel or with QR gamification scanner (Android or iOS) a request is sent to the specified url.

Getting started

Contact the Event Rocks Support Team and let them know the URL to be called when any manual charge has been created for an attendee, for example:

https://yoursystem.com/eventicious_callback.

Description

Transferring of manual charges to an external system can be used both for charging points through the Administrator panel or when working with QR gamification scanner.

Field reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
value*	string	The number of points to be charged. An integer that can be either positive or negative. A negative value can be used to deduct points.
reason*	int	The reason for charging. Specified as a line of text, for example: “Filling out the recommendation form”.
externalId	int	User external ID
firstName*	string	First name
lastName*	string	Last name
imagePath	string	Link to an image file with user’s photo (URL)

*required field

\n","urlObject":{"host":["{your api path}"],"query":[],"variable":[]}},"response":[{"id":"cd62576a-1caf-4779-8236-4256e47eb33e","name":"Transfer of manual charging data to an external system","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"value\": 3,\r\n \"reason\": \"Reason sample\",\r\n \"externalId\": 99,\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Smith\",\r\n \"imagePath\": null\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{your api path}"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e0c6adff-c415-4a82-b7da-699e3a7d1ae4"}],"id":"23a4f79a-0a01-46d7-ab54-e573574d242b","description":"

Field reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Comment
externalId	int	User external ID.
scores	int	The number of points to be charged. An integer that can be either positive or negative. A negative value can be used to deduct points.
reason	string	The reason for charging. Specified as a line of text, for example: “Filling out the recommendation form”.

","_postman_id":"23a4f79a-0a01-46d7-ab54-e573574d242b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}}},{"name":"Synchronizing attendees' list by uploading CSV file","item":[{"name":"Uploading CSV file","id":"629d5257-ae74-45d8-b5ae-bf01efb0e638","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","contentType":"text/csv","value":null}]},"url":"https://api-integration.eventicious.ru/api/external/v2/users/import/{sourceId}/csv","description":"

Upload a CSV file with the list of attendees to be used for synchronization.

Strictly CSV files with the size not exceeding 100 MB are allowed.

The list of possible server responses is given in the Example of request below.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}},"urlObject":{"path":["api","external","v2","users","import","{sourceId}","csv"],"host":["https://api-integration.eventicious.ru"],"query":[],"variable":[]}},"response":[{"id":"ed8d07f2-ec93-4089-a75b-62ea971ba584","name":"Successful CSV file upload","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","contentType":"text/csv","value":null}]},"url":"https://api-integration.eventicious.ru/api/external/v2/users/import/{sourceId}/csv"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\"status\":\"success\"}"},{"id":"c3f361bc-ec64-4399-b602-ec854b9647cf","name":"Successful CSV file upload with a message","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","contentType":"text/csv","value":null}]},"url":"https://api-integration.eventicious.ru/api/external/v2/users/import/{sourceId}/csv"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\":\"success\",\r\n \"message\":\"The provided csv import file does not contain some optional fields: '{comma_separated_missing_optional_fields_names}'\"\r\n}"},{"id":"03fe9ea1-8696-445b-a760-bc12da390bf4","name":"Unsuccessful CSV file upload","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","contentType":"text/csv","value":null}]},"url":"https://api-integration.eventicious.ru/api/external/v2/users/import/{sourceId}/csv"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"type\": \"BadRequestException\",\r\n \"title\": \"Bad Request\",\r\n \"status\": 400,\r\n \"detail\": \"{validation_fail_reason}\",\r\n \"traceId\": \"{trace_identifier}\",\r\n \"message\": \"{validation_fail_reason}\"\r\n}"},{"id":"3320ea3a-9667-4244-b759-6bad4e2e5b50","name":"Exceeded request rate limit","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","contentType":"text/csv","value":null}]},"url":"https://api-integration.eventicious.ru/api/external/v2/users/import/{sourceId}/csv"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"type\": \"TooManyRequestsException\",\r\n \"status\": 429,\r\n \"detail\": \"Too many requests sent in a given amount of time.\",\r\n \"traceId\": \"{trace_identifier}\",\r\n \"message\": \"Too many requests sent in a given amount of time.\"\r\n}"},{"id":"b5882928-0467-4ea4-9053-4cf3826604f0","name":"The synchronization feature is disabled for the event","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","contentType":"text/csv","value":null}]},"url":"https://api-integration.eventicious.ru/api/external/v2/users/import/{sourceId}/csv"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"type\": \"StatusCodeException\",\r\n \"title\": \"An error occurred while processing your request.\",\r\n \"status\": 500,\r\n \"detail\": \"Forbidden - User sync feature is disabled.\",\r\n \"traceId\": \"{trace_identifier}\",\r\n \"message\": \"Forbidden - User sync feature is disabled.\"\r\n}"},{"id":"ef59b6c8-be28-4fe3-85f8-8063726d9c39","name":"The source of synchronization is not found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","contentType":"text/csv","value":null}]},"url":"https://api-integration.eventicious.ru/api/external/v2/users/import/{sourceId}/csv"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"type\": \"AttendeesImportValidationError\",\r\n \"title\": \"An error occurred while processing your request.\",\r\n \"status\": 500,\r\n \"detail\": \"Import source was not found.\",\r\n \"traceId\": \"{trace_identifier}\",\r\n \"message\": \"Import source was not found.\"\r\n}"},{"id":"68ec1be7-574b-452c-84af-0a974131433f","name":"The source of synchronization is disabled","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","contentType":"text/csv","value":null}]},"url":"https://api-integration.eventicious.ru/api/external/v2/users/import/{sourceId}/csv"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"type\": \"StatusCodeException\",\r\n \"title\": \"An error occurred while processing your request.\",\r\n \"status\": 500,\r\n \"detail\": \"User import source with id {sourceId} is disabled.\",\r\n \"traceId\": \"{trace_identifier}\",\r\n \"message\": \"User import source with id {sourceId} is disabled.\"\r\n}"},{"id":"1bb01328-4552-4de1-b560-e7f732ba1dcb","name":"Unsuccessful processing of the CSV file","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","contentType":"text/csv","value":null}]},"url":"https://api-integration.eventicious.ru/api/external/v2/users/import/{sourceId}/csv"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"type\": \"AttendeesImportValidationError\",\r\n \"title\": \"An error occurred while processing your request.\",\r\n \"status\": 500,\r\n \"detail\": \"{fail_reason}\",\r\n \"traceId\": \"{trace_identifier}\",\r\n \"message\": \"{fail_reason}\"\r\n}"},{"id":"fd8b0936-1a3e-4737-bbec-ed2a81b531d3","name":"Unsuccessful processing of the CSV file with empty first row","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","contentType":"text/csv","value":null}]},"url":"https://api-integration.eventicious.ru/api/external/v2/users/import/{sourceId}/csv"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"type\": \"AttendeesImportValidationError\",\r\n \"title\": \"An error occurred while processing your request.\",\r\n \"status\": 500,\r\n \"detail\": \"The provided csv import file is empty\",\r\n \"traceId\": \"{trace_identifier}\",\r\n \"message\": \"The provided csv import file is empty\"\r\n}"},{"id":"81cf0467-65cb-4b90-a3fa-6a5afe6f7c14","name":"Unsuccessful processing of the CSV file with no required fields provided","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","contentType":"text/csv","value":null}]},"url":"https://api-integration.eventicious.ru/api/external/v2/users/import/{sourceId}/csv"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"type\": \"AttendeesImportValidationError\",\r\n \"title\": \"An error occurred while processing your request.\",\r\n \"status\": 500,\r\n \"detail\": \"The provided csv import file does not contain some required fields: '{comma_separated_missing_required_fields}'\",\r\n \"traceId\": \"{trace_identifier}\",\r\n \"message\": \"The provided csv import file does not contain some required fields: '{comma_separated_missing_required_fields}'\"\r\n}"}],"_postman_id":"629d5257-ae74-45d8-b5ae-bf01efb0e638"}],"id":"6d856398-478e-4d09-9859-c14c7ef1dad6","description":"

The Event Rocks platform allows to synchronize an attendee's list with an external system by uploading the attendees' list as a CSV file.

Contact the Event Rocks Support Team for information about the required CSV file format. You will be given a unique sourceId parameter that is used in the method to upload the CSV file.

Attendees are synchronized on a scheduled basis once a day. In case of uploading several CSV files - synchronization will be performed by the last uploaded file.

Logic of attendees synchronization:

If an attendee is present in the uploaded file, but absent in the Event Rocks platform - a new attendee is created in the Event Rocks platform.
\n
If an attendee was previously present in the file, but is absent during the next synchronization - this attendee is deleted from the Event Rocks platform.
\n
If an attendee is present both in the file and the Event Rocks platform - the attendee' information in the Event Rocks platform is updated in accordance with the information specified in the file.
\n

\n","_postman_id":"6d856398-478e-4d09-9859-c14c7ef1dad6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":true,"source":{"_postman_id":"3a51a583-325a-44fd-8ed7-26ce86b43829","id":"3a51a583-325a-44fd-8ed7-26ce86b43829","name":"Eventicious External API V2 (Events)","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["const moment = require('moment')\r","\r","const getJWT = {\r"," url: `${pm.collectionVariables.get('baseUrl')}/connect/token`,\r"," method: 'POST',\r"," header: {\r"," 'Content-Type': 'application/x-www-form-urlencoded'\r"," \r"," },\r"," body: {\r"," mode: 'urlencoded',\r"," urlencoded: [\r"," {key: 'grant_type', value: 'client_credentials'},\r"," {key: 'client_id', value: `${pm.collectionVariables.get('client_id')}`},\r"," {key: 'client_secret', value: `${pm.collectionVariables.get('client_secret')}`}\r"," //{key: 'scope', value: ''}\r"," ]\r"," }\r","}\r","\r","var getToken = true\r","\r","if (!_.has(pm.collectionVariables.toObject(), 'AccessTokenExpiry') \r"," || !_.has(pm.collectionVariables.toObject(), 'bearer_token')\r"," || pm.collectionVariables.get('AccessTokenExpiry') <= moment().valueOf()) {\r","} else {\r"," getToken = false\r","}\r","\r","if (getToken) {\r"," pm.sendRequest(getJWT, (err, res) => {\r"," if (err === null) {\r"," pm.collectionVariables.set('bearer_token', `${res.json().access_token}`)\r"," \r"," var expiryDate = moment().add(res.json().expires_in, 's').valueOf()\r"," pm.collectionVariables.set('AccessTokenExpiry', expiryDate)\r"," }\r"," })\r","}"],"id":"1c2d44a4-147a-48e4-b9ee-93b0a735d335"}},{"listen":"test","script":{"type":"text/javascript","exec":["var code = pm.response.code;\r","\r","if (code == 401 || code == 403) {\r"," pm.collectionVariables.set('AccessTokenExpiry', \"\")\r","}"],"id":"18da1978-2b84-4f93-881b-14f9b98a5989"}}],"variable":[{"key":"baseUrl","value":"https://api-integration.eventicious.ru"},{"key":"bearer_token","value":"token","type":"string"},{"key":"client_id","value":"cl-21-234181dd-d87c-4244-b480-fe1b6b31fab8","type":"string"},{"key":"client_secret","value":"cs-21-aa26ba97-17d3-4ad0-abba-6082d4a6d46a","type":"string"},{"key":"AccessTokenExpiry","value":"","type":"string"}]}