Event Management API (ENG)

Event Management API (ENG)

Event Management API

Introduction

This API is used to manage Events, and Event Participants. It can be used to create, edit, delete and list Events and Participants.

TOKEN

All request made to the following API endpoints require a token.
The token should be provided in the headers as:
Authorization: Bearer <token>

A token consists of 40 character long hex value. The value has two different parts:
  1. Current time [32 bits / 8 chars] - current timestamp in number of seconds since UNIX Epoch
  2. Signature [128 bits / 32 chars] - the MD5 hash of (organizationId + ":" + Current time + ":" + Secret + ":" + IP Address), where '+' is a string concatenation

    Secret: A secret key that is only present on the client creating the token and the server verifying the token that is Organization specific.
Example:
organizationId: 13509
Current time: 1622091600000 (27.05.2021 05:00:00 UTC) -> '60af2750'
Secret: 'secret'
Signature: MD5('13509:60af2750:secret:185.185.165.160') -> '7c39fec85881c1d8ebb0064b83f5edd8'
Generated token: '60af27507c39fec85881c1d8ebb0064b83f5edd8'

API PATH: Event Management

/api/event

API CALLS

Create Event

Creates a new Event.

Request
Method: POST
HTTP Request Parameters: None
Request body: Event Creation JSON Object

Event Creation JSON Object:
Key
Value
Requirement
Info
organizationId
Number
Mandatory
Suite Organization ID
event
Object
Mandatory
See Event Data JSON Object


Event Data JSON Object:
Key
Value
Requirement
Info
name
String or Object
Mandatory
Name of the event. If provided as a String, the name will be saved as the default language ('en' by default, unless provided). If provided as an Object, translations should be provided as {"en_US": "english name", "fi_FI": "finnish name"}. See 'supported languages'
description
String or Object
Optional
Description of the event. If provided as a String, the description will be saved as the default language ('en' by default, unless provided). If provided as an Object, translations should be provided as {"en_US": "english name", "fi_FI": "finnish name"}. See 'supported languages'
publicName
String or Object
Optional
Public name of the event. If provided as a String, the public name will be saved as the default language ('en' by default, unless provided). If provided as an Object, translations should be provided as {"en_US": "english name", "fi_FI": "finnish name"}. See 'supported languages'
startTime
Number
Mandatory
Start time of the event, milliseconds since UNIX Epoch
duration
Number
Mandatory
Duration of the event, in seconds
startTimePublic
Number
Optional
Public start time of the event, milliseconds since UNIX Epoch
durationPublic
Number
Optional (required if 'startTimePublic' provided)
Public duration of the event, in seconds
accessControl (Currently unsupported)
Object (Currently unsupported)
Optional (Currently unsupported)
See access control object (Currently unsupported)
eventTheme
Number
Optional
Suite Event Theme ID
eventThumbnail
String
Optional
URL to the thumbnail image of the event
defaultLanguage
String
Optional
Sets the default language of the event. Default 'en_US'.
eventLanguages
Array
Optional
List of available languages for the event. i.e. ["en_US", "fi_FI"]. Default language is added by default.
gdpr
Object
Optional
See GDPR object
externalId
String
Optional
External Event Id


Supported Languages
Currently the following languages are supported for events:
English ("en_US")
Finnish ("fi_FI")
Spanish ("es_ES")
Swedish ("sv_SE")

Access Control Object
A JSON object representing the Access Control Type of an event. The content of the object depends on the type of Access Control being created, however it should always contain the "access_control_type" key specifying the type of Access Control being created. Currently supported Access Control types by the API: 7 (Personal Link)

CURRENTLY UNSUPPORTED

Access Control: Personal Link object
Key
Value
Requirement
Info
accessControlType
Number
Mandatory
Value for type Personal Link: 7

GDPR object
Key
Value
Requirement
Info
termsOfService
String or Object
Optional
Terms of Service text. If provided as a String, the terms of service will be saved as the default language ('en' by default, unless provided). If provided as an Object, translations should be provided as {"en_US": "english terms", "fi_FI": "finnish terms"}. See 'supported languages'
privacyPolicy
String or Object
Optional
Privacy Policy text. If provided as a String, the privacy policy will be saved as the default language ('en' by default, unless provided). If provided as an Object, translations should be provided as {"en_US": "english terms", "fi_FI": "finnish terms"}. See 'supported languages'
copyright
String or Object
Optional
Copyright text. If provided as a String, the copyright will be saved as the default language ('en' by default, unless provided). If provided as an Object, translations should be provided as {"en_US": "english copyright", "fi_FI": "finnish copyright"}. See 'supported languages'

