Create an issuing schedule

1min

POST
This endpoint will create a new issuing schedule for a product. It is possible to create a schedule for both physical and digital products. 
            If creating a configuration for a digital product, you are required to provide a digital reference.
Authentication
Authorization
Bearer
Path Parameters
productReference
string
*
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
Body Parameters
publicationCalendarRequest
FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.PublicationCalendarRequest
*
Description
DTO representing a publication calendar request
entitlementFormat
string
friendlyName
string
scheduleType
string
dailySchedule
FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.DailySchedule
monthlySchedule
FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.MonthlySchedule
annualSchedule
FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.AnnualSchedule
customSchedule
FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.CustomSchedule
irregularSchedule
string[]
nonIssuingDates
string[]
issuePriorToStart
boolean
entitlementEnds
FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.EntitlementEnd
Responses
201
Created
FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.PublicationCalendarResponse
Description
DTO representing a publication calendar response
scheduleReference
string
entitlementFormat
string
friendlyName
string
scheduleType
string
dailySchedule
FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.DailySchedule
monthlySchedule
FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.MonthlySchedule
annualSchedule
FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.AnnualSchedule
customSchedule
FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.CustomSchedule
irregularSchedule
string[]
nonIssuingDates
string[]
issuePriorToStart
boolean
entitlementEnds
FictiveGlobal.Api.Rest.Dtos.v1.PublicationCalendar.EntitlementEnd
400
An entitlement format must be provided
            <br /> An entitlement format cannot exceed 850 characters
            <br /> A friendly name is required to identify the purpose of the entitlement
            <br /> A friendly name cannot exceed 256 characters
            <br /> Invalid schedule frequency provided. Please provide one of the following values: none, daily, monthly, annual, irregular or custom
            <br /> Issuing day cannot exceed 31
            <br /> Issuing day must be 1 or more
            <br /> Issuing time must be between 00:00 - 23:59 and specified as hours and minutes only
            <br /> Invalid month provided. Please provide the full string value e.g. January
            <br /> Invalid IssuingUnit provided. Please provide a value between 1 - 999
            <br /> Invalid frequency provided. Please provide daily, weekly, monthly or annual
            <br /> Invalid date format non-issuing dates
            <br /> The date provided is invalid
            <br /> Invalid start date provided
            <br /> Invalid dates provided, please provide a date in the future
401
Not Authorized
404
Product cannot be found
409
A single product can only have 1 physical schedule configured
            <br /> A schedule exists with the provided entitlement format. An entitlement format must be unique on a product
            <br /> 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
            <br /> A schedule type of daily is required to allow the passing of a daily schedule
            <br /> A schedule type of monthly is required to allow the passing of a monthly schedule
            <br /> A schedule type of annual is required to allow the passing of an annual schedule
            <br /> A schedule type of custom is required to allow the passing of an custom schedule
            <br /> A schedule type of custom is required to allow the passing of a custom dates
            <br /> A schedule type of irregular is required to allow the passing of a irregular dates
            <br /> 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.

﻿

Updated 02 Nov 2023

Did this page help you?

Retrieve a configured schedule

Update an issuing schedule