Events

>>>

GET /api/v2/events/:id/users
Get the realtime event_group_user using a user's email

Also see POST /v2/events/:id/groups/:access_key.

Return an event_group_user object using an email and event id.

Errors

Code Description
422 Unable to process request, see errors in response

Examples

response:
{
  "eventGroupUser":{
    "id":123456,
    "email":"an-email@home.us",
    "productDescription":"Video and Realtime"
    "eventGroup":{
      "id":24680,
      "access_key": 'abcd56t8fm'
    }
  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

The target event id

Validations:

  • Must be a Integer
email
required

email address for the query

Validations:

  • Must be a String
>>>

GET /api/v2/events/:id/groups/:access_key
Get the realtime event_group using an event id and event_group access key

Also see GET /api/v2/events/:id/users.

Return an event_group object using the event group's access_key and event id.

Errors

Code Description
422 Unable to process request, see errors in response

Examples

response:
{
  "eventGroup":{
    "id":27728,
    "accessKey":"432ee6adea",
    "productDescription":"Video and Realtime",
    "event":{
      "id":7235,
      "title":"3m Courtroom Test: speaker"
    }
  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

The target Event ID

Validations:

  • Must be a Integer
access_key
required

The access_key for the target event_group

Validations:

  • Must be a String
>>>

POST /api/v2/events/:id/groups
Add an event_group

Access key is automatically generated when creating an event_group

Errors

Code Description
422 Unable to process request, see errors in response

Examples

$ curl -X POST "https://remotecounsel.com/api/v2/events/24890/groups?token=XXXXX&name=Reporters&is_text=1"
{
  "id":82613,
  "event_id":24890,
  "name":"Reporters",
  "access_key":"f9ae418fe2",
  "is_text":true,
  "is_video":null,
  "is_chat":null,
  "is_disallow_transcript_save":null,
  "is_on_demand_available":null,
  "product_description":"Realtime Only",
  "created_at":"2021-03-23T09:09:15.716-04:00",
  "updated_at":"2021-03-23T09:09:15.716-04:00",
  "is_cameo":null
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

The target event id

Validations:

  • Must be a Integer
name
required

Group Name

Validations:

  • Must be a String
is_cameo
optional

Validations:

  • Must be one of: 1, 0, true, false.
is_chat
optional

Validations:

  • Must be one of: 1, 0, true, false.
is_disallow_transcript_save
optional

Validations:

  • Must be one of: 1, 0, true, false.
is_on_demand_available
optional

Validations:

  • Must be one of: 1, 0, true, false.
is_text
optional

Validations:

  • Must be one of: 1, 0, true, false.
is_video
optional

Validations:

  • Must be one of: 1, 0, true, false.
>>>

POST /api/v2/events/:id/groups/:access_key
Add a user to the event_group using an email, event id, and event_group access key

Adds a user to the event_group and responds with resulting event_group_user object.

Errors

Code Description
422 Unable to process request, see errors in response

Examples

response:
{
  "eventGroupUser":{
    "id":123456,
    "email":"an-email@home.us",
    "productDescription":"Video and Realtime"
    "eventGroup":{
      "id":24680,
      "access_key": 'abcd56t8fm'
    }
  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

The target event id

Validations:

  • Must be a Integer
email
required

email address of the user to add

Validations:

  • Must be a String
>>>

GET /api/v2/events/:id/event_schedules/groups/:access_key
Get the current event_schedule for a realtime event_group using an email, event id, and event_group access key

Also see GET /api/v2/events/:id/users and GET /api/v2/events/:id/groups/:access_key.

Return a current event-schedule object using email, access_key and event id.

Errors

Code Description
422 Unable to process request, see errors in response

Examples

response:
{
  "eventSchedule":{
    "guid":"abc123",
    "startTime":"2015-07-03T23:00:00-04:00",
    "groupUserId":376023
  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

The target event id

Validations:

  • Must be a Integer
access_key
required

The access_key for the target event_group

Validations:

  • Must be a String
email
required

email address for the query

Validations:

  • Must be a String
>>>

GET /api/v2/events/:id/internal_ref_num
Get the internal_ref_num for an event

Errors

Code Description
422 Unable to process request, see errors in response

Examples

response:
{
  "internal_ref_num": string
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

The target event id

Validations:

  • Must be a Integer