Example JSON Object for creating a new Event:
  1. {
  2.     "organizationId": 1909009,
  3.     "event": {
  4.         "name": {
  5.             "en_US": "English name",
  6.             "fi_FI": "Finnish name"
  7.         },
  8.         "description": {
  9.             "en_US": "English description",
  10.             "fi_FI": "Finnish description"
  11.         },
  12.         "publicName": {
  13.             "en_US": "English public name",
  14.             "fi_FI": "Finnish public name"
  15.         },
  16.         "startTime": 1637913600000,
  17.         "duration": 12600,
  18.         "startTimePublic": 1637914500000,
  19.         "durationPublic": 11700,
  20.         "eventTheme": 3319901,
  21.         "eventLanguages": ["en_US", "fi_FI"],
  22.         "gdpr": {
  23.             "termsOfService": {
  24.                 "en_US": "English terms of service text.",
  25.                 "fi_FI": "Finnish terms of service text."
  26.             },
  27.             "privacyPolicy": {
  28.                 "en_US": "English privacy policy text.",
  29.                 "fi_FI": "Finnish privacy policy text."
  30.             },
  31.             "copyright": {
  32.                 "en_US": "English copyright text.",
  33.                 "fi_FI": "Finnish copyright text."
  34.             }
  35.         }
  36.     }
  37. }
After a successful call to the API, you will get a HTTP 200 response with a JSON object containing "status": "ok", and the "event" object containing information of the newly created event, including "event_id". Here is a sample response from the above example creation JSON:
  1. {
  2.     "status": "ok",
  3.     "event": {
  4.         "restrictions": [],
  5.         "isMultiroom": true,
  6.         "mainEventRoomId": 3697602,
  7.         "embedUrl": "https://suiterc.icareus.com/web/test-account/player/embed/event/view?eventId=3697601",
  8.         "startTimePublic": 1637914500000,
  9.         "defaultLanguage": "en_US",
  10.         "durationPublic": 11700,
  11.         "publishingInfo": {
  12.             "serviceId": 0,
  13.             "ingestUrl": ""
  14.         },
  15.         "startTime": 1637913600000,
  16.         "eventTheme": 3319901,
  17.         "duration": 12600,
  18.         "eventLanguages": [
  19.             "en_US",
  20.             "fi_FI"
  21.         ],
  22.         "eventId": 3697601,
  23.         "serviceId": 0,
  24.         "publicName": {
  25.             "en_US": "English public name",
  26.             "fi_FI": "Finnish public name"
  27.         },
  28.         "description": {
  29.             "en_US": "English description",
  30.             "fi_FI": "Finnish description"
  31.         },
  32.         "name": {
  33.             "en_US": "English name",
  34.             "fi_FI": "Finnish name"
  35.         },
  36.         "accessControls": [],
  37.         "gdpr": {
  38.             "privacyPolicy": {
  39.                 "en_US": "English privacy policy text.",
  40.                 "fi_FI": "Finnish privacy policy text."
  41.             },
  42.             "copyright": {
  43.                 "en_US": "English copyright text.",
  44.                 "fi_FI": "Finnish copyright text."
  45.             },
  46.             "termsOfService": {
  47.                 "en_US": "English terms of service text.",
  48.                 "fi_FI": "Finnish terms of service text."
  49.             }
  50.         },
  51.         "categories": [],
  52.         "rooms": [
  53.             {
  54.                 "eventTheme": 3319901,
  55.                 "startTime": 1637913600000,
  56.                 "duration": 12600,
  57.                 "recordings": [],
  58.                 "serviceId": 1909939,
  59.                 "eventId": 3697601,
  60.                 "description": {
  61.                     "en_US": "This is the main room"
  62.                 },
  63.                 "publicName": {
  64.                     "en_US": "Main room"
  65.                 },
  66.                 "name": {
  67.                     "en_US": "Main Room"
  68.                 },
  69.                 "embedUrl": "https://suiterc.icareus.com/web/test-account/player/embed/event/view?eventId=3697601&roomId=3697602",
  70.                 "roomId": 3697602,
  71.                 "publishingInfo": {
  72.                     "ingestUrl": "rtmp://sample.origin.icareus.com:1935/suitelive",
  73.                     "streamName": 1909939
  74.                 }
  75.             }
  76.         ]
  77.     }
  78. }

