Workshop Session

Here are the steps and API endpoints to join Workshop Session in the Accelevents platform.

Workshop Session

Calling these following API sequences will help you to join the workshop session in the Accelevents platform

Steps	Description	API Reference
Get all workshop sessions	Get all the workshop session list.	Click Here
Join session	Check if all the requirement is fulfilled like if attendee has required ticket for that session / session is live / session capacity has exceeded or not. If all requirement are fulfilled then user is registered for that session.	Click here

1. Get all workshop session

First, we need to get all workshop sessions that are currently live as if session time is in the future or already ended you won't be able to join that session.

To get the live main stage workshop session list you can use below API endpoint. To only get all available live sessions for the workshop you need to pass sessionFormat as WORKSHOP.

developer.accelevents.com

Get all sessions for display and portal page

You can also pass other query parameters such as page , size, past, sessionFormat, expand, currentUserRegisteredEventTicketId, status for further filter sessions and get response data accordingly.

Here is a sample response, which will be returned by API.

{
  "recordsTotal": 2,
  "recordsFiltered": 2,
  "data": [
    {
      "sessionId": 11655,
      "title": "First Workshop Session",
      "startTime": "2021/12/20 17:36",
      "endTime": "2021/12/20 18:36",
      "location": null,
      "description": null,
      "format": "WORKSHOP",
      "speakerList": [
        {
          "speakerId": 5758,
          "title": null,
          "pronouns": null,
          "firstName": "Jay",
          "lastName": "Dobariya",
          "email": "[email protected]",
          "sessionDTO": null,
          "userId": 8528,
          "imageUrl": null,
          "company": null,
          "bio": null,
          "linkedIn": null,
          "twitter": null,
          "instagram": null,
          "position": 2000.0,
          "moderator": true,
          "ticketTypesForSpeaker": null,
          "allowAttendeeAccess": false,
          "loggedInAtVEH": false,
          "showModerator": true,
          "deviceChecked": false,
          "allowOverrideDetails": false
        }
      ],
      "currentUserRegisteredEventTicketId": null,
      "tracks": [
        
      ],
      "streamProvider": null,
      "streamUrl": null,
      "rtmpUrl": null,
      "meetingPassword": null,
      "sessionVisibilityType": "PUBLIC",
      "sponsorList": [
        
      ],
      "recordSession": true,
      "hideVideoControls": false,
      "exihiborList": [
        
      ],
      "postSessionCallToActionJson": null,
      "playBackRestrictionToken": null,
      "thumbnailRestrictionToken": null
    },
    {
      "sessionId": 11656,
      "title": "First Workshop SessionCOPY1",
      "startTime": "2021/12/20 17:36",
      "endTime": "2021/12/20 18:36",
      "location": null,
      "description": null,
      "format": "WORKSHOP",
      "speakerList": [
        {
          "speakerId": 5758,
          "title": null,
          "pronouns": null,
          "firstName": "Jay",
          "lastName": "Dobariya",
          "email": "[email protected]",
          "sessionDTO": null,
          "userId": 8528,
          "imageUrl": null,
          "company": null,
          "bio": null,
          "linkedIn": null,
          "twitter": null,
          "instagram": null,
          "position": 2000.0,
          "moderator": true,
          "ticketTypesForSpeaker": null,
          "allowAttendeeAccess": false,
          "loggedInAtVEH": false,
          "showModerator": true,
          "deviceChecked": false,
          "allowOverrideDetails": false
        }
      ],
      "currentUserRegisteredEventTicketId": null,
      "tracks": [
        
      ],
      "streamProvider": null,
      "streamUrl": null,
      "rtmpUrl": null,
      "meetingPassword": null,
      "sessionVisibilityType": "PUBLIC",
      "sponsorList": [
        
      ],
      "recordSession": true,
      "hideVideoControls": false,
      "exihiborList": [
        
      ],
      "postSessionCallToActionJson": null,
      "playBackRestrictionToken": null,
      "thumbnailRestrictionToken": null
    }
  ],
  "error": null,
  "pastSession": true,
  "upComingSession": true
}

2. Join session

🚧
Note
If you have not purchased a ticket for the session then, you can't join sessions.

In this step, you will register the attendee for a particular workshop session. From step 1, you need to identify sessionId for which you need to register an attendee.

developer.accelevents.com

Above API will check all requirements to join a session and get a response 200 status code then attendee has registered for the session. If any criteria are not full-filled then it will return an error with the proper error message.

Criteria	Error code	Error message
Session does not exist	404	Session not found!
Session has reached its max capacity	406	Max user registration capacity reached
Ticket type not matching	406	Your ticket does not permit access to this session
If your purchased ticket type restricts the number of sessions you can join, and you have reached that limit	406	Your registration type only permits registering for {number_of_sessions_permitted} sessions. If you would like to register for this session please un-register from a different session first
The session should currently be live	407	The time limit for accessing this session is expired

If the attendee has successfully registered for the session then you can call the below API to get session detail where you will get meeting & attendee details using that you can join chime meeting.