Bank Holiday Management API

1.1 Overview

The Bank Holiday Management API enables users with external systems to make requests from a third-party application to SAP Field Service Management, where they can manage the bank holidays, holiday calendars, and calendar assignments used in the SAP Field Service Management application.

For more information on the Bank Holiday Management feature and the UI components to which this API corresponds, please refer to the following documentation:

Bank Holiday Management


1.1.1 Supported Requests

1.1.1.1 Holiday Calendar

The following requests are supported for Holiday Calenadar:

Method Description Section
GET Retrieve all holiday Calendars. 1.3
POST Create a holiday Calendar. 1.4
DELETE Delete a holiday calendar assignment by calendarId. 1.5
POST Create holiday Calendar Assignments in partial manner. 1.6
POST Create Yearly Calendar in atomic manner. 1.7
GET Retrieve Holiday Calendar Assignments by calendarId. 1.8
GET Retrieve Holiday Yearly Calendar entries for calendarID by year. 1.9
GET Retrieve holiday calendars for a given id 1.10
PUT Update holiday rule for a given id 1.11
DELETE Delete holiday calendar for a given id 1.12

1.1.1.2 Holiday Rules

The following requests are supported for Holiday Rules:

Method Description Section
GET Retrieve holiday rules for calendarId. 1.13
POST Create a holiday rule. 1.14
GET Retrieve holiday rule by id. 1.15
PUT Update holiday rule by id. 1.16
DELETE Delete holiday rule by id. 1.17

1.1.1.3 Yearly Holiday Calendar

The following request is supported for Yearly Holiday Calendar:

Method Description Section
GET Retrieve all yearly holiday calendar entries for the given rules and year. 1.18

1.2 Access

This API uses Oauth 2.0 for authentication. This token is then used in the Authorization header as the bearer.

Attention: In order to receive an access token, you must have ADMINISTRATOR or SUPERUSER privileges.

1.2.1 Get Access Token

The following example shows how to get the access token for a Cloud Account or a Company User:


Cloud Account


The following example is an example of authentication for a SAP Cloud account with access to all companies within the account:


POST https://auth.coresuite.com/api/oauth2/v1/token HTTP/1.1

Host et.dev.coresuite.com
Authorization Basic dGVzdDpzZWNyZXQ=
Content-Type application/x-www-form-urlencoded

grant_type=password&username=cym&password=passwordExample123


Company User


The following example of authentication for a company user, with access to companies controlled by existing subscription and permission settings:


POST https://auth.coresuite.com/api/oauth2/v1/token HTTP/1.1

Host et.dev.coresuite.com
Authorization Basic dGVzdDpzZWNyZXQ=
Content-Type application/x-www-form-urlencoded

grant_type=password&username=cym/manager&password=passwordExample123


1.2.2 Response

The following is an example of a typical response:

{
  "access_token": "77cf4834-a347-4849-839b-4518823a739e",
  "token_type": "bearer",
  "expires_in": 43199,
  "scope": "general",
  "cluster_url": "https://et.dev.coresuite.com",
  "account": "testaccount",
  "account_id" : 284,
  "user": "manager",
  "user_email": "test@coresuite.ch",
  "companies": [
    {
      "id": 957,
      "name": "SBODemoCH",
      "description": "OEC Computers (Schweiz)"
    }
  ],
 }
 

1.2.3 Error Response

{
  "error": "invalid_grant",
  "error_description": "Bad credentials"
}

1.2.4 Supported Clusters

Depending on the location of the account, requests will be made to one of the following server clusters:

  • EU
  • DE
  • US
  • CN
  • AU

Account information, including cluster assignment, are obtained from the Directory API.


1.3 GET ALL Holiday Calendars

Retrieve all holiday calendars.

1.3.1 Request

Method URL
GET https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/calendars

1.3.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.3.3 Query Parameters

The following query parameters are supported:

Parameter Type Description
Page Integer The amount of results per page you wish to return.
Size Integer The number of records per page you wish to return .

1.3.4 Response

The following values are displayed in the request response:

Value Description Type
name The name of the holiday calendar. String
rules The id of the rules associated with the holiday calendar. A rule consists of information about a specific banking holiday/public event, including whether the holiday is fixed or floating, full day or partial day, and the day and month on which the holiday occurs. String
timeZoneId The time zone ID of the holiday calendar. String
uuid The unique ID created by the cloud for the holiday calendar. string
validFromYear The starting year for which the holiday calendar is valid. Integer
validToYear The ending year for which the holiday calendar is valid. Integer
version The current version number of the holiday calendar. Integer

