GET api/v3/Shifts/GetTodaysShifts

Get's all the shift days for today

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of ShiftDayResult objects.

Collection of ShiftDayResult
NameDescriptionTypeAdditional information
ShiftId

integer

None.

ShiftName

string

None.

ShiftDayId

integer

None.

ShitDay

date

None.

Start

date

None.

End

date

None.

SignedUp

boolean

None.

ShiftType

integer

None.

Signups

Collection of ShiftDaySignupResult

None.

Needs

Collection of ShiftDayGroupNeedsResult

None.

Response Formats

application/json

Sample:
[
  {
    "ShiftId": 1,
    "ShiftName": "sample string 2",
    "ShiftDayId": 3,
    "ShitDay": "2017-08-21T04:29:34.7710278+00:00",
    "Start": "2017-08-21T04:29:34.7710278+00:00",
    "End": "2017-08-21T04:29:34.7710278+00:00",
    "SignedUp": true,
    "ShiftType": 8,
    "Signups": [
      {
        "UserId": "sample string 1",
        "Roles": [
          1,
          2
        ]
      },
      {
        "UserId": "sample string 1",
        "Roles": [
          1,
          2
        ]
      }
    ],
    "Needs": [
      {
        "GroupId": 1,
        "GroupNeeds": [
          {
            "RoleId": 1,
            "Needed": 2
          },
          {
            "RoleId": 1,
            "Needed": 2
          }
        ]
      },
      {
        "GroupId": 1,
        "GroupNeeds": [
          {
            "RoleId": 1,
            "Needed": 2
          },
          {
            "RoleId": 1,
            "Needed": 2
          }
        ]
      }
    ]
  },
  {
    "ShiftId": 1,
    "ShiftName": "sample string 2",
    "ShiftDayId": 3,
    "ShitDay": "2017-08-21T04:29:34.7710278+00:00",
    "Start": "2017-08-21T04:29:34.7710278+00:00",
    "End": "2017-08-21T04:29:34.7710278+00:00",
    "SignedUp": true,
    "ShiftType": 8,
    "Signups": [
      {
        "UserId": "sample string 1",
        "Roles": [
          1,
          2
        ]
      },
      {
        "UserId": "sample string 1",
        "Roles": [
          1,
          2
        ]
      }
    ],
    "Needs": [
      {
        "GroupId": 1,
        "GroupNeeds": [
          {
            "RoleId": 1,
            "Needed": 2
          },
          {
            "RoleId": 1,
            "Needed": 2
          }
        ]
      },
      {
        "GroupId": 1,
        "GroupNeeds": [
          {
            "RoleId": 1,
            "Needed": 2
          },
          {
            "RoleId": 1,
            "Needed": 2
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfShiftDayResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Shifts">
  <ShiftDayResult>
    <End>2017-08-21T04:29:34.7710278+00:00</End>
    <Needs>
      <ShiftDayGroupNeedsResult>
        <GroupId>1</GroupId>
        <GroupNeeds>
          <ShiftDayGroupRoleNeedsResult>
            <Needed>2</Needed>
            <RoleId>1</RoleId>
          </ShiftDayGroupRoleNeedsResult>
          <ShiftDayGroupRoleNeedsResult>
            <Needed>2</Needed>
            <RoleId>1</RoleId>
          </ShiftDayGroupRoleNeedsResult>
        </GroupNeeds>
      </ShiftDayGroupNeedsResult>
      <ShiftDayGroupNeedsResult>
        <GroupId>1</GroupId>
        <GroupNeeds>
          <ShiftDayGroupRoleNeedsResult>
            <Needed>2</Needed>
            <RoleId>1</RoleId>
          </ShiftDayGroupRoleNeedsResult>
          <ShiftDayGroupRoleNeedsResult>
            <Needed>2</Needed>
            <RoleId>1</RoleId>
          </ShiftDayGroupRoleNeedsResult>
        </GroupNeeds>
      </ShiftDayGroupNeedsResult>
    </Needs>
    <ShiftDayId>3</ShiftDayId>
    <ShiftId>1</ShiftId>
    <ShiftName>sample string 2</ShiftName>
    <ShiftType>8</ShiftType>
    <ShitDay>2017-08-21T04:29:34.7710278+00:00</ShitDay>
    <SignedUp>true</SignedUp>
    <Signups>
      <ShiftDaySignupResult>
        <Roles xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </Roles>
        <UserId>sample string 1</UserId>
      </ShiftDaySignupResult>
      <ShiftDaySignupResult>
        <Roles xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </Roles>
        <UserId>sample string 1</UserId>
      </ShiftDaySignupResult>
    </Signups>
    <Start>2017-08-21T04:29:34.7710278+00:00</Start>
  </ShiftDayResult>
  <ShiftDayResult>
    <End>2017-08-21T04:29:34.7710278+00:00</End>
    <Needs>
      <ShiftDayGroupNeedsResult>
        <GroupId>1</GroupId>
        <GroupNeeds>
          <ShiftDayGroupRoleNeedsResult>
            <Needed>2</Needed>
            <RoleId>1</RoleId>
          </ShiftDayGroupRoleNeedsResult>
          <ShiftDayGroupRoleNeedsResult>
            <Needed>2</Needed>
            <RoleId>1</RoleId>
          </ShiftDayGroupRoleNeedsResult>
        </GroupNeeds>
      </ShiftDayGroupNeedsResult>
      <ShiftDayGroupNeedsResult>
        <GroupId>1</GroupId>
        <GroupNeeds>
          <ShiftDayGroupRoleNeedsResult>
            <Needed>2</Needed>
            <RoleId>1</RoleId>
          </ShiftDayGroupRoleNeedsResult>
          <ShiftDayGroupRoleNeedsResult>
            <Needed>2</Needed>
            <RoleId>1</RoleId>
          </ShiftDayGroupRoleNeedsResult>
        </GroupNeeds>
      </ShiftDayGroupNeedsResult>
    </Needs>
    <ShiftDayId>3</ShiftDayId>
    <ShiftId>1</ShiftId>
    <ShiftName>sample string 2</ShiftName>
    <ShiftType>8</ShiftType>
    <ShitDay>2017-08-21T04:29:34.7710278+00:00</ShitDay>
    <SignedUp>true</SignedUp>
    <Signups>
      <ShiftDaySignupResult>
        <Roles xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </Roles>
        <UserId>sample string 1</UserId>
      </ShiftDaySignupResult>
      <ShiftDaySignupResult>
        <Roles xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </Roles>
        <UserId>sample string 1</UserId>
      </ShiftDaySignupResult>
    </Signups>
    <Start>2017-08-21T04:29:34.7710278+00:00</Start>
  </ShiftDayResult>
</ArrayOfShiftDayResult>