A layer's history: every version an edit ended, oldest first, then the current one.

GET

/on_call_schedule/{schedule_id}/layer/{layer_id}/versions

const url = 'https://api.siteqwality.com/on_call_schedule/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/layer/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/versions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.siteqwality.com/on_call_schedule/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/layer/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/versions \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

schedule_id

required

string format: uuid

On-call schedule identifier

layer_id

required

string format: uuid

Layer identifier

Responses

200

The layer’s versions

application/json

A layer’s history: every ended version, then the current one.

object

layer_id

required

string format: uuid

versions

required

Array<object>

One version of a layer: an ended one, or the current one (effective_until absent unless the layer itself ends).

object

version

required

integer format: int32

current

required

boolean

effective_from

required

string format: date-time

effective_until

string | null format: date-time

rotation_type

required

string

Allowed values: daily weekly custom

rotation_interval_days

integer | null format: int32

handoff_time

required

string

handoff_day

integer | null format: int32

participants

required

Array<string>

timezone

Ended versions always name their zone; the current one only when it has its own.

string | null

restrictions

required

Array<object>

A window a layer covers, repeated every day or every week in the layer’s zone. A window that runs past midnight (or past the end of the week) carries on into the next day.

object

type

required

string

Allowed values: daily weekly

start_day_of_week

Weekly only: the weekday the window opens, 0 = Sunday .. 6 = Saturday.

integer | null format: int32

start_time

required

HH:MM, 24-hour local time.

string

duration_minutes

required

1 to 1440 for daily windows, 1 to 10080 for weekly ones.

integer format: int32

rotation_anchor

One of:

object
null

The local date of one handoff and the participant (0-based index) who starts there.

object

date

required

YYYY-MM-DD in the layer’s zone.

string

start_index

required

integer format: int32

ended_by_user_id

Who made the edit that ended this version.

string | null format: uuid

Example

{
  "versions": [
    {
      "rotation_type": "daily",
      "restrictions": [
        {
          "type": "daily"
        }
      ]
    }
  ]
}

401

Missing or invalid authentication

404

Schedule or layer not found

500

Internal server error