POST Api/Dashboard/Login
Request Information
URI Parameters
None.
Body Parameters
ParamLoginToken| Name | Description | Type | Additional information |
|---|---|---|---|
| Username | string |
None. |
|
| Password | string |
None. |
|
| AddMinutesExpirationDate | integer |
None. |
|
| IsRememberMe | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Username": "sample string 1",
"Password": "sample string 2",
"AddMinutesExpirationDate": 1440,
"IsRememberMe": true
}
application/xml, text/xml
Sample:
<ParamLoginToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewUsers.Parameters"> <AddMinutesExpirationDate>1440</AddMinutesExpirationDate> <IsRememberMe>true</IsRememberMe> <Password>sample string 2</Password> <Username>sample string 1</Username> </ParamLoginToken>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResultOfLoginModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| ErrorMessage | Collection of string |
None. |
|
| Value | LoginModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Message": "sample string 2",
"ErrorMessage": [
"sample string 1",
"sample string 2"
],
"Value": {
"Username": "sample string 1",
"Token": "sample string 2",
"TokenExpiredTime": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"RoleName": "sample string 6",
"Email": "sample string 7",
"LoginID": 8,
"SupervisorID": 9,
"CallCenterID": 10,
"CallCenterCode": "sample string 11",
"IsActive": true,
"IsDeleted": true,
"IsPasswordSecure": true,
"Is2FA": true
}
}
application/xml, text/xml
Sample:
<ResultOfLoginModel1bJwKYq7 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Common.Returns">
<ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ErrorMessage>
<Message>sample string 2</Message>
<Success>true</Success>
<Value xmlns:d2p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewUsers.Objects">
<d2p1:CallCenterCode>sample string 11</d2p1:CallCenterCode>
<d2p1:CallCenterID>10</d2p1:CallCenterID>
<d2p1:Email>sample string 7</d2p1:Email>
<d2p1:FirstName>sample string 4</d2p1:FirstName>
<d2p1:Is2FA>true</d2p1:Is2FA>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:IsDeleted>true</d2p1:IsDeleted>
<d2p1:IsPasswordSecure>true</d2p1:IsPasswordSecure>
<d2p1:LastName>sample string 5</d2p1:LastName>
<d2p1:LoginID>8</d2p1:LoginID>
<d2p1:RoleName>sample string 6</d2p1:RoleName>
<d2p1:SupervisorID>9</d2p1:SupervisorID>
<d2p1:Token>sample string 2</d2p1:Token>
<d2p1:TokenExpiredTime>sample string 3</d2p1:TokenExpiredTime>
<d2p1:Username>sample string 1</d2p1:Username>
</Value>
</ResultOfLoginModel1bJwKYq7>