1.3.4 Example Response

{
  "first": true,
  "last": true,
  "number": 0,
  "results": [
    {
      "name": "string",
      "rules": [
        "rule134"
      ],
      "timeZoneId": "string",
      "uuid": "string",
      "validFromYear": 0,
      "validToYear": 0,
      "version": 0
    }
  ],
  "size": 0,
  "totalElements": 0,
  "totalPages": 0
}

1.3.5 Response Codes

Status Response
200 List of holiday calendar/s returned
401 Unauthorized
403 Forbidden
404 Not Found

1.4 Create New Holiday Calendar

Create a new holiday calendar.

1.4.1 Request

Method URL
POST https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/calendars

1.4.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.4.3 Request Body

The following values are supported in the request body:

Value   Description Type Required
name   The name of the holiday calendar. String Required
rules   The id of the rules associated with the holiday calendar. A rule consists of information about a specific banking holiday/public event, including whether the holiday is fixed or floating, full day or partial day, and the day and month on which the holiday occurs. Array  
  {ruleIds} The rule ids to be associated with the holiday calendar. String  
timeZoneId   The time zone ID of the holiday calendar. String Required
validFromYear   The starting year for which the holiday calendar is valid (example: 2020). Integer Required
validToYear   The ending year for which the holiday calendar is valid(example: 2025). Integer Required

1.4.4 Example Request Body

{
  "name": "US Federal Holidays",
  "rules": [
    "string",
    "string"
  ],
  "timeZoneId": "(UTC -04:00) America/New_York",
  "validFromYear": 2020,
  "validToYear": 2030
}

1.4.5 Response Codes

Status Response
200 Created holiday calendar with UUID. Please note that the uuid is used in PUT and DELETE requests.
401 Unauthorized
403 Forbidden
404 Not found

1.4.6 Example Response Body

The following is an example 200 response body:

{
  "name": "US Federal Holidays",
  "rules": [
    "string",
    "string"
  ],
  "timeZoneId": "(UTC -04:00) America/New_York",
  "validFromYear": 2020,
  "validToYear": 2030
}

1.5 Delete Holiday Calendar by ID

Delete a holiday calendar by id.

Attention: a holiday calendar cannot be deleted if there are technican assignments.

1.5.1 Request

Method URL
DELETE https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/calendars/{id}

1.5.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.5.3 URL Parameters

URL Parameter Description Required
{id} The id of the holiday calendar you wish to delete. Required

1.5.3 Response Codes

Status Response
200 Ok
204 No content
400 Holiday calendar has technician assignments
401 Unauthorized
403 Forbidden
404 Not Found

1.5.3 Example Response

The following is an example 200 response body:

{
  "name": "string",
  "rules": [
    "string"
  ],
  "timeZoneId": "string",
  "uuid": "string",
  "validFromYear": 0,
  "validToYear": 0,
  "version": 0
}

1.6 Create Holiday Calendar Assignments in Partial Manner

Create holiday assignments in a partial manner.

This request is used to assign specific technicians to a given calendar.

1.6.1 Request

Method URL
POST https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/calendars/{calendarId}/composite-bulk/assignments

1.6.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.6.3 URL Parameters

URL Parameter Description Required
{calendarId} The id of the holiday calendar for which you wish to assign technicians. Required

1.6.4 Example Request Body

[
  {
    "objectId": "string",
    "objectType": "string"
  }
]

1.6.5 Response Codes

Status Response
201 Created
207 UUID’s of created assignments or errors in case something failed
401 Unauthorized
403 Forbidden
404 Not found

1.6.6 Example Response Body

The following is an example 207 response body that contains errors:

{
  "hasErrors": true,
  "results": [
    {
      "error": {
        "detail": "string",
        "title": "string",
        "values": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      },
      "httpStatus": "100 CONTINUE",
      "resource": "string"
    }
  ]
}

1.7 Create Yearly Calendar in Atomic Manner

Create yearly holiday calendar in atomic manner.

1.7.1 Request

Method URL
POST https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/calendars/{calendarId}/composite-bulk/yearly-calendars

1.7.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.7.3 URL Parameters

URL Parameter Description Required
{calendarId} The id of the holiday calendar for which you wish to create in atomic manner. Required

1.7.4 Request Body

The following values are supported in the request body:

Value   Description Type Required
Date        
  Time The date/time of the holiday calendar entry. date/time Required
