GET api/v3/StaffingSchedules/GetStaffingSchedules

Gets the current staffing level (state) for the user

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

StateResult object with the users current staffing level

Collection of StaffingScheduleResult

Name	Description	Type	Additional information
Id	Id value of the staffing schedule	integer	None.
Typ	Type of the Staffing Schedule (Date = 1, Weekly = 2)	string	None.
Act	Is the staffing schedule currently active	boolean	None.
Spc	Specific date time the schedule triggers (if Typ = 1)	date	None.
Dow	Days of the Week the Staffing Schedule triggers (if Type = 2)	string	None.
Data	What the staffing schedule will change to	string	None.
Not	Note for this staffing schedule	string	None.

Response Formats

application/json

Sample:

[
  {
    "Id": 1,
    "Typ": "sample string 2",
    "Act": true,
    "Spc": "2020-09-03T01:20:24.3995444+00:00",
    "Dow": "sample string 4",
    "Data": "sample string 5",
    "Not": "sample string 6"
  },
  {
    "Id": 1,
    "Typ": "sample string 2",
    "Act": true,
    "Spc": "2020-09-03T01:20:24.3995444+00:00",
    "Dow": "sample string 4",
    "Data": "sample string 5",
    "Not": "sample string 6"
  }
]

application/xml, text/xml

Sample:

<ArrayOfStaffingScheduleResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.StaffingSchedules">
  <StaffingScheduleResult>
    <Act>true</Act>
    <Data>sample string 5</Data>
    <Dow>sample string 4</Dow>
    <Id>1</Id>
    <Not>sample string 6</Not>
    <Spc>2020-09-03T01:20:24.3995444+00:00</Spc>
    <Typ>sample string 2</Typ>
  </StaffingScheduleResult>
  <StaffingScheduleResult>
    <Act>true</Act>
    <Data>sample string 5</Data>
    <Dow>sample string 4</Dow>
    <Id>1</Id>
    <Not>sample string 6</Not>
    <Spc>2020-09-03T01:20:24.3995444+00:00</Spc>
    <Typ>sample string 2</Typ>
  </StaffingScheduleResult>
</ArrayOfStaffingScheduleResult>