Period Types and Occurrences¶
The Period Types are essential part of Schedule and currently these Period Types are supported:
The Occurrences are part of Period Types describing the type of occurrence on specific Period Type. Occurrences are triggered by the Schedule’s
Currently supported Occurrences are:
Used only for Custom Period Type since it will always have only one occurrence.
Will occur infinitely.
Number Of Times¶
Will occur for the specified number of times described through number declared Schedule’s
Period Types and Occurrences Combinations¶
The combination of Period Types and the supported Occurrences for Period Type.
|Period Occurrence||None||Infinite||Number Of Times||Until End Date|
Period Types and Occurrences with Required [Schedule](/v1/schedule) Model Properties¶
|Schedule Model Properties|
|Infinite||Daily, Weekly, Monthly and Quarterly|
|Number Of Times||Daily, Weekly, Monthly and Quarterly||✔|
|Until End Date||Daily, Weekly, Monthly and Quarterly||✔|
Beware that the API will raise an exception when not needed property is sent for some combination of Period Type and Occurrence. Eg. if for Daily Period Type as Infinite Occurrence is sent not needed
endDate property, this will raise an exception with message: “Daily period type of Infinite occurrence type cannot have an end date assigned to it!”.