Edit Event

Edits an existing Event.

Request
Method: PUT
HTTP Request Parameters: None
Request body: Event Update JSON Object

Event Update JSON Object
Key
Value
Requirement
Info
organizationId
Number
Mandatory
Suite Organizattion ID
eventId
Number
Mandatory
ID of the event being edited
event
Object
Mandatory
See Event Data JSON Object (from Create Event)

The "event" object here is identical to the one used when creating an event, with the exception that all keys are optional. Only the provided keys are updated in the existing event, while keys not provided are left unchanged.

Example JSON Object for editing the sample from create event to also include Swedish name, description and public name. And adding Swedish as one of the event languages:
  1. {
  2.     "organizationId": 1909009,
  3.     "eventId": 3697601,
  4.     "event": {
  5.         "name": {
  6.             "sv_SE": "Swedish name"
  7.         },
  8.         "description": {
  9.             "sv_SE": "Swedish description"
  10.         },
  11.         "publicName": {
  12.             "sv_SE": "Swedish public name"
  13.         },
  14.         "eventLanguages": ["en_US", "fi_FI", "sv_SE"]
  15.     }
  16. }
Successful PUT call will result in a HTTP Status code 200. Response will contain status ok and the updated event object. Here is a sample response from updating an event with the above JSON:
  1. {
  2.     "status": "ok",
  3.     "event": {
  4.         "restrictions": [],
  5.         "isMultiroom": true,
  6.         "mainEventRoomId": 3697602,
  7.         "embedUrl": "https://suiterc.icareus.com/web/test-account/player/embed/event/view?eventId=3697601",
  8.         "startTimePublic": 1637914500000,
  9.         "defaultLanguage": "en_US",
  10.         "durationPublic": 11700,
  11.         "publishingInfo": {
  12.             "serviceId": 0,
  13.             "ingestUrl": ""
  14.         },
  15.         "startTime": 1637913600000,
  16.         "eventTheme": 3319901,
  17.         "duration": 12600,
  18.         "eventLanguages": [
  19.             "en_US",
  20.             "fi_FI",
  21.             "sv_SE"
  22.         ],
  23.         "eventId": 3697601,
  24.         "serviceId": 0,
  25.         "publicName": {
  26.             "en_US": "English public name",
  27.             "sv_SE": "Swedish public name",
  28.             "fi_FI": "Finnish public name"
  29.         },
  30.         "description": {
  31.             "en_US": "English description",
  32.             "sv_SE": "Swedish description",
  33.             "fi_FI": "Finnish description"
  34.         },
  35.         "name": {
  36.             "en_US": "English name",
  37.             "sv_SE": "Swedish name",
  38.             "fi_FI": "Finnish name"
  39.         },
  40.         "accessControls": [],
  41.         "gdpr": {
  42.             "privacyPolicy": {
  43.                 "en_US": "English privacy policy text.",
  44.                 "fi_FI": "Finnish privacy policy text."
  45.             },
  46.             "copyright": {
  47.                 "en_US": "English copyright text.",
  48.                 "fi_FI": "Finnish copyright text."
  49.             },
  50.             "termsOfService": {
  51.                 "en_US": "English terms of service text.",
  52.                 "fi_FI": "Finnish terms of service text."
  53.             }
  54.         },
  55.         "categories": [],
  56.         "rooms": [
  57.             {
  58.                 "eventTheme": 3319901,
  59.                 "startTime": 1637913600000,
  60.                 "duration": 12600,
  61.                 "recordings": [],
  62.                 "serviceId": 1909939,
  63.                 "eventId": 3697601,
  64.                 "description": {
  65.                     "en_US": "This is the main room"
  66.                 },
  67.                 "publicName": {
  68.                     "en_US": "Main room"
  69.                 },
  70.                 "name": {
  71.                     "en_US": "Main Room"
  72.                 },
  73.                 "embedUrl": "https://suiterc.icareus.com/web/test-account/player/embed/event/view?eventId=3697601&roomId=3697602",
  74.                 "roomId": 3697602,
  75.                 "publishingInfo": {
  76.                     "ingestUrl": "rtmp://sample.origin.icareus.com:1935/suitelive",
  77.                     "streamName": 1909939
  78.                 }
  79.             }
  80.         ]
  81.     }
  82. }

