POST api/auth/login

Request Information

URI Parameters

None.

Body Parameters

LoginRequest
NameDescriptionTypeAdditional information
PhoneNumber

string

None.

Password

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<AuthController.LoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cbox.Controllers">
  <Password>sample string 2</Password>
  <PhoneNumber>sample string 1</PhoneNumber>
</AuthController.LoginRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseModelOfLoginDto
NameDescriptionTypeAdditional information
data

LoginDto

None.

success

boolean

None.

statusCode

integer

None.

message

string

None.

errorMessage

string

None.

metadata

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "data": {
    "id": 1,
    "name": "sample string 2",
    "email": "sample string 3",
    "phonenumber": "sample string 4",
    "token": "sample string 5"
  },
  "success": true,
  "statusCode": 2,
  "message": "sample string 3",
  "errorMessage": "sample string 4",
  "metadata": {}
}

application/xml, text/xml

Sample:
<ResponseModelOfLoginDtoqOm1f5oC xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cbox.Models.Response">
  <ErrorMessage>sample string 4</ErrorMessage>
  <Message>sample string 3</Message>
  <Metadata />
  <StatusCode>2</StatusCode>
  <Success>true</Success>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/cbox.Models.DTOs">
    <d2p1:Email>sample string 3</d2p1:Email>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:PhoneNumber>sample string 4</d2p1:PhoneNumber>
    <d2p1:Token>sample string 5</d2p1:Token>
  </Data>
</ResponseModelOfLoginDtoqOm1f5oC>