POST api/v3/StaffingSchedules/CreateStaffingSchedule

Toggles and Scheduled Staffing Level Change (Enabling or Disabling It)

Request Information

URI Parameters

None.

Body Parameters

StaffingScheduleInput
NameDescriptionTypeAdditional information
Typ

Type of staffing schedule (Date = 1, Weekly = 2)

integer

None.

Spd

Specific Date to trigger (if Type = 1)

string

None.

Spt

Specific time to trigger

string

None.

Ste

State the staffing level will get set to

string

None.

Sun

Trigger on Sunday (if Type - 2)

boolean

None.

Mon

Trigger on Monday (if Type - 2)

boolean

None.

Tue

Trigger on Tuesday (if Type - 2)

boolean

None.

Wed

Trigger on Wednesday (if Type - 2)

boolean

None.

Thu

Trigger on Thursday (if Type - 2)

boolean

None.

Fri

Trigger on Friday (if Type - 2)

boolean

None.

Sat

Trigger on Saturday (if Type - 2)

boolean

None.

Not

Note for this staffing schedule

string

None.

Request Formats

application/json

Sample:
{
  "Typ": 1,
  "Spd": "sample string 2",
  "Spt": "sample string 3",
  "Ste": "sample string 4",
  "Sun": true,
  "Mon": true,
  "Tue": true,
  "Wed": true,
  "Thu": true,
  "Fri": true,
  "Sat": true,
  "Not": "sample string 12"
}

application/xml, text/xml

Sample:
<StaffingScheduleInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.StaffingSchedules">
  <Fri>true</Fri>
  <Mon>true</Mon>
  <Not>sample string 12</Not>
  <Sat>true</Sat>
  <Spd>sample string 2</Spd>
  <Spt>sample string 3</Spt>
  <Ste>sample string 4</Ste>
  <Sun>true</Sun>
  <Thu>true</Thu>
  <Tue>true</Tue>
  <Typ>1</Typ>
  <Wed>true</Wed>
</StaffingScheduleInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns HttpStatusCode Created if successful, BadRequest otherwise.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.