POST Authentication/Login
Request Information
URI Parameters
None.
Body Parameters
LoginRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginType | integer |
None. |
|
| PhonePrefix | string |
None. |
|
| Phone | string |
None. |
|
| UniqueID | string |
None. |
|
| Password | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"LoginType": 1,
"PhonePrefix": "sample string 2",
"Phone": "sample string 3",
"UniqueID": "sample string 4",
"Password": "sample string 5"
}
application/xml, text/xml
Sample:
<AuthenticationViewModel.LoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HizirYetisAPI.ViewModels"> <LoginType>1</LoginType> <Password>sample string 5</Password> <Phone>sample string 3</Phone> <PhonePrefix>sample string 2</PhonePrefix> <UniqueID>sample string 4</UniqueID> </AuthenticationViewModel.LoginRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
LoginResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| UserID | integer |
None. |
|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| LoggedUserData | LoggedUserDataResponse |
None. |
Response Formats
application/json, text/json
Sample:
{
"UserID": 1,
"Success": true,
"Message": "sample string 3",
"LoggedUserData": {
"UserID": 1,
"Name": "sample string 2",
"PhonePrefix": "sample string 3",
"Phone": "sample string 4",
"Email": "sample string 5",
"LoginType": 6,
"LoginTypeValue": "sample string 7",
"IsCorporate": true,
"ActiveAddressID": 9
}
}
application/xml, text/xml
Sample:
<AuthenticationViewModel.LoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HizirYetisAPI.ViewModels">
<LoggedUserData>
<ActiveAddressID>9</ActiveAddressID>
<Email>sample string 5</Email>
<IsCorporate>true</IsCorporate>
<LoginType>6</LoginType>
<LoginTypeValue>sample string 7</LoginTypeValue>
<Name>sample string 2</Name>
<Phone>sample string 4</Phone>
<PhonePrefix>sample string 3</PhonePrefix>
<UserID>1</UserID>
</LoggedUserData>
<Message>sample string 3</Message>
<Success>true</Success>
<UserID>1</UserID>
</AuthenticationViewModel.LoginResponse>