Delete Event

Deletes an existing event

Request
Method: DELETE
HTTP Request Parameters:
Name
Value
Requirement
Info
eventId
Number
Mandatory
ID of the event to be deleted.
organizationId
Number
Mandatory
Suite Organization ID

Get Event

Retrieve information about a specific event.

Request
Method: GET
HTTP Request Parameters:
Name
Value
Requirement
Info
eventId
Number
Mandatory
ID of the event to fetch
organizationId
Number
Mandatory
Suite Organization ID

API PATH: Room Management

/api/event/room

API CALLS

Create Room

Creates an Event Room

Request
Method: POST
HTTP Request Parameters: None
Request body: Event Room Creation JSON Object

Event Room Creation JSON Object

Key
Value
Requirement
Info
organizationId
Number
Mandatory
Suite Organization ID
eventId
Number
Mandatory
ID of the event the room is being added to
room
Object
Mandatory
See Event Room Data JSON Object

Event Room Data JSON Object

Key
Value
Requirement
Info
name
String or Object
Mandatory
Name of the room. If provided as a String, the name will be saved as the default language ('en' by default, unless provided). If provided as an Object, translations should be provided as {"en_US": "english name", "fi_FI": "finnish name"}. See 'supported languages'
description
String or Object
Optional
Description of the room. If provided as a String, the description will be saved as the default language ('en' by default, unless provided). If provided as an Object, translations should be provided as {"en_US": "english name", "fi_FI": "finnish name"}. See 'supported languages'
publicName
String or Object
Optional
Public name of the room. If provided as a String, the public name will be saved as the default language ('en' by default, unless provided). If provided as an Object, translations should be provided as {"en_US": "english name", "fi_FI": "finnish name"}. See 'supported languages'
startTime
Number
Mandatory
Start time of the room, millis since UNIX Epoch. Cannot be before top-level event's startTime
duration
Number
Mandatory
Duration of the room, in seconds. NOTE: The room cannot end after the top-level event. So a room's startTime + duration cannot be higher than the top-level event's startTime+duration.
startTimePublic
Number
Optional
Public start time of the room, milliseconds since UNIX Epoch. Public start time cannot be before startTime
durationPublic
Number
Optional
Public duration of the room, in seconds. This is mandatory if startTimePublic is provided.
eventTheme
Number
Optional
ID of the Event Theme to use with this room. If not provided, first available Event Theme will be selected.
serviceId
Number
Optional
ID of the Suite Linear Channel to use with this room. If not provided, first available Linear Channel will be randomly selected. Notice that you cannot have two rooms using the same Linear Channel simultaneously.

Example JSON Object for creating a Room:
  1. {
  2.     "organizationId": 1909009,
  3.     "eventId": 3697601,
  4.     "room": {
  5.         "name": {
  6.             "en_US": "English room name",
  7.             "fi_FI": "Finnish room name"
  8.         },
  9.         "description": {
  10.             "en_US": "English room description",
  11.             "fi_FI": "Finnish room description"
  12.         },
  13.         "publicName": {
  14.             "en_US": "English room public name",
  15.             "fi_FI": "Finnish room public name"
  16.         },
  17.         "startTime": 1637913600000,
  18.         "duration": 12600,
  19.         "startTimePublic": 1637914500000,
  20.         "durationPublic": 11700,
  21.         "eventTheme": 3319901,
  22.         "serviceId": 2977205
  23.     }
  24. }