halfDayType   If applicable, the halfDayType associated with the rule. Options include: FIRST_HALF, SECOND_HALF. Enum  
Name   The name of the holiday. String Required

1.7.4 Example Request Body

[
  {
    "date": {
      "time": "2020-06-04T06:13:35.124Z"
    },
    "halfDayType": "FIRST_HALF",
    "name": "string"
  }
]

1.7.5 Response Codes

Status Response
201 UUID’s of created yearly calendar entries
401 Unauthorized
403 Forbidden
404 Not Found

1.7.6 Example Response Body

The following is an example 201 response body:

[
  "string"
]

1.8 Retrieve Holiday Calendar Assignments by calendarId

Retrieve holiday calander assignments for a given holiday calendar using calendarId.


1.8.1 Request

Method URL
GET https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/calendars/{calendarId}/composite-tree/assignments

1.8.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.8.3 URL Parameters

URL Parameter Description Required
{calendarId} The id of the holiday calendar for which you wish to retrieve assignments. Required

1.8.4 Query Parameters

The following query parameters are supported:

Parameter Type Description
Page Integer The amount of results per page you wish to return.
Size Integer The number of records per page you wish to return.

1.8.5 Response Codes

Status Response
200 Holiday calendar assignment entries
401 Unauthorized
403 Forbidden
404 Not Found

1.8.6 Example Response

The following is an example response for a 200 response body:

{
  "first": true,
  "last": true,
  "number": 0,
  "results": [
    {
      "calendar": "string",
      "legacyObjectId": "string",
      "objectId": "string",
      "objectType": "string",
      "uuid": "string",
      "version": 0
    }
  ],
  "size": 0,
  "totalElements": 0,
  "totalPages": 0
}

1.9 Retrieve Holiday Yearly Calendar Entries for calendarID by Year

Retrieve all holiday yearly calendar entries for a given year using calendarId.

1.9.1 Request

Method URL
GET https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/calendars/{calendarId}/composite-tree/yearly-calendars/{year}

1.9.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.9.3 URL Parameters

URL Parameter Description Required
{calendarId} The id of the holiday calendar for which you wish to retrieve entries. Required
{year} The year associated wih the holiday calendar for which you wish to retrieve entries. Required

1.9.4 Response Codes

Status Response
200 Yearly holiday calendar entries
401 Unauthorized
403 Forbidden
404 Not Found

1.9.5 Example Response

The following is an example response for a 200 response body:

[
  {
    "date": {
      "time": "2020-06-04T13:27:17.571Z"
    },
    "halfDayType": "FIRST_HALF",
    "name": "string"
  },
  {
    "date": {
      "time": "2020-06-04T13:27:17.571Z"
    },
    "halfDayType": "FIRST_HALF",
    "name": "string"
  }
]

1.10 Retrieve Holiday Calendars for a Given calendarId

Retrieve holiday calendar entries for a given calendarId

1.10.1 Request

Method URL
GET https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/calendars/{calendarId}

1.10.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.10.3 URL Parameters

URL Parameter Description Required
{calendarId} The calendarId of the holiday calendar for which you wish to retrieve. Required

1.10.4 Response Codes

Status Response
200 Yearly holiday calendar entries
401 Unauthorized
403 Forbidden
404 Not Found

1.10.5 Example Response

The following is an example response for a 200 response body:

{
  "name": "string",
  "rules": [
    "string"
  ],
  "timeZoneId": "string",
  "uuid": "string",
  "validFromYear": 0,
  "validToYear": 0,
  "version": 0
}

1.11 Update Holiday Rule using calendarId

Update a given holiday calendar using calendarId.

1.10.1 Request

Method URL
PUT https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/calendars/{calendarId}

1.11.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.11.3 URL Parameters

URL Parameter Description Required
{calendarId} The calendarId of the holiday calendar for which you wish to update an associated rule. Required

1.11.4 Request Body

Value   Description Type Required
name   The name of the holiday calendar. String Required
rules   The id of the rules associated with the holiday calendar. A rule consists of information about a specific banking holiday/public event, including whether the holiday is fixed or floating, full day or partial day, and the day and month on which the holiday occurs. Array  
  {ruleIds} The rule ids to be associated with the holiday calendar. String  
timeZoneId   The time zone ID of the holiday calendar. String Required
validFromYear   The starting year for which the holiday calendar is valid (example: 2020). Integer Required
validToYear   The ending year for which the holiday calendar is valid(example: 2025). Integer Required

1.11.5 Example Request Body

