List of VOD Objects

This method retrieves a list of VOD objects for a project

Request Parameters

GET /api/clients/v1/vod/

Headers

• Content-Type: application/json
• Authorization: Bearer $access_token

Query

Parameter	Type	Constraints	Description	Example
project_id	integer	> 0, required	Project ID associated with the VOD source	2
source_type	string	s3_bucket / domain	Video source type	s3_bucket
limit	integer	> 0	Number of objects in response	50
offset	string	> 0	Offset from the beginning of the list	0

Response Parameters

JSON body

Parameter	Type	Description
count	integer	Total number of providers
next	string	Link to the previous page
previous	string	Link to the next page
results	object[]	List of VOD objects

200 OK

List of VOD objects

{
  "count": 2,
  "next": "http://testserver/api/clients/v1/vod?project_id=2",
  "previous": null,
  "results": [
    {
      "id": 18,
      "vod_domain": "vd14.vod-clients.cdn.itglobal.com",
      "source_type": "domain",
      "source_id": 14,
      "is_active": false
    },
    {
      "id": 19,
      "vod_domain": "vs52.vod-clients.cdn.itglobal.com",
      "source_type": "s3_bucket",
      "source_id": 52,
      "is_active": true
    }
  ]
}

400 Bad Request

Invalid or missing required query parameters

{
  "project_id": [
    "This field is required."
  ]
}

401 Unauthorized

Authentication credentials were missing or invalid

{
  "detail": "Given token not valid for any token type",
  "code": "token_not_valid",
  "messages": [
    {
      "token_class": "AccessToken",
      "token_type": "access",
      "message": "Token is invalid or expired"
    }
  ]
}

403 Forbidden

Only VOD objects whose sources are associated with the current user's project are available

{
  "detail": "Only project participants can view this project's VOD"
}