Successful POST call to /api/event/room will result in HTTP status code 200 and the response will provide a JSON Object with status ok and the event object with the newly added room listed in the rooms array:
  1. {
  2.     "status": "ok",
  3.     "event": {
  4.         "restrictions": [],
  5.         "isMultiroom": true,
  6.         "mainEventRoomId": 3697602,
  7.         "embedUrl": "https://suiterc.icareus.com/web/test-account/player/embed/event/view?eventId=3697601",
  8.         "startTimePublic": 1637914500000,
  9.         "defaultLanguage": "en_US",
  10.         "durationPublic": 11700,
  11.         "publishingInfo": {
  12.             "serviceId": 0,
  13.             "ingestUrl": ""
  14.         },
  15.         "startTime": 1637913600000,
  16.         "eventTheme": 3319901,
  17.         "duration": 12600,
  18.         "eventLanguages": [
  19.             "en_US",
  20.             "fi_FI",
  21.             "sv_SE"
  22.         ],
  23.         "eventId": 3697601,
  24.         "serviceId": 0,
  25.         "publicName": {
  26.             "en_US": "English public name",
  27.             "sv_SE": "Swedish public name",
  28.             "fi_FI": "Finnish public name"
  29.         },
  30.         "description": {
  31.             "en_US": "English description",
  32.             "sv_SE": "Swedish description",
  33.             "fi_FI": "Finnish description"
  34.         },
  35.         "name": {
  36.             "en_US": "English name",
  37.             "sv_SE": "Swedish name",
  38.             "fi_FI": "Finnish name"
  39.         },
  40.         "accessControls": [],
  41.         "gdpr": {
  42.             "privacyPolicy": {
  43.                 "en_US": "English privacy policy text.",
  44.                 "fi_FI": "Finnish privacy policy text."
  45.             },
  46.             "copyright": {
  47.                 "en_US": "English copyright text.",
  48.                 "fi_FI": "Finnish copyright text."
  49.             },
  50.             "termsOfService": {
  51.                 "en_US": "English terms of service text.",
  52.                 "fi_FI": "Finnish terms of service text."
  53.             }
  54.         },
  55.         "categories": [],
  56.         "rooms": [
  57.             {
  58.                 "recordings": [],
  59.                 "startTimePublic": 1637914500000,
  60.                 "embedUrl": "https://suiterc.icareus.com/web/test-account/player/embed/event/view?eventId=3697601&roomId=3698301",
  61.                 "roomId": 3698301,
  62.                 "durationPublic": 11700,
  63.                 "publishingInfo": {
  64.                     "ingestUrl": "rtmp://sample.origin.icareus.com:1935/suitelive",
  65.                     "streamName": 2977205
  66.                 },
  67.                 "startTime": 1637913600000,
  68.                 "eventTheme": 3319901,
  69.                 "duration": 12600,
  70.                 "eventId": 3697601,
  71.                 "serviceId": 2977205,
  72.                 "publicName": {
  73.                     "en_US": "English room public name",
  74.                     "fi_FI": "Finnish room public name"
  75.                 },
  76.                 "description": {
  77.                     "en_US": "English room description",
  78.                     "fi_FI": "Finnish room description"
  79.                 },
  80.                 "name": {
  81.                     "en_US": "English room name",
  82.                     "fi_FI": "Finnish room name"
  83.                 }
  84.             },
  85.             {
  86.                 "eventTheme": 3319901,
  87.                 "startTime": 1637913600000,
  88.                 "duration": 12600,
  89.                 "recordings": [],
  90.                 "serviceId": 1909939,
  91.                 "eventId": 3697601,
  92.                 "description": {
  93.                     "en_US": "This is the main room"
  94.                 },
  95.                 "publicName": {
  96.                     "en_US": "Main room"
  97.                 },
  98.                 "name": {
  99.                     "en_US": "Main Room"
  100.                 },
  101.                 "embedUrl": "https://suiterc.icareus.com/web/test-account/player/embed/event/view?eventId=3697601&roomId=3697602",
  102.                 "roomId": 3697602,
  103.                 "publishingInfo": {
  104.                     "ingestUrl": "rtmp://sample.origin.icareus.com:1935/suitelive",
  105.                     "streamName": 1909939
  106.                 }
  107.             }
  108.         ]
  109.     }
  110. }

Edit Room

Edits an existing Room.
Request
Method: PUT
HTTP Request Parameters: None
Request Body: Room Update JSON Object

Room Update JSON Object

Key
Value
Requirement
Info
organizationId
Number
Mandatory
Suite Organization ID
roomId
Number
Mandatory
ID of the Room being edited
room
Object
Mandatory
See Room Data JSON Object

