Retrieve subscription holidays

1 min

GET

https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/holidays

This endpoint will provide the ability to retrieve all configured subscription holidays against a specific subscription

Path Parameters

accountReferencestringrequired
subscriptionReferencestringrequired

Header Parameters

X-TokenIdstring
Description
The eSuite Token Id
X-SessionIdstring
Description
The eSuite Session Id
X-Versionstringrequired
Description
The eSuite Version
Originstring
Description
The eSuite Origin

Responses

200OK

FictiveGlobal.Api.Rest.Dtos.v1.Holidays.Allowances
Description
Subscription Holiday result Contains all the holidays for a user, grouped by holiday periods
- allowancePeriodsFictiveGlobal.Api.Rest.Dtos.v1.Holidays.AllowancePeriod[]
  Description
  List of allowance periods
  - holidaysFictiveGlobal.Api.Rest.Dtos.v1.Holidays.Holiday[]
    Description
    List of Holidays in a given allowance period
    - holidayIdentifierstring
      Description
      Holiday resource identifier
    - startDatestring<date-time>
      Example
      2021-09-21T05:33:25.1355307
      Description
      Holiday start date
    - endDatestring<date-time>
      Example
      2021-09-21T05:33:25.1355307
      Description
      Holiday end date
    - lastUpdatedDatestring<date-time>
      Example
      2021-09-21T05:33:25.1355307
      Description
      Holiday last updated date
  - allowancePeriodStartDatestring<date-time>
    Example
    2021-09-21T05:33:25.1042824
    Description
    Allowance period start date
  - allowancePeriodEndDatestring<date-time>
    Example
    2021-09-21T05:33:25.1042824
    Description
    Allowance period end date
  - holidayPeriodDaysLeftinteger<int32>
    Description
    Amount of days left in the given allowance period

401Not Authorized

500Internal Server Error

curl

curl --request GET \
     --url https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/holidays \
     --header 'accept: application/json' \
     --header 'x-version: string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-version", "string");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/holidays", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/holidays")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-version"] = "string"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/holidays"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-version': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

{
  "allowancePeriods": [
    {
      "holidays": [
        {
          "holidayIdentifier": "ABC124112",
          "startDate": "2021-09-21T00:00:00",
          "endDate": "2021-10-01T23:59:59",
          "lastUpdatedDate": "2021-09-21T05:33:25.2136609"
        },
        {
          "holidayIdentifier": "O10WCSFGE",
          "startDate": "2021-09-21T00:00:00",
          "endDate": "2021-10-01T23:59:59",
          "lastUpdatedDate": "2021-09-21T05:33:25.2136609"
        }
      ],
      "allowancePeriodStartDate": "2021-09-21T00:00:00",
      "allowancePeriodEndDate": "2021-10-01T23:59:59",
      "holidayPeriodDaysLeft": 5
    }
  ]
}

401

// Not Authorized

500

// Internal Server Error

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.