Create Interval

post

{protocol}://{server}{basePath}/accounts/{accountId}/timetables/{timetableId}/intervals

Creates a new Interval.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

timetableId

string

required

length between 36 and 36

^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

The unique 36 character internal id that represents the timetable.

Body Params

Create/Update Interval request

name

string

required

length ≤ 256

The name of the interval. Interval names are not unique.

description

string

required

length ≤ 1024

The description of the interval

timeFrom

string

required

length between 8 and 8

^(\d){2}:(\d){2}:(\d){2}$

The start time of the interval in 24 hour format = ' HH:mm:ss' i.e. 08:00:00

timeTo

string

required

length between 8 and 8

^(\d){2}:(\d){2}:(\d){2}$

The end time of the interval in 24 hour format = 'HH:mm:ss' i.e. 17:00:00

type

string

enum

required

The type of interval

Allowed:

appliesTo

array of strings

required

length between 1 and 366

List of specific dates (when type is DATES) or days (when type is DAYS) for which the time interval will be applied. When type is DATES then list must contain dates in the format 'YYYY-MM-dd' containing no more than 366 days, when type is DAY the list must contain days of the week in the format 'dddd', it has to be no more than 7 days.

appliesTo*

Specific date or day of the week

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

201Interval Response

400BadRequest

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error