Update an issuing schedule
1 min
PUT
https://api.fictive.com/REST/api/products/{productReference}/schedules/{scheduleReference}
Path Parameters
- productReferencestringrequired
- scheduleReferencestringrequired
Header Parameters
- X-TokenIdstringDescription
- X-SessionIdstringDescription
- X-VersionstringrequiredDescription
- OriginstringDescription
Body Parameters
- publicationCalendarRequestFictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.PublicationCalendarRequestrequiredDescription
- 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>
Responses
200
- FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.PublicationCalendarResponseDescription
- 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>
400
401
404
409
412
500
curl
curl --request PUT \
--url https://api.fictive.com/REST/api/products/{productReference}/schedules/{scheduleReference} \
--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: 'PUT',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.fictive.com/REST/api/products/{productReference}/schedules/{scheduleReference}", 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/{scheduleReference}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Put.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/{scheduleReference}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'x-version': 'string'
}
response = requests.request("PUT", 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
}
}400
// An entitlement format must be provided
An entitlement format cannot exceed 850 characters
A friendly name is required to identify the purpose of the entitlement
A friendly name cannot exceed 256 characters
Invalid schedule frequency provided. Please provide one of the following values: none, daily, monthly, annual, irregular or custom
Issuing day cannot exceed 31
Issuing day must be 1 or more
Issuing time must be between 00:00 - 23:59 and specified as hours and minutes only
Invalid month provided. Please provide the full string value e.g. January
Invalid IssuingUnit provided. Please provide a value between 1 - 999
Invalid frequency provided. Please provide daily, weekly, monthly or annual
Invalid date format non-issuing dates
The date provided is invalid
Invalid start date provided
Invalid dates provided, please provide a date in the future
401
// Not Authorized
404
// Product cannot be found
Schedule configuration cannot be found
409
// A schedule exists with the provided entitlement format. An entitlement format must be unique on a product
A schedule exists with the provided friendly name. A friendly name must be unique on a product
412
// To configure an issuing schedule, your product must be of type physical or digital
A schedule type of daily is required to allow the passing of a daily schedule
A schedule type of monthly is required to allow the passing of a monthly schedule
A schedule type of annual is required to allow the passing of an annual schedule
A schedule type of custom is required to allow the passing of an custom schedule
A schedule type of irregular is required to allow the passing of a irregular dates
Entitlement format is not supported for physical products
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.