View, create, update and delete Vidyard chapters. Chapters bind a player and a video together.

Supported Formats

json

POST https://api.vidyard.com/dashboard/v1/chapters
Create a new chapter

Create a new chapter that binds a player and video together.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "player_id": 1085,
  "position": 0,
  "video_id": 20234
}

RESPONSE
201 (Created)
{
  "player_id": 1085,
  "position": 0,
  "video_id": 20234
  "id": 52523,
  "created_at": 1346961610,
  "updated_at": 1346961610
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

position
required

The position this chapter appears in the player
Zero based index eg. “0” would be “Chapter 1”

Validations:

  • Parameter has to be Integer.

player_id
required

The player the chapter will be added to

Validations:

  • Parameter has to be Integer.

video_id
required

The id of the video the chapter will contain

Validations:

  • Parameter has to be Integer.


PUT https://api.vidyard.com/dashboardv1/chapters/:id
Updates a single chapter

Updates a single chapter

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "id": 500,
  "player_id": 1085,
  "position": 1,
  "video_id": 20234
}

RESPONSE
200 (OK)
{
  "id": 500,
  "player_id": 1085,
  "position": 1,
  "video_id": 20234
  "created_at": 1346961610,
  "updated_at": 1346961610
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

position
optional

The position this chapter appears in the player
Zero based index eg. “0” would be “Chapter 1”

Validations:

  • Parameter has to be Integer.

player_id
optional

The player the chapter will be added to

Validations:

  • Parameter has to be Integer.

video_id
optional

The id of the video the chapter will contain

Validations:

  • Parameter has to be Integer.


GET https://api.vidyard.com/dashboard/v1/chapters/:id
Get a single Chapter

Get a single Chapter

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "player_id": 1085,
  "position": 0,
  "video_id": 20234
  "id": 52523,
  "created_at": 1346961610,
  "updated_at": 1346961610
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

id
required

Used to uniquely identify a Chapter

Validations:

  • Parameter has to be Integer.


DELETE https://api.vidyard.com/dashboard/v1/chapters/:id
Delete a single Chapter

Delete a single chapter

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "player_id": 1085,
  "position": 0,
  "video_id": 20234
  "id": 52523,
  "created_at": 1346961610,
  "updated_at": 1346961610
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

id
required

Used to uniquely identify a Chapter

Validations:

  • Parameter has to be Integer.