ContactByReference

Contact information that is addressed via a reference.

contactReference objectrequired

A reference to an identifiable version managed object where the combination of the identifier and version is unique. It comprises an identifier (e.g. GUID), a version (NonNegativeInteger) and a string identifying the class of the referenced object.

idstringrequired

Unique identifier

Possible values: non-empty

versionintegerrequired

Version number

Possible values: >= 1

classNamestring

Class name of the referenced object. It's optional, as it might be implied by the attribute name using this reference

Possible values: Value must match regular expression ^([A-Z][a-z0-9]+)+

contactNotDefinedboolean

When [TRUE], there is currently no contact defined for the selected role and/or timeframe. Don't use the specialisations in this case.

contactUnknownboolean

When [TRUE], the contact for the selected role and/or timeframe is unknown. Don't use the specialisations in this case.

shareWithPublicboolean

When [TRUE], the details of this contact may be shared with the public. If FALSE these contacts details are for internal purposes only.

validityOfContact object

A continuous or discontinuous period of validity defined by overall bounding start and end times and the possible intersection of valid periods (potentially recurring) with the complement of exception periods (also potentially recurring).

overallStartTimestring<date-time>required

Start of bounding period of validity defined by date and time.

overallEndTimestring<date-time>

End of bounding period of validity defined by date and time.

validPeriods object[]

A single time period, a recurring time Period period or a set of different recurring time periods during which validity is true.

Array [

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

PublicHoliday

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]

SpecialDay

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

]

]

exceptionPeriods object[]

A single time period, a recurring time Period period or a set of different recurring time periods during which validity is false.

Array [

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

PublicHoliday

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]

SpecialDay

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

]

]

ContactByReference

{
  "contactReference": {
    "id": "string",
    "version": 0,
    "className": "string"
  },
  "contactNotDefined": true,
  "contactUnknown": true,
  "shareWithPublic": true,
  "validityOfContact": {
    "overallStartTime": "2024-07-29T15:51:28.071Z",
    "overallEndTime": "2024-07-29T15:51:28.071Z",
    "validPeriods": [
      {
        "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"
          }
        ]
      }
    ],
    "exceptionPeriods": [
      {
        "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"
          }
        ]
      }
    ]
  }
}