{
  "name": "string",
  "rules": [
    "string"
  ],
  "timeZoneId": "string",
  "validFromYear": 0,
  "validToYear": 0,
  "version": 0
}

1.11.6 Response Codes

Status Response
200 Updates Holiday rule for the given id
201 Created
400 If floating dates are not provided for the holiday rule type FLOATING
401 Unauthorized
403 Forbidden
404 Not Found

1.11.7 Example Response

The following is an example response for a 200 response body:

{
  "name": "string",
  "rules": [
    "string"
  ],
  "timeZoneId": "string",
  "uuid": "string",
  "validFromYear": 0,
  "validToYear": 0,
  "version": 0
}

1.12 Delete Holiday Calendar using calendarId

Delete a given holiday calendar by referencing its calendarId.

1.12.1 Request

Method URL
DELETE https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/calendars/{id}

1.12.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.12.3 URL Parameters

URL Parameter Description Required
{calendarId} The calendarId of the holiday calendar you wish to delete. Required

1.12.4 Response Codes

Status Response
200 Deletes Holiday calendar for the given id
204 No Content
400 If holiday calendar has assignments
401 Unauthorized
403 Forbidden
404 Not Found

1.12.5 Example Response

The following is an example response for a 200 response body:

{
  "name": "string",
  "rules": [
    "string"
  ],
  "timeZoneId": "string",
  "uuid": "string",
  "validFromYear": 0,
  "validToYear": 0,
  "version": 0
}

1.13 Retrieve Holiday Rules using Rule id/s

Retrieve existing holiday rules by referencing the rule id/s.

1.13.1 Request

Method URL
GET https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/rules

1.13.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.13.3 Query Parameters

Query Parameter Description Required
{id}s The id/s of the rules you wish to retrieve. Optional. If not specified, all rules will be returned.

1.13.4 Response Codes

Status Response
200 Holiday rule for the given id
401 Unauthorized
403 Forbidden
404 Not Found

1.13.5 Example Response

The following is an example response for a 200 response body:

[
  {
    "day": 0,
    "floatingDates": [
      "2020-06-05T06:42:32.303Z"
    ],
    "halfDayType": "FIRST_HALF",
    "holidayRuleType": "FIXED",
    "month": 0,
    "name": "string",
    "uuid": "string",
    "version": 0
  }
]

1.14 Create a Holiday Rule

Create a new holiday rule.

Method URL
POST https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/rules

1.14.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.14.3 Request Body

The following values are supported in the request body:

Value   Description Type Required
Day   The day of the month on which the banking holiday occurs. Integer Required
floatingDates     Array  
  {dateTime} If applicable, the date/time on which the floating holiday occurs. Date/Time  
halfDayType   If applicable, the part of day on which the half holiday occurs. Options include: FIRST_HALF, SECOND_HALF. Enum  
HolidayRuleType   Options include: FIXED, FLOATING. Enum Required
Month   The month (1-12) on which the banking holiday occurs. Integer Required
Name   The name of the holiday/event. String Required

1.14.4 Example Request Body

{
  "day": 0,
  "floatingDates": [
    "2020-06-05T06:49:45.251Z"
  ],
  "halfDayType": "FIRST_HALF",
  "holidayRuleType": "FIXED",
  "month": 0,
  "name": "string"
}

1.14.5 Response Codes

Status Response
200 Created holiday rule with UUID. Please note that the uuid is used in other holiday rule PUT, GET, and DELETE requests.
401 Unauthorized
403 Forbidden
404 Not found

1.14.6 Example Response Body

The following is an example 200 response body:

{
  "day": 0,
  "floatingDates": [
    "2020-06-05T06:50:12.375Z"
  ],
  "halfDayType": "FIRST_HALF",
  "holidayRuleType": "FIXED",
  "month": 0,
  "name": "string",
  "uuid": "string",
  "version": 0
}

1.15 Retrieve Holiday Rule by Rule id

Retrieve a given holiday rule by referencing its id.

1.15.1 Request

Method URL
GET https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/rules/{id}

1.15.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.15.3 URL Parameters

URL Parameter Description Required
{id} The id of the holiday rule you wish to retrieve. Required

1.15.4 Response Codes

Status Response
200 Holiday rule for the given id
401 Unauthorized
403 Forbidden
404 Not found

1.15.5 Example Response Body

The following is an example 200 response body:

{
  "day": 0,
  "floatingDates": [
    "2020-06-05T07:24:00.371Z"
  ],
  "halfDayType": "FIRST_HALF",
  "holidayRuleType": "FIXED",
  "month": 0,
  "name": "string",
  "uuid": "string",
  "version": 0
}


