Events associated with your company
{
"total_records": integer,
"page_number": integer,
"data": [
{
"id": integer,
"time_zone": string,
"status": string,
"notes": string,
"title": string,
"internal_ref_num": string,
"deponent": string,
"transcript_id": string,
"created_at": datetime,
"updated_at": datetime,
"is_video_streamed": boolean,
"is_text_streamed": boolean,
"is_chat_enabled": boolean,
"text_account_num": string,
"reporter_name": string,
"scheduler_case_id": integer,
"is_teleconferenced": boolean,
"location": string,
"reporter_notified_at": datetime,
"speche_warnings": string,
"is_speche_assigned_transcript_id": boolean,
"speche_return_code": string,
"speche_request_at": datetime,
"allow_speche_to_notify": boolean
},
...
]
}
| Param name | Description |
|---|---|
|
token required |
API token for your organization Validations:
|
|
page_number optional |
Page Number Validations:
|
|
scheduler_case_id optional |
Scheduler Case ID Validations:
|
|
internal_ref_num optional |
Internal Reference Number Validations:
|
Returns all attributes of an Event
| Code | Description |
|---|---|
| 404 | Not Found |
{
"id": integer,
"time_zone": string,
"status": string,
"notes": string,
"title": string,
"internal_ref_num": string,
"deponent": string,
"transcript_id": string,
"created_at": datetime,
"updated_at": datetime,
"is_video_streamed": boolean,
"is_text_streamed": boolean,
"is_chat_enabled": boolean,
"text_account_num": string,
"reporter_name": string,
"scheduler_case_id": integer,
"is_teleconferenced": boolean,
"location": string,
"reporter_notified_at": datetime,
"speche_warnings": string,
"is_speche_assigned_transcript_id": boolean,
"speche_return_code": string,
"speche_request_at": datetime,
"allow_speche_to_notify": boolean
}
| Param name | Description |
|---|---|
|
token required |
API token for your organization Validations:
|
|
id required |
Event ID Validations:
|
Create an event
Will also create a child Event Schedule with values passed to starting_date and start_time
| Code | Description |
|---|---|
| 422 | Unable to process request, see errors in response |
{
"id": integer,
"time_zone": string,
"status": string,
"notes": string,
"title": string,
"internal_ref_num": string,
"deponent": string,
"transcript_id": string,
"created_at": datetime,
"updated_at": datetime,
"is_video_streamed": boolean,
"is_text_streamed": boolean,
"is_chat_enabled": boolean,
"text_account_num": string,
"reporter_name": string,
"scheduler_case_id": integer,
"is_teleconferenced": boolean,
"location": string,
"reporter_notified_at": datetime,
"speche_warnings": string,
"is_speche_assigned_transcript_id": boolean,
"speche_return_code": string,
"speche_request_at": datetime,
"allow_speche_to_notify": boolean
}
| Param name | Description |
|---|---|
|
token required |
API token for your organization Validations:
|
|
scheduler_case_id required |
Scheduler Case ID Validations:
|
|
starting_date required |
Start Date of first Event Schedule Validations:
Metadata: - Example formatting - 05/04/2022 |
|
starting_time required |
Start Time of first Event Schedule Validations:
Metadata: - Example formatting - 1:00 PM |
|
deponent required |
Deponent or Speaker Validations:
|
|
internal_ref_num optional |
Internal Reference Number Validations:
|
|
location required |
Validations:
|
|
is_video_streamed optional |
Enable video Validations:
|
|
is_text_streamed optional |
Enable realtime text Validations:
|
|
is_teleconferenced optional |
Enable audio conferencing Validations:
|
|
notes optional |
Validations:
|
|
reporter_name optional |
Validations:
Metadata: - required when is_text_streamed is true |
|
text_account_num optional |
Reporter email address Validations:
Metadata: - required when is_text_streamed is true |
|
is_speche_assigned_transcript_id optional |
Have Speche assign this Transcript ID Validations:
Metadata: - required when is_text_streamed is true |
|
time_zone required |
Validations:
Metadata: - Alaska - Central Time (US & Canada) - Eastern Time (US & Canada) - Hawaii - Mountain Time (US & Canada) - Pacific Time (US & Canada) |
Update an event
| Code | Description |
|---|---|
| 404 | Not Found |
| 422 | Unable to process request, see errors in response |
{
"id": integer,
"time_zone": string,
"status": string,
"notes": string,
"title": string,
"internal_ref_num": string,
"deponent": string,
"transcript_id": string,
"created_at": datetime,
"updated_at": datetime,
"is_video_streamed": boolean,
"is_text_streamed": boolean,
"is_chat_enabled": boolean,
"text_account_num": string,
"reporter_name": string,
"scheduler_case_id": integer,
"is_teleconferenced": boolean,
"location": string,
"reporter_notified_at": datetime,
"speche_warnings": string,
"is_speche_assigned_transcript_id": boolean,
"speche_return_code": string,
"speche_request_at": datetime,
"allow_speche_to_notify": boolean
}
| Param name | Description |
|---|---|
|
token required |
API token for your organization Validations:
|
|
id required |
Event ID Validations:
|
|
deponent required |
Deponent or Speaker Validations:
|
|
internal_ref_num optional |
Internal Reference Number Validations:
|
|
location required |
Validations:
|
|
is_video_streamed optional |
Enable video Validations:
|
|
is_text_streamed optional |
Enable realtime text Validations:
|
|
is_teleconferenced optional |
Enable audio conferencing Validations:
|
|
notes optional |
Validations:
|
|
reporter_name optional |
Validations:
Metadata: - required when is_text_streamed is true |
|
text_account_num optional |
Reporter email address Validations:
Metadata: - required when is_text_streamed is true |
|
is_speche_assigned_transcript_id optional |
Have Speche assign this Transcript ID Validations:
Metadata: - required when is_text_streamed is true |
|
time_zone required |
Validations:
Metadata: - Alaska - Central Time (US & Canada) - Eastern Time (US & Canada) - Hawaii - Mountain Time (US & Canada) - Pacific Time (US & Canada) |