Home Schema Example JSON Schema

Daily On Call Syncer Settings

Type: object

Settings for syncing HMS Daily on Call rosters.

Office Hours

Type: object

The office hours for the rosters (which can be overridden for individual rosters). This will be localized to the timezone defined for the roster.

Public Holidays

Type: array of string

The list of public holidays.

No Additional Items

Each item of this array must be:

Type: stringFormat: date

Saturday


The office hours for Saturday.

Start And End Times

Type: object

Define start and end times for office hours.

End Time

Type: stringFormat: time Default: "17:00:00"

The end time of the office hours.

Start Time

Type: stringFormat: time Default: "08:00:00"

The start time of the office hours.

Type: const
Specific value: "inactive"

Sunday Or Public Holiday


The office hours for Sunday/Public Holiday.

Start And End Times

Type: object

Define start and end times for office hours.

Same definition as Start And End Times
Type: const
Specific value: "inactive"

Weekday


The office hours for weekdays.

Start And End Times

Type: object

Define start and end times for office hours.

Same definition as Start And End Times
Type: const
Specific value: "inactive"

Output CSV

Default: null

Output the parsed roster to a CSV file. This is a path from within Rosters storage.

Type: string
Type: null

Parser Variant

Type: enum (of string) Default: "default"

The variant of the parser to use.

Must be one of:

  • "default"
  • "ktph"

Phone Number Countries

Type: array of string

The list of countries to guess the phone number from when normalizing.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Roster Date Override

Default: null

Override the roster date with this date. This is mostly used for development and testing.

Type: stringFormat: date

Roster Overrides

Type: array

Overrides for office hours and various metadata for specific rosters.

No Additional Items

Each item of this array must be:

Roster Override

Type: object

Define overrides for specific rosters.

Department

Type: string

Department that match will be overridden.

Override Department

Default: null

Override the department with this.

Override Role

Default: null

Override the role with this.

Override Role Notes

Default: null

Override the roster notes with this.

Override Roster Notes

Default: null

Override the roster notes with this.

Override Roster Title

Default: null

Override the roster title with this.

Role

Default: null

Role that match will be overridden.

Roster Title

Default: null

Roster title that match will be overridden.

Saturday

Default: null

The office hours for Saturday.

Start And End Times

Type: object

Define start and end times for office hours.

Same definition as Start And End Times
Type: const
Specific value: "inactive"

Sunday Or Public Holiday

Default: null

The office hours for Sunday/Public Holiday.

Weekday

Default: null

The office hours for weekdays.

Start And End Times

Type: object

Define start and end times for office hours.

Same definition as Start And End Times
Type: const
Specific value: "inactive"

Source Path

Type: string

Where the HTML source is located. This is a path from within Rosters storage.

Must be at least 1 characters long

Syncer ID

Type: string

Unique name identifying this syncer.

Tenants

Default: ["__all__"]

The tenant that this object is applicable for. Defaults to all tenants.

Tenant


The tenant applicable to this object. This must be one specific tenant and not any of the `all alternatives.

Cleo Tenant

Type: string

The cleo app tenant applicable to this object.

Must match regular expression: ^cleo\:[a-zA-Z0-9][\w\-\_]*$

Hospital Tenant

Type: string

The hospital app tenant applicable to this object.

Must match regular expression: ^hospital\:[a-zA-Z0-9][\w\-\_]*$

All Tenants

Type: const

A literal to represent all tenants.

Specific value: "__all__"

Cleo All Tenant

Type: const

A literal to represent all cleo app tenants.

Specific value: "cleo:__all__"

Hospital All Tenant

Type: const

A literal to represent all hospital app tenants.

Specific value: "hospital:__all__"

Tenant List

Type: array

A list of tenants.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:


Tenant


The tenant applicable to this object. This must be one specific tenant and not any of the `all alternatives.

Cleo Tenant

Type: string

The cleo app tenant applicable to this object.

Must match regular expression: ^cleo\:[a-zA-Z0-9][\w\-\_]*$

Hospital Tenant

Type: string

The hospital app tenant applicable to this object.

Must match regular expression: ^hospital\:[a-zA-Z0-9][\w\-\_]*$

All Tenants

Type: const

A literal to represent all tenants.

Specific value: "__all__"

Cleo All Tenant

Type: const

A literal to represent all cleo app tenants.

Specific value: "cleo:__all__"

Hospital All Tenant

Type: const

A literal to represent all hospital app tenants.

Specific value: "hospital:__all__"

Timezone

Type: string

The timezone of the roster.

Type

Type: const Default: "hms-dailyoncall"
Specific value: "hms-dailyoncall"

Updated On Override

Default: null

Override the updated on date with this date. This is mostly used for development and testing.

Type: stringFormat: date-time