Create a subscription holiday
1 min
POST
https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/holidays
Path Parameters
- accountReferencestringrequiredDescription
- subscriptionReferencestringrequiredDescription
Header Parameters
- X-TokenIdstringDescription
- X-SessionIdstringDescription
- X-VersionstringrequiredDescription
- OriginstringDescription
Body Parameters
- subscriptionHolidayRequestFictiveGlobal.Api.Rest.Dtos.v1.Holidays.SubscriptionHolidayrequiredDescription
- subscriptionHolidayReferencestringDescription
- subscriptionReferencestringDescription
- startDatestring<date-time>ExampleDescription
- endDatestring<date-time>ExampleDescription
Responses
200
- FictiveGlobal.Api.Rest.Dtos.v1.Holidays.SubscriptionHolidayDescription
- subscriptionHolidayReferencestringDescription
- subscriptionReferencestringDescription
- startDatestring<date-time>ExampleDescription
- endDatestring<date-time>ExampleDescription
400
401
404
412
500
curl
curl --request POST \
--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: 'POST',
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::Post.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("POST", url, headers=headers, data=payload)
print(response.text)
200
{
"subscriptionHolidayReference": "QIUQIEUQIEU8173",
"subscriptionReference": "ASJDKAS6712KDASK",
"startDate": "2021-09-21T00:00:00",
"endDate": "2021-10-01T23:59:59"
}400
// Pre-existing holiday intructions exist for the given period.
401
// Not Authorized
404
// Invalid subscription.
412
// Subscription has not met the minimum number of subscription periods to be eligible for a holiday period.
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.