Skip to main content

Period

A continuous time period or a set of discontinuous time periods defined by the intersection of a set of criteria all within an overall delimiting interval.

periodName object[]

Multilingual string, represented as an array of SpecificLanguageString objects, each containing a language code (using ISO 639-1:2002) and the translated string

Possible values: >= 1

  • Array [
    • languageLanguageCode (string)required

    ISO 639-1:2002 language code

    Possible values: Value must match regular expression ^[a-z]{2}$

    Example: en
    stringstringrequired

    Translated string

  • ]
    • startOfPeriodstring<date-time>

    Start of period

    endOfPeriodstring<date-time>

    End of a period

    recurringDayWeekMonthPeriod object[]

    A recurring period defined in terms of days DayWeekMonth of the week, weeks of the month and months of the year.

  • Array [
    • applicableDayDayEnum (string)[]

    Applicable day of the week. "All days of the week" is expressed by non-inclusion of this attribute.

    Possible values: [friday, monday, saturday, sunday, thursday, tuesday, wednesday], <= 7

    applicableMonthMonthEnum (string)[]

    Applicable month of the year. "All months of the year" is expressed by non-inclusion of this attribute.

    Possible values: [january, february, march, april, may, june, july, august, september, october, november, december], <= 12

    applicableWeekWeekOfMonthEnum (string)[]

    Applicable week of the month (1 to 5). "All weeks of the month" is expressed by non-inclusion of this attribute.

    Possible values: [firstWeekOfMonth, secondWeekOfMonth, thirdWeekOfMonth, fourthWeekOfMonth, fifthWeekOfMonth], <= 5

  • ]
    • recurringSpecialDay object[]

    A recurring period in terms of special days

  • Array [
    • anyOf
    publicHolidayName object[]required

    Multilingual string, represented as an array of SpecificLanguageString objects, each containing a language code (using ISO 639-1:2002) and the translated string

    Possible values: >= 1

  • Array [
    • languageLanguageCode (string)required

    ISO 639-1:2002 language code

    Possible values: Value must match regular expression ^[a-z]{2}$

    Example: en
    stringstringrequired

    Translated string

  • ]
    • intersectWithApplicableDaysbooleanrequired

    When [TRUE], the period is the intersection of applicable days and this special day. When [FALSE], the period is the union of applicable days and this special day

    specialDayTypeSpecialDayTypeEnum (string)required

    Collection of special types of days

    • dayBeforePublicHoliday: The day preceding a public holiday
    • dayFollowingPublicHoliday: A day following a public holiday
    • inLieuOfPublicHoliday: A holiday in lieu of a public holiday that falls on a weekend
    • longWeekendDay: A day between a public holiday and the weekend
    • other: Some other special day
    • publicEventDay: A day of a public event. You may use the publicEvent attribute to specify the corresponding event
    • publicHoliday: Public holiday A public holiday in general. You may use the PublicHoliday class to refer on a specific public holiday
    • schoolDay: A school day
    • schoolHolidays: A day within the school holidays

    Possible values: [dayBeforePublicHoliday, dayFollowingPublicHoliday, inLieuOfPublicHoliday, longWeekendDay, other, publicEventDay, publicHoliday, schoolDay, schoolHolidays]

  • ]
    • recurringTimePeriodOfDay object[]

    A recurring period of a day

  • Array [
    • startTimeOfPeriodstringrequired

    Start of time period

    endTimeOfPeriodstringrequired

    End time of period

  • ]
    • Period
    {
      "periodName": [
        {
          "language": "en",
          "string": "string"
        }
      ],
      "startOfPeriod": "2024-07-29T15:51:28.071Z",
      "endOfPeriod": "2024-07-29T15:51:28.071Z",
      "recurringDayWeekMonthPeriod": [
        {
          "applicableDay": [
            "friday"
          ],
          "applicableMonth": [
            "january"
          ],
          "applicableWeek": [
            "firstWeekOfMonth"
          ]
        }
      ],
      "recurringSpecialDay": [
        {
          "publicHolidayName": [
            {
              "language": "en",
              "string": "string"
            }
          ],
          "intersectWithApplicableDays": true,
          "specialDayType": "dayBeforePublicHoliday"
        },
        {
          "intersectWithApplicableDays": true,
          "specialDayType": "dayBeforePublicHoliday"
        }
      ],
      "recurringTimePeriodOfDay": [
        {
          "startTimeOfPeriod": "string",
          "endTimeOfPeriod": "string"
        }
      ]
    }