POST api/Authentication

Authenticate System User based on provided username and password

Request Information

URI Parameters

None.

Body Parameters

SystemUserLoginRequest
NameDescriptionTypeAdditional information
Login

string

None.

Password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Login": "sample string 1",
  "Password": "sample string 2"
}

application/xml, text/xml

Sample:
<SystemUserLoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests">
  <Login>sample string 1</Login>
  <Password>sample string 2</Password>
</SystemUserLoginRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponseOfSystemUserLoginResponse
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Errors

Collection of string

None.

Data

SystemUserLoginResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": {
    "IsLoginSuccessfully": true
  }
}

application/xml, text/xml

Sample:
<ApiResponseOfSystemUserLoginResponseLgVmlFmJ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Response">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses">
    <d2p1:IsLoginSuccessfully>true</d2p1:IsLoginSuccessfully>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <IsSuccess>true</IsSuccess>
</ApiResponseOfSystemUserLoginResponseLgVmlFmJ>