POST api/schedule/CreateRecurringSchedule

Create Recurring Schedule

Request Information

URI Parameters

None.

Body Parameters

RecurringScheduleRequestModel
NameDescriptionTypeAdditional information
RotateStep

(Required) Default '1', Can not be greater than Routing Rule Members Count

integer

None.

RotateFrequency

(Required) Default '1', Can not be 0 or negative

integer

None.

RotateRoleOption

(Required) Default 'Weeks', 1 = 'Months', 2 = 'Weeks', 3 = 'Days'

integer

None.

RotateTime

(Required) Default '00:00' 24 Hour time format

string

None.

RotateStartOption

(Optional) '0' If RotateRoleOption == 1 or 3, Default 'Monday', 0 = Sun, 1 = Mon, 2 = Tues, 3 = Wed, 4 = Thu, 5 = Fri, 6 = Sat

integer

None.

IsRepeat

(Optional) Default 'False', Set 'True' to pass 'RepeatAfterNumberOfTime' and 'RepeatEndDate'

boolean

None.

RepeatAfterNumberOfTime

(Optional) Integer, Required if IsRepeat is 'True'

integer

None.

RepeatEndDate

(Optional) Date Time Format 'mm/dd/yy', Required if IsRepeat is 'True'

string

None.

GroupID

integer

Required

ScheduleName

string

Required

StartDate

(Required) for Recurring Schedule, (Optional) for Fixed Schedule, Date Time Format 'mm/dd/yy', Required if End Date is Passed

string

None.

EndDate

(Required) for Recurring Schedule, (Optional) for Fixed Schedule, Date Time Format 'mm/dd/yy', Required if Start Date is Passed

string

None.

IsContinuous

Pass 'True' to select all week days options

boolean

None.

GroupMembersIncluded

Default 'True' for Recurring Schedule; Default 'False' for Fixed Schedule to Manually Provide Member Details

boolean

None.

RoutingRuleMembers

(Required) for Recurring Schedule; (Optional) for Fixed Schedule, Provide if GroupMembersIncluded is 'False', Sample: [{"MemberID":"720", "Role":"2"}]; For Fixed Schedule : Role = "1" | "2", For Recurring Schedule : Role = "0" | "1" | "2"; "1" = Primary , "2" = Secondary

Collection of RoutingRuleMember

None.

StartDay

Default 'Sunday'. 0 = Sun, 1 = Mon, 2 = Tues, 3 = Wed, 4 = Thu, 5 = Fri, 6 = Sat

integer

None.

EndDay

Default 'Saturday'. 0 = Sun, 1 = Mon, 2 = Tues, 3 = Wed, 4 = Thu, 5 = Fri, 6 = Sat

integer

None.

StartTime

Default '00:00'. 24 Hour time format eg: '16:45'

string

None.

EndTime

Default '23:59'. 24 Hour time format eg: '16:45'

string

None.

Sunday

Default 'True'

boolean

None.

Monday

Default 'True'

boolean

None.

Tuesday

Default 'True'

boolean

None.

Wednesday

Default 'True'

boolean

None.

Thursday

Default 'True'

boolean

None.

Friday

Default 'True'

boolean

None.

Saturday

Default 'True'

boolean

None.

APIKey

string

Required

Request Formats

text/json, application/json

Sample:
{
     "APIKey": "12ae8a55-22ee-4761-ac59-d8e6d182ef78",
     "GroupID":"66",
     "ScheduleName": "TestApi",
     "RoutingRuleMembers":[{"MemberID":354, "Role":"1"}, {"MemberID":720, "Role":"0"}],
     "StartDate":"07/25/17",
     "EndDate":"07/30/17",
     "IsRepeat":"true",
     "RepeatEndDate":"08/06/17",
     "RepeatAfterNumberOfTime":"1",
     "RotateStep":"2",
     "RotateFrequency":"1",
     "RotateRoleOption":"1",
     "RotateStartOption":"3",
     "RotateTime":"21:45",
     "StartTime" : "20:45",
     "EndTime" : "22:45"
}

Response Information

Resource Description

RoutingRuleID integer; "0" if unchanged

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.