POST api/Login

Request Information

URI Parameters

None.

Body Parameters

LoginRequest
NameDescriptionTypeAdditional information
Username

string

Required

Password

string

Required

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<LoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TabPromo.TabletPos.Web.Service.Models.Api.Login.Request">
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</LoginRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LoginResponse
NameDescriptionTypeAdditional information
ResponseResult

ResponseResult

None.

response

LoginDataResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseResult": {
    "Result": true,
    "ExceptionDetail": "sample string 2"
  },
  "response": {
    "CrmId": "sample string 1",
    "Name": "sample string 2",
    "Role": 0
  }
}

application/xml, text/xml

Sample:
<LoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TabPromo.TabletPos.Web.Service.Models.Api.Login.Response">
  <ResponseResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/TabPromo.TabletPos.Web.Service.Models.Api">
    <d2p1:ExceptionDetail>sample string 2</d2p1:ExceptionDetail>
    <d2p1:Result>true</d2p1:Result>
  </ResponseResult>
  <response>
    <CrmId>sample string 1</CrmId>
    <Name>sample string 2</Name>
    <Role>Admin</Role>
  </response>
</LoginResponse>