1.16 Update Holiday Rule by id

Update an existing holiday rule by referencing its id.

1.16.1 Request

Method URL
PUT https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/rules/{id}

1.16.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.16.3 URL Parameters

URL Parameter Description Required
{id} The id of the holiday rule you wish to update. Required

1.16.4 Request Body

Value   Description Type Required
Day   The day of the month on which the banking holiday occurs. Integer Required
floatingDates     Array  
  {dateTime} If applicable, the date/time on which the floating holiday occurs. Date/Time  
halfDayType   If applicable, the part of day on which the half holiday occurs. Options include: FIRST_HALF, SECOND_HALF. Enum  
HolidayRuleType   Options include: FIXED, FLOATING. Enum Required
Month   The month (1-12) on which the banking holiday occurs. Integer Required
Name   The name of the holiday/event. String Required

1.16.5 Example Request Body

{
  "day": 0,
  "floatingDates": [
    "2020-06-05T06:49:45.251Z"
  ],
  "halfDayType": "FIRST_HALF",
  "holidayRuleType": "FIXED",
  "month": 0,
  "name": "string"
}

1.16.6 Response Codes

Status Response
200 Holiday rule updated for given id
400 If floating dates are not provided for the holiday rul type FLOATING
201 Created
401 Unauthorized
403 Forbidden
404 Not found

1.16.7 Example Response Body

The following is an example 200 response body:

{
  "day": 0,
  "floatingDates": [
    "2020-06-05T07:24:00.371Z"
  ],
  "halfDayType": "FIRST_HALF",
  "holidayRuleType": "FIXED",
  "month": 0,
  "name": "string",
  "uuid": "string",
  "version": 0
}

1.17 Delete Holiday Rule by id

Delete an existing holiday rule by referencing its id.

1.17.1 Request

Method URL
DELETE https://{cluster}.coresystems.net/cloud-holiday-calendar-service/api/v1/holiday/rules/{id}

1.17.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.17.3 URL Parameters

URL Parameter Description Required
{id} The id of the holiday rule you wish to delete. Required

1.17.4 Response Codes

Status Response
200 Holiday rule for the given id deleted
204 No content
400 If Holiday rule is already used in calendars
401 Unauthorized
403 Forbidden
404 Not found

1.17.5 Example Response Body

The following is an example 200 response body:

{
  "day": 0,
  "floatingDates": [
    "2020-06-05T07:24:00.371Z"
  ],
  "halfDayType": "FIRST_HALF",
  "holidayRuleType": "FIXED",
  "month": 0,
  "name": "string",
  "uuid": "string",
  "version": 0
}


1.18 Retrieve All Yearly Holiday Calendar Entries for Rules and Year

Retrieve all yearly holiday calendar entries for rules and year.

1.18.1 Request

Method URL
GET https://{cluster}.coresystems.net/api/v1/holiday/yearly-calendars

1.18.2 Headers

Header Parameter Value Description Required
Authorization bearer OAuth 2.0 token Required
X-Account-Id accountId The account identifier Required
X-Client-ID clientId Client app identifier Required
X-Company-Id companyId The company identfier Required
X-User-ID userId The user identifier Optional

1.18.3 Query Parameters

The following optional query parameters are supported:

Query Parameter Description Type
fromDateTime The starting date/time of the range you wish to retrieve. String
toDateTime The ending date/time of the range you wish to retrieve. String
technicians The technician assignment/s associated with the yearly holiday calendar you wish to retrieve. String

1.18.4 Response Codes

Status Response
200 List of yearly holiday entries for the given technicians and date range
401 Unauthorized
403 Forbidden
404 Not found

1.18.5 Example Response Body

The following is an example 200 response body:

{
  "additionalProp1": [
    {
      "date": {
        "time": "2020-06-05T07:56:43.433Z"
      },
      "halfDayType": "FIRST_HALF",
      "name": "string",
      "timeZoneId": "string"
    }
  ],
  "additionalProp2": [
    {
      "date": {
        "time": "2020-06-05T07:56:43.433Z"
      },
      "halfDayType": "FIRST_HALF",
      "name": "string",
      "timeZoneId": "string"
    }
  ],
  "additionalProp3": [
    {
      "date": {
        "time": "2020-06-05T07:56:43.433Z"
      },
      "halfDayType": "FIRST_HALF",
      "name": "string",
      "timeZoneId": "string"
    }
  ]
}