Get Catalog Time Frames All

GET 
/inventory/v1/catalog/time-frame

Get all Time Frames.

Request

Header Parameters

if-none-match any

If you provide the ETag that matches the current ETag for this content, will return a 304 response - indicating that the content has not changed.

Responses

200

Successful Response

Response Headers

• ETag

  string

  Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

application/json

Schema

Schema

time_frames

object

Time Frames mapped by Time Frame ID.

property name*

TimeFrame

Time Frames are used to calculate the expiration of Inventory

name

object

The name of the Time Frame.

anyOf

MOD1

string

active Active (boolean)

Whether or not the Time Frame is active.

episode Episode (integer)deprecated

Default value: 0

episode_type Episode Type (integer)deprecated

Default value: 0

hour_interval Hour Interval (integer)

Default value: 0

Number of hours that this time frame lasts until restarting.0 interval means no repeating.

start date-timerequired

The current start of the Time Frame.

end date-timerequired

The current end of the Time Frame.

cache_info

object

Cache info for the Time Frame.

anyOf

CacheInfo

Cache information for the resource it is attached to. The etag value can be used with the If-None-Match and If-Match headers

etag Etag (string)required

Possible values: non-empty

cache_info

object

Cache info for the Time Frames.

anyOf

CacheInfo

Cache information for the resource it is attached to. The etag value can be used with the If-None-Match and If-Match headers

etag Etag (string)required

Possible values: non-empty

Example (from schema)

{
  "time_frames": {},
  "cache_info": {}
}

304

Content still has the same etag and has not changed

403

Forbidden

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

404

Not Found

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...