Skip to content
RallyHere Docs

Get Catalog Time Frames All

GET
/inventory/v1/catalog/time-frame

Get all Time Frames.

Authorizations

Parameters

Header Parameters

if-none-match

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.

string

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

A collection of Time Frames by Time Frame ID.

object
time_frames

Time Frames mapped by Time Frame ID.

object
key
additional properties

Time Frames are used to calculate the expiration of Inventory

object
name

The name of the Time Frame.

string
active

Whether or not the Time Frame is active.

boolean
episode
integer
episode_type
integer
hour_interval

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

integer
start
required

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
end
required

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
cache_info

Cache info for the Time Frame.

object
etag
required
string
>= 1 characters
str_rep
string
cache_info

Cache info for the Time Frames.

object
etag
required
string
>= 1 characters
str_rep
string

Headers

ETag
string

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

304

Content still has the same etag and has not changed

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Not Found

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string