Problem details

This API follows Problem Details RFC.
When several problems occur, an extra problems property is added,
containing all of them.

For example:

{
  "type": "https://docs.api.video/problems/parameter.out_of_list",
  "title": "This parameter is out of the list of allowed values.",
  "parameter": "status",
  "allowed": [
    "scheduled",
    "imminent",
    "live",
    "ended"
  ],
  "problems": [
    {
      "type": "https://docs.api.video/problems/parameter.out_of_list",
      "title": "This parameter is out of the list of allowed values.",
      "parameter": "status",
      "allowed": [
        "scheduled",
        "imminent",
        "live",
        "ended"
      ]
    },
    {
      "type": "https://docs.api.video/problems/parameter.out_of_list",
      "title": "This parameter is out of the list of allowed values.",
      "parameter": "sortBy",
      "allowed": [
        "start",
        "end",
        "status"
      ]
    }
  ]
}

Problem details list

• https://docs.api.video/problems/forbidden

  You are not allowed to perform the requested operation.

• https://docs.api.video/problems/parameter.invalid

  This parameter is invalid.

• https://docs.api.video/problems/parameter.out_of_list

  This parameter is out of the list of allowed values.
  These values are available in documentation and in response contents, under allowed key.

• https://docs.api.video/problems/parameter.out_of_range

  This parameter is out of the allowed range of values.
  The range property indicates the allowed range with optional min and max values.

• https://docs.api.video/problems/parameter.required

  This parameter is required.

• https://docs.api.video/problems/property.datetime.invalid

  The datetime format is invalid.
  Datetimes must respect ISO 8601
  standard, for example 1977-04-22T06:00:00Z.

• https://docs.api.video/problems/property.invalid

  This property is invalid.

• https://docs.api.video/problems/property.out_of_list

  This property is out of the list of allowed values.
  These values are available in documentation and in response contents, under allowed key.

• https://docs.api.video/problems/property.required

  This property is required.

• https://docs.api.video/problems/resource.not_found

  The requested resource is not found.
  This might happen when the resource has been deleted, or the current user doesn't have enough credentials.