POST API/Login/DeviceLogin
Request Information
URI Parameters
None.
Body Parameters
DeviceLoginRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| string |
None. |
||
| PIN | string |
None. |
|
| DeviceID | string |
None. |
|
| DeviceType | string |
None. |
|
| DeviceNickName | string |
None. |
|
| ValidationMessage | string |
None. |
|
| ErrorCode | ErrorCodes |
None. |
Request Formats
application/json, text/json
Sample:
{
"Email": "sample string 1",
"PIN": "sample string 2",
"DeviceID": "sample string 3",
"DeviceType": "sample string 4",
"DeviceNickName": "sample string 5",
"ValidationMessage": "sample string 6",
"ErrorCode": 101
}
application/xml, text/xml
Sample:
<DeviceLoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Budget_WebAPI.Models"> <DeviceID>sample string 3</DeviceID> <DeviceNickName>sample string 5</DeviceNickName> <DeviceType>sample string 4</DeviceType> <Email>sample string 1</Email> <PIN>sample string 2</PIN> </DeviceLoginRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Login| Name | Description | Type | Additional information |
|---|---|---|---|
| string |
None. |
||
| Token | string |
None. |
|
| CustomerID | integer |
None. |
|
| SponsorID | integer |
None. |
|
| BudgetID | integer |
None. |
|
| Active | boolean |
None. |
|
| ExpirationDate | date |
None. |
|
| Success | boolean |
None. |
|
| ErrorCode | ErrorCodes |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Email": "sample string 1",
"Token": "sample string 2",
"CustomerID": 3,
"SponsorID": 1,
"BudgetID": 4,
"Active": true,
"ExpirationDate": "2026-02-20T14:22:25.4641076+00:00",
"Success": true,
"ErrorCode": 101,
"Message": "sample string 7"
}
application/xml, text/xml
Sample:
<Login xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Budget_WebAPI.Models"> <ErrorCode>InvalidToken</ErrorCode> <Message>sample string 7</Message> <Success>true</Success> <Active>true</Active> <BudgetID>4</BudgetID> <CustomerID>3</CustomerID> <Email>sample string 1</Email> <ExpirationDate>2026-02-20T14:22:25.4641076+00:00</ExpirationDate> <SponsorID>1</SponsorID> <Token>sample string 2</Token> </Login>