PUT api/v3/Staffing/SetStaffingForUser

Sets the staffing level (state) for the UserId specificed in the input data.

Request Information

URI Parameters

None.

Body Parameters

StateInput object with the State to set.

StaffingInputV3
NameDescriptionTypeAdditional information
Uid

UserId (GUID/UUID) of the User to set. This field will be ignored if the input is used on a function that is setting status for the current user.

string

None.

Typ

The state/staffing level of the user to set for the user.

integer

None.

Not

Note for the staffing level

string

None.

Request Formats

application/json

Sample:
{
  "Uid": "sample string 1",
  "Typ": 2,
  "Not": "sample string 3"
}

application/xml, text/xml

Sample:
<StaffingInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Staffing">
  <Not>sample string 3</Not>
  <Typ>2</Typ>
  <Uid>sample string 1</Uid>
</StaffingInput>

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.