The "room" object here is identical to the one used when creating a room, with the exception that all keys are optional. Only the provided keys are updated in the existing event, while keys not provided are left unchanged.

Example JSON Object for editing the sample from create event, to edit the automatically created main room:
  1. {
  2.     "organizationId": 1909009,
  3.     "roomId": 3697602,
  4.     "room": {
  5.         "name": {
  6.             "en_US": "English main room name",
  7.             "fi_FI": "Finnish main room name"
  8.         },
  9.         "description": {
  10.             "en_US": "English main room description",
  11.             "fi_FI": "Finnish main room description"
  12.         },
  13.         "publicName": {
  14.             "en_US": "English main room public name",
  15.             "fi_FI": "Finnish main room public name"
  16.         }
  17.     }
  18. }
Successful PUT call will result in a HTTP Status code 200. Response will contain status ok and the updated room object. Here is a sample response from updating an event with the above JSON:
  1. {
  2.     "status": "ok",
  3.     "room": {
  4.         "eventTheme": 3319901,
  5.         "startTime": 1637913600000,
  6.         "duration": 12600,
  7.         "recordings": [],
  8.         "serviceId": 1909939,
  9.         "eventId": 3697601,
  10.         "description": {
  11.             "en_US": "English main room description",
  12.             "fi_FI": "Finnish main room description"
  13.         },
  14.         "publicName": {
  15.             "en_US": "English main room public name",
  16.             "fi_FI": "Finnish main room public name"
  17.         },
  18.         "name": {
  19.             "en_US": "English main room name",
  20.             "fi_FI": "Finnish main room name"
  21.         },
  22.         "embedUrl": "https://suiterc.icareus.com/web/test-account/player/embed/event/view?eventId=3697601&roomId=3697602",
  23.         "roomId": 3697602,
  24.         "publishingInfo": {
  25.             "ingestUrl": "rtmp://sample.origin.icareus.com:1935/suitelive",
  26.             "streamName": 1909939
  27.         }
  28.     }
  29. }

Get Room

Gets a single room.
Request
Method: GET
HTTP Request Parameters

Name
Value
Requirement
Info
organizationId
Number
Mandatory
Suite Organization ID
roomId
Number
Mandatory
ID of the Room to get

A successful response will return HTTP status code 200 and a JSON object with status ok and an object 'room' representing a single Room:
  1. {
  2.     "status": "ok",
  3.     "room": {
  4.         "eventTheme": 3319901,
  5.         "startTime": 1637913600000,
  6.         "duration": 12600,
  7.         "recordings": [],
  8.         "serviceId": 1909939,
  9.         "eventId": 3697601,
  10.         "description": {
  11.             "en_US": "English main room description",
  12.             "fi_FI": "Finnish main room description"
  13.         },
  14.         "publicName": {
  15.             "en_US": "English main room public name",
  16.             "fi_FI": "Finnish main room public name"
  17.         },
  18.         "name": {
  19.             "en_US": "English main room name",
  20.             "fi_FI": "Finnish main room name"
  21.         },
  22.         "embedUrl": "https://suiterc.icareus.com/web/test-account/player/embed/event/view?eventId=3697601&roomId=3697602",
  23.         "roomId": 3697602,
  24.         "publishingInfo": {
  25.             "ingestUrl": "rtmp://sample.origin.icareus.com:1935/suitelive",
  26.             "streamName": 1909939
  27.         }
  28.     }
  29. }

Delete Room

Deletes a room
Request
Method: DELETE
HTTP Request Parameters

Name
Value
Requirement
Info
organizationId
Number
Mandatory
Suite Organization ID
roomId
Number
Mandatory
ID of the Room to delete

A successfull DELETE call will result in a response with HTTP Status code 200 and will contain a JSON object with the status ok.

API PATH: Event Images

/api/event/images

API CALLS

ADD THUMBNAIL

Adds a thumbnail image to an Event or a Room.

Request
Method: POST
HTTP Request Parameters
Name
Value
Requirement
Info
organizationId
Number
Mandatory
Suite Organization ID
action
String: 'addThumbnail'
Mandatory
Value should be: addThumbnail
eventId
Number
Optional
Either eventId or roomId must be provided
roomId
Number
Optional
Either roomId or eventId must be provided

Form Data
The image should be provided within Form Data with the field name 'thumbnail'.

