Create a new service allocation

Creates a new service allocation. You must specify a StartDateTime and EndDateTime.
A reason for the allocation is also required. This reason will display in the OnSched Portal Calendar.

Service allocations are used primarily for event type services. The allocation represents an occurrence of an allocation.

Service allocations can be set to specific time ranges or for the whole day. Use the AllDay setting to create an all day block.

Service allocations can be for a specific date range instance or set to repeat at a specified frequency.
The frequency can be set to a value of D,W,M,Y for Day, Week, Month, or Year respecitively.

Daily allocations will repeat for each day of the week for the date range specified.

Weekly allocations will repeat only on the specified days of the week for the date range specified. For a weekly block
you must also specify the weekdays. Weekdays are expressed as a string of digits with each single digit in the string representing a day
of the week. The possible values are 0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wed, 4=Thursday, 5=Friday, 6=Saturday.
For example a repeat weekly entry with weekdays 24 repeats each week on Tuesday and Thursday.

Use the interval property to specify the interval that the allocation repeats. For example an interval of 2 for a weekly block means that
the block will repeat every second week beginning at the day specified. A daily block with an interval of 10 means the block will
repeat every 10 days. The interval property applies to all repeat frequencies.

Monthly allocations repeat either on the day of the month specified in the month day property or on the day of the week and week of the month specified by
the start date. For example, repeat every 3rd friday of each month, repeat on the 21st day of the month.

Repeat allocations will end on the date specified by the end date. You can specify 9999-12-31 in the EndDate field to indicate the repeating block
should continue indefinitely.

Log Out
Click Try It! to start a request and see the response here!