Retrieve a configured schedule
1 min
GET
https://api.fictive.com/REST/api/products/{productReference}/schedules
Path Parameters
- productReferencestringrequired
Query Parameters
- pastDatesboolean
Header Parameters
- X-TokenIdstringDescription
- X-SessionIdstringDescription
- X-VersionstringrequiredDescription
- OriginstringDescription
Responses
200
- FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.PublicationCalendarResponse[]Description
- scheduleReferencestring
- entitlementFormatstring
- friendlyNamestring
- scheduleTypestring
- dailyScheduleFictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.DailyScheduleDescription
- issuingTimestring
- mondayboolean
- tuesdayboolean
- wednesdayboolean
- thursdayboolean
- fridayboolean
- saturdayboolean
- sundayboolean
- monthlyScheduleFictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.MonthlyScheduleDescription
- issuingDayinteger<int32>
- issuingTimestring
- annualScheduleFictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.AnnualScheduleDescription
- issuingMonthstring
- issuingDayinteger<int32>
- issuingTimestring
- customScheduleFictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.CustomScheduleDescription
- startDatestring<date-time>Example
- issuingFrequencystring
- issuingUnitinteger<int32>
- irregularSchedulestring[]Example
- nonIssuingDatesstring[]Example
- issuePriorToStartboolean
- entitlementEndsFictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.EntitlementEndDescription
- endsNeverboolean
- endsAfterTimeUnitstring
- endsAfterNumberOfTimeUnitsinteger<int32>
- endsDateTimestring<date-time>
204
- FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.PublicationCalendarResponse[]Description
- scheduleReferencestring
- entitlementFormatstring
- friendlyNamestring
- scheduleTypestring
- dailyScheduleFictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.DailyScheduleDescription
- issuingTimestring
- mondayboolean
- tuesdayboolean
- wednesdayboolean
- thursdayboolean
- fridayboolean
- saturdayboolean
- sundayboolean
- monthlyScheduleFictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.MonthlyScheduleDescription
- issuingDayinteger<int32>
- issuingTimestring
- annualScheduleFictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.AnnualScheduleDescription
- issuingMonthstring
- issuingDayinteger<int32>
- issuingTimestring
- customScheduleFictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.CustomScheduleDescription
- startDatestring<date-time>Example
- issuingFrequencystring
- issuingUnitinteger<int32>
- irregularSchedulestring[]Example
- nonIssuingDatesstring[]Example
- issuePriorToStartboolean
- entitlementEndsFictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.EntitlementEndDescription
- endsNeverboolean
- endsAfterTimeUnitstring
- endsAfterNumberOfTimeUnitsinteger<int32>
- endsDateTimestring<date-time>
401
404
500
curl
curl --request GET \
--url https://api.fictive.com/REST/api/products/{productReference}/schedules \
--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/products/{productReference}/schedules", 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/products/{productReference}/schedules")
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/products/{productReference}/schedules"
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
[
{
"scheduleReference": "001CA72IBXWWAV51M2",
"entitlementFormat": "EntitlementFormat1",
"friendlyName": "Example name 1",
"scheduleType": "Daily",
"dailySchedule": {
"issuingTime": "05:33",
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false
},
"nonIssuingDates": [
"2021-09-21",
"2021-11-21"
],
"issuePriorToStart": false,
"entitlementEnds": {
"endsNever": false,
"endsAfterTimeUnit": "days",
"endsAfterNumberOfTimeUnits": 2
}
},
{
"scheduleReference": "001CAPXW95X1T69HK2",
"entitlementFormat": "EntitlementFormat2",
"friendlyName": "Example name 2",
"scheduleType": "Monthly",
"monthlySchedule": {
"issuingDay": 21,
"issuingTime": "05:33"
},
"nonIssuingDates": [],
"issuePriorToStart": false,
"entitlementEnds": {
"endsNever": true
}
},
{
"scheduleReference": "001CAS4VA3ZP3HYOU2",
"entitlementFormat": "EntitlementFormat3",
"friendlyName": "Example name 3",
"scheduleType": "Annual",
"annualSchedule": {
"issuingMonth": "September",
"issuingDay": 21,
"issuingTime": "05:33"
},
"nonIssuingDates": [],
"issuePriorToStart": false,
"entitlementEnds": {
"endsNever": false,
"endsDateTime": "2021-09-21T05:33:24.2917612"
}
}
]204
// No Content
[
{
"scheduleReference": "",
"entitlementFormat": "",
"friendlyName": "",
"scheduleType": "",
"dailySchedule": {
"issuingTime": "",
"monday": false,
"tuesday": false,
"wednesday": false,
"thursday": false,
"friday": false,
"saturday": false,
"sunday": false
},
"monthlySchedule": {
"issuingDay": "",
"issuingTime": ""
},
"annualSchedule": {
"issuingMonth": "",
"issuingDay": "",
"issuingTime": ""
},
"customSchedule": {
"startDate": "2021-09-21T05:33:24.1511371",
"issuingFrequency": "",
"issuingUnit": ""
},
"irregularSchedule": [
""
],
"nonIssuingDates": [
""
],
"issuePriorToStart": false,
"entitlementEnds": {
"endsNever": false,
"endsAfterTimeUnit": "",
"endsAfterNumberOfTimeUnits": "",
"endsDateTime": ""
}
}
]401
// Not Authorized
404
// Product cannot be found
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.