POST api/v3/Auth/ValidateForDepartment

Request Information

URI Parameters

None.

Body Parameters

SetActiveComapnyInput
NameDescriptionTypeAdditional information
Did

New Active Department Id

integer

Required

Usr

User name of the user

string

Required

Pass

The password of the user

string

Required

Request Formats

application/json

Sample:
{
  "Did": 1,
  "Usr": "sample string 2",
  "Pass": "sample string 3"
}

application/xml, text/xml

Sample:
<SetActiveComapnyInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Auth">
  <Did>1</Did>
  <Pass>sample string 3</Pass>
  <Usr>sample string 2</Usr>
</SetActiveComapnyInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ActiveCompanyResult
NameDescriptionTypeAdditional information
Tkn

Auth token if authentication and validation was successful

string

None.

Txd

Timestamp of when this token expires

string

None.

Nme

If the user settings are successful validated this will be populated by their full name

string

None.

Eml

If the user settings are successful validated this will be populated by their email address

string

None.

Uid

UserId of the current user

string

None.

Dcd

Timestamp (in Unix time) of when the department was created

string

None.

Dnm

Name of the department

string

None.

Did

Department Id

integer

None.

Response Formats

application/json

Sample:
{
  "Tkn": "sample string 1",
  "Txd": "sample string 2",
  "Nme": "sample string 3",
  "Eml": "sample string 4",
  "Uid": "sample string 5",
  "Dcd": "sample string 6",
  "Dnm": "sample string 7",
  "Did": 8
}

application/xml, text/xml

Sample:
<ActiveCompanyResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Auth">
  <Dcd>sample string 6</Dcd>
  <Did>8</Did>
  <Dnm>sample string 7</Dnm>
  <Eml>sample string 4</Eml>
  <Nme>sample string 3</Nme>
  <Tkn>sample string 1</Tkn>
  <Txd>sample string 2</Txd>
  <Uid>sample string 5</Uid>
</ActiveCompanyResult>