POST v1/SignIn

This is used to sign in to the api asynchronously using the specified credentials.

Request Information

URI Parameters

None.

Body Parameters

The credentials used to sign in.

SignInCredentials

Name	Description	Type	Additional information
Domain	The domain to sign in to.	string	Required Max length: 50
Username	The username that is used to sign in.	string	Required Max length: 50
Password	The password that is used to authenticate the user.	string	Required

Name

Description

Type

Additional information

Domain

The domain to sign in to.

string

Required

Max length: 50

Username

The username that is used to sign in.

string

Required

Max length: 50

Password

The password that is used to authenticate the user.

string

Required

Request Formats

application/json, text/json

Sample:

{
  "Domain": "sample string 1",
  "Username": "sample string 2",
  "Password": "sample string 3"
}

application/xml, text/xml

Sample:

<SignInCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Domain>sample string 1</Domain>
  <Password>sample string 3</Password>
  <Username>sample string 2</Username>
</SignInCredentials>

application/x-www-form-urlencoded

Sample:

Domain=sample&Username=sample&Password=sample

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

(200) OK if sign in is successful. (403) UnAuthorized otherwise. The response message will contain a 'X-AuthenticationToken' header that should be supplied as a 'Basic' Authorization header in further requests.

Response Message

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.