POST api/account/authenticateuser
Authenticate a user by Username and Password.
Request Information
URI Parameters
None.
Body Parameters
AuthenticateUser| Name | Description | Type | Additional 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:
<AuthenticateUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Request"> <password>sample string 2</password> <username>sample string 1</username> </AuthenticateUser>
application/x-www-form-urlencoded
Sample:
username=sample string 1&password=sample string 2
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="username" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="password" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
ResponseOfUser| Name | Description | Type | Additional information |
|---|---|---|---|
| Message | string |
None. |
|
| Success | boolean |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| Data | User |
None. |
|
| Errors | Dictionary of string [key] and Collection of string [value] |
None. |
Response Formats
application/json, text/json
Sample:
{
"message": "sample string 1",
"success": true,
"statusCode": 100,
"data": {
"userId": "sample string 1",
"email": "sample string 2",
"firstName": "sample string 3",
"lastName": "sample string 4",
"active": true,
"applications": [
{
"applicationName": "sample string 1",
"applicationId": 2
},
{
"applicationName": "sample string 1",
"applicationId": 2
}
],
"sites": [
{
"siteName": "sample string 1",
"siteId": 2
},
{
"siteName": "sample string 1",
"siteId": 2
}
],
"roles": [
{
"roleId": "sample string 1",
"roleName": "sample string 2"
},
{
"roleId": "sample string 1",
"roleName": "sample string 2"
}
]
},
"errors": {
"sample string 1": [
"sample string 1",
"sample string 2"
],
"sample string 2": [
"sample string 1",
"sample string 2"
]
}
}
application/xml, text/xml
Sample:
<ResponseOfUseroHrw366j xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Response">
<Data>
<Active>true</Active>
<Applications>
<UserApplication>
<ApplicationId>2</ApplicationId>
<ApplicationName>sample string 1</ApplicationName>
</UserApplication>
<UserApplication>
<ApplicationId>2</ApplicationId>
<ApplicationName>sample string 1</ApplicationName>
</UserApplication>
</Applications>
<Email>sample string 2</Email>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Roles>
<UserRole>
<RoleId>sample string 1</RoleId>
<RoleName>sample string 2</RoleName>
</UserRole>
<UserRole>
<RoleId>sample string 1</RoleId>
<RoleName>sample string 2</RoleName>
</UserRole>
</Roles>
<Sites>
<UserSite>
<SiteId>2</SiteId>
<SiteName>sample string 1</SiteName>
</UserSite>
<UserSite>
<SiteId>2</SiteId>
<SiteName>sample string 1</SiteName>
</UserSite>
</Sites>
<UserId>sample string 1</UserId>
</Data>
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</d2p1:Value>
</d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
<d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
<d2p1:Key>sample string 2</d2p1:Key>
<d2p1:Value>
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</d2p1:Value>
</d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
</Errors>
<Message>sample string 1</Message>
<StatusCode>Continue</StatusCode>
<Success>true</Success>
</ResponseOfUseroHrw366j>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Message" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Success" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="StatusCode" Continue --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.UserId" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Email" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.FirstName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.LastName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Active" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Applications[0].ApplicationName" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Applications[0].ApplicationId" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Applications[1].ApplicationName" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Applications[1].ApplicationId" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Sites[0].SiteName" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Sites[0].SiteId" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Sites[1].SiteName" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Sites[1].SiteId" 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Roles[0].RoleId" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Roles[0].RoleName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Roles[1].RoleId" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Data.Roles[1].RoleName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Errors[0].Key" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Errors[0].Value[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Errors[0].Value[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Errors[1].Key" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Errors[1].Value[0]" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Errors[1].Value[1]" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e--