Event schedules

>>>

GET /api/v2/event_schedules/:id
Find an event_schedule by ID

Returns an event_schedule along with its associated groups and users

Errors

Code Description
404 Event schedule not found

Examples

{
  "id": 18696,
  "event_schedule_id": null,
  "event_id": 9111,
  "starts_at": "2017-07-10T09:00:00.000-04:00",
  "ends_at": null,
  "display_start_time": null,
  "display_end_time": null,
  "legacy_class": null,
  "legacy_id": null,
  "created_at": "2017-07-10T12:59:59.000-04:00",
  "updated_at": "2017-07-10T12:59:59.000-04:00",
  "starting_time": "9:00 AM",
  "starting_date": "07/10/2017",
  "status": "Active",
  "on_demand_url": "",
  "speche_guid": null,
  "event_groups": [
    {
      "id": 31173,
      "scheduler_case_id": 3851,
      "event_id": 9111,
      "user_group_chatroom_id": 39173,
      "name": "Default",
      "access_key": "6ce5932bf7",
      "is_text": false,
      "is_video": true,
      "is_chat": false,
      "is_disallow_transcript_save": false,
      "is_on_demand_available": false,
      "product_description": "Video Only",
      "deleted_at": null,
      "legacy_case_group_id": null,
      "created_at": "2017-06-23T15:06:12.000-04:00",
      "updated_at": "2017-06-23T15:06:12.000-04:00",
      "is_cameo": false,
      "event_group_users": [
        {
          "user_group_id": 31173,
          "id": 416761,
          "user_id": 13330,
          "user_email": "jeff.gibbs.cc@gmail.com",
          "is_text": false,
          "is_video": true,
          "is_chat": false,
          "is_disallow_transcript_save": null,
          "product_description": "Video Stream Only",
          "created_at": "2017-07-11T13:16:45.000-04:00",
          "updated_at": "2017-07-11T13:16:57.000-04:00",
          "is_cameo": false,
          "access_token": "9081a829df3b72487d9f00fc",
          "invited_at": "2017-07-11T13:16:57.000-04:00",
          "first_invited_at": "2017-07-11T13:16:57.000-04:00"
        }
      ]
    }
  ]
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the event schedule

Validations:

  • Must be a Integer
>>>

GET /api/v2/event_schedules/:id/users
Return a list of users with access to an event_schedule

Returns an array of users who have access to an EventSchedule

Errors

Code Description
404 Event schedule not found

Examples

[
  {
    "id": 836622,
    "user_id": null,
    "email": "cdt@novackmacey.com",
    "name": null,
    "invited_at": "2021-04-12T12:03:07.000-04:00"
  },
  {
    "id": 836623,
    "user_id": null,
    "email": "HGriffin@novackmacey.com",
    "name": null,
    "invited_at": null
  },
]

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the event schedule

Validations:

  • Must be a Integer
>>>

GET /api/v2/event_schedules/:id/logs
Return a list of logs for an event_schedule

Returns an array of logs for an EventSchedule

Errors

Code Description
404 Event schedule not found

Examples

[
  {
    "id": 236497,
    "event_group_id": null,
    "event_schedule_id": 30977,
    "user_id": null,
    "time_in": "2020-11-11T15:04:03.000-08:00",
    "time_out": "2020-11-11T22:32:04.000-08:00",
    "ip_address": "12.34.188.83",
    "event_id": 19265,
    "session_id": null,
    "billable": null,
    "admin_logged_out": null,
    "legacy_class": null,
    "live_note_user_id": null,
    "legacy_id": null,
    "created_at": "2020-11-11T18:04:03.000-05:00",
    "updated_at": "2020-11-12T01:32:04.000-05:00",
    "product_description": "Realtime Only",
    "user_group_id": 59713,
    "user_group_name": "Gibson Dunn",
    "user_email": "cmcternan@gibsondunn.com",
    "user_group_user_id": "752584",
    "data_source": null,
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36",
    "ip_location": "Denver, CO, 80202, US"
  },
]

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the event schedule

Validations:

  • Must be a Integer
>>>

POST /api/v2/event_schedules/:guid/event_group_user/:event_group_user_id/logs
Submit an event_group_user's access/usage information for an Event Schedule

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

POST usage logs representing how long a user accessed an event

Errors

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

Metadata

guid: GET /api/v2/events/:id/event_schedules/groups/:access_key
event_group_user_id: GET /api/v2/events/:id/users

Examples

response:
{
  "eventLog":{
    "id":108717,
    "guid":"abc123",
    "email":"nobody@home.com",
    "timeIn":"2015-09-09T12:00:00Z",
    "timeOut":"2015-09-09T14:00:00Z",
    "eventGroup":{
      "id":27728,
      "accessKey":"432ee6adea"
    },
    "event":{
      "id":7235,
      "title":"3m Courtroom Test: speaker"
    }
  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
guid
required

32 bit GUID of the event schedule

Validations:

  • Must be a String
event_group_user_id
required

Numeric event_group-user's id

Validations:

  • Must be a String
time_in
required

The logged time in formatted as YYYY-MM-DDThh:mm:ss.sssZ

Validations:

  • Must be a Time
time_out
required

The logged time out formatted as YYYY-MM-DDThh:mm:ss.sssZ.

Validations:

  • Must be a Time
>>>

GET /api/v2/event_schedules/:guid/event_group_user/:event_group_user_id/logs
Get an event_group_user's access logs for an Event Schedule

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

Return usage logs for a user and event

Errors

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

Metadata

guid: GET /api/v2/events/:id/event_schedules/groups/:access_key
event_group_user_id: GET /api/v2/events/:id/users

Examples

response:
  [{"eventLog":
    {"id":108715,
      "guid":"abc123",
      "email":"nobody@home.com",
      "timeIn":"2015-05-16T02:36:24Z",
      "timeOut":"2015-05-16T03:05:26Z",
      "eventGroup":{
        "id":27728,
        "accessKey":"432ee6adea"
      },
      "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

32 bit GUID of the event schedule

Validations:

  • Must be a String
event_group_user_id
required

Numeric egu_id

Validations:

  • Must be a String