REMOVE THUMBNAIL

Removes the thumbnail image from the specified Event or Room

Request
Method: POST
HTTP Request Parameters

Name
Value
Requirement
Info
organizationId
Number
Mandatory
Suite Organization ID
action
String: 'removeThumbnail'
Mandatory
Value should be: removeThumbnail
eventId
Number
Optional
Either eventId or roomId must be provided
roomId
Number
Optional
Either roomId or eventId must be provided

A successful call will return a response with HTTP status code 200 and a JSON Object containing the information about the Event or Room that was edited.

API PATH

/api/event/participant

CURRENTLY UNSUPPORTED

API CALLS

Create Participant

Create an Event Participant. The Participant is attached to the

Request
Method: POST
HTTP Request Parameters: None
Request body: Participant creation JSON Object

Participant creation JSON Object
Key
Value
Requirement
Info
organizationId
Number
Mandatory
Suite Organization ID
eventId
Number
Mandatory
Suite Event ID
participant
Object
Mandatory
See Participant Object

Participant Object
Key
Value
Requirement
Info
emailAddress
String
Mandatory
User's email address
firstName
String
Optional
User's first name
lastName
String
Optional
User's last name
company
String
Optional
Name of the company / organization the user is a part of.
blocked
Boolean
Optional (Defaults to 'true')
Whether or not user is blocked from accessing the event.

Example Participant creation JSON:
  1. {
  2.     "organization_id": 1234,
  3.     "event_id": 4321,
  4.     "participant": {
  5.         "email_address": "user@email-address.com",
  6.         "first_name": "First name",
  7.         "last_name": "Last name",
  8.         "company": "Company name",
  9.         "blocked": false
  10.     }
  11. }
After a successful call to the API, you will get a response with HTTP status 200, the response JSON will contain "status": "ok", and and "participant" object containing information about the newly created participant, including "participant_id" and "access_url" (which is the unique access link that lets the participant enter the event page).

Edit Participant

Edits the specified Event Participant

Request
Method: PUT
HTTP Request Parameters: None
Request Body: Event Participant Update Object

Event Participant Update Object

Key
Value
Requirement
Info
organizationId
Number
Mandatory
Suite Organization ID
eventId
Number
Mandatory
Suite Event ID
participantId
Number
Mandatory
Suite Event Participant ID
participant
Object
Mandatory
See Participant Object

The "particiapant" object here is identical to the one used when creating an event participant, with the exception that all keys are optional. Only the provided keys are updated in the existing event participant, while keys not provided are left unchanged.

Delete Participant

Deletes the specified Event Participant

Request
Method: DELETE
HTTP Request Parameters:
Name
Value
Requirement
Info
participantId
Number
Mandatory
ID of the Event Participant to be deleted
eventId
Number
Mandatory
ID of the Event the participant belongs to


Get Participant

Retrieves information about the specified Event Participant

Request
Method: GET
HTTP Request Parameters:
Name
Value
Requirement
Info
participantId
Number
Mandatory
ID of the Event Participant to be fetched
eventId
Number
Mandatory
ID of the Event



















    • Related Articles

    • Account Management API (ENG)

      INTRODUCTION The API is used to manage Icareus Suite users and organisations. USE CASES Adding sub organization API Calls flow to add sub organization: Create an organization Add User Assign User Assign User role API PATH /delegate/account API ...

    • Event Recording API (ENG)

      Introduction This API is used to start and stop the recording of a Icareus Suite Channel. The system automatically links the recording to an event (e.g. Webinar) that is on the channel. The logic for linkin is the following: Warning API requires a ...

    • Devices API (ENG)

      INTRODUCTION Devices API is used to register devices to the server and get device specific information/configurations from the server. API PATH /api/devices It is recommended to use POST request. Latest version: 02 API METHODS REGISTER A DEVICE ...

    • Event & Webinar Player

      Themes for an event or webinar page are defined under Events -> Event themes. Themes provide a versatile and easy way to customise the look and feel of your event. Options for customizing an event There are four options: Event and webinar player as a ...

    • Channels Management API

      Introduction This API is used to manage Linear Channels. Authorization All requests made to the following API endpoints require a token. The token should be provided in the headers as: Authorization: Bearer <token> The token should either be a valid ...