GET api/Authenticate?Username={Username}&Password={Password}&DeviceID={DeviceID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Username | string |
Required |
|
| Password | string |
Required |
|
| DeviceID | string |
Required |
Body Parameters
None.
Response Information
Resource Description
UserRecord| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| CustomerName | string |
None. |
|
| UserName | string |
None. |
|
| Password | string |
None. |
|
| SHA1 | string |
None. |
|
| UserRole | string |
None. |
|
| AuthExpired | boolean |
None. |
|
| AuthToken | string |
None. |
|
| UserID | integer |
None. |
|
| Roles | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ID": 1,
"CustomerName": "sample string 2",
"UserName": "sample string 3",
"Password": "sample string 4",
"SHA1": "sample string 5",
"UserRole": "sample string 6",
"AuthExpired": true,
"AuthToken": "sample string 8",
"UserID": 9,
"Roles": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<UserRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JAMAPI.Models">
<AuthExpired>true</AuthExpired>
<AuthToken>sample string 8</AuthToken>
<CustomerName>sample string 2</CustomerName>
<ID>1</ID>
<Password>sample string 4</Password>
<Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Roles>
<SHA1>sample string 5</SHA1>
<UserID>9</UserID>
<UserName>sample string 3</UserName>
<UserRole>sample string 6</UserRole>
</UserRecord>