API v1 ReferenceAbsence Regions

Get an absence region by id.

The absence region will include the details of the public holidays for the country and location. <Check title="Required Permissions" icon="key">The user must be admin or have `user-planning-data:write` permissions to see the users assigned to the absence region.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

absenceRegionIdstringRequiredformat: "uuid"
The id of the absence region.

Response

OK
idstring or nullformat: "uuid"
The id of the entity.
createdOndatetime or null
The date this entity was created.
createdBystring or nullformat: "uuid"
The id of the user who created this entity.
updatedOndatetime or null
The date this entity was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this entity.
namestring or null
The name of the absence region, as specified by the user. It must be unique within the workspace.
countryCodestring or null

The country code of the absence region. It must be a valid ISO 3166-1 alpha-2 country code.

countrystring or null
The english name of the country.
locationCodestring or null

The location code of the absence region. It is optional. It should be a valid ISO 3166-2 country subdivision code.

locationstring or null
The name of the location. It will always be in the related country's language.
isDefaultboolean or null
Indicates whether the absence region is the default absence region. Any new user will be assigned to the default absence region.
numberOfPublicHolidaysinteger or null
The number of public holidays in the absence region.
assignedUserslist of strings or null
The list of user ids assigned to the absence region.
publicHolidayslist of objects or null
The list of public holidays in the absence region.

Errors