POST api/Security/Login
Creates a new session token for the specified user
Request Information
URI Parameters
None.
Body Parameters
The username and password of the user logging in
LogonRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Username |
The user that is logging in |
string |
None. |
| Password |
The password |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Username": "sample string 1",
"Password": "sample string 2"
}
application/xml, text/xml
Sample:
<LogonRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI82830"> <Password>sample string 2</Password> <Username>sample string 1</Username> </LogonRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Status code and user details if appropriate
LogonResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | string |
None. |
|
| Firstname | string |
None. |
|
| Surname | string |
None. |
|
| PhoneNumber | string |
None. |
|
| Company | string |
None. |
|
| Token | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": "Success",
"Firstname": "sample string 2",
"Surname": "sample string 3",
"PhoneNumber": "sample string 4",
"Company": "sample string 5",
"Token": "sample string 6"
}
application/xml, text/xml
Sample:
<LogonResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector"> <Company>sample string 5</Company> <Firstname>sample string 2</Firstname> <PhoneNumber>sample string 4</PhoneNumber> <Status>Success</Status> <Surname>sample string 3</Surname> <Token>sample string 6</Token> </LogonResult>