POST api/BackOffice/AccountCredit
Receive request to get all backoffice accounts
Request Information
URI Parameters
None.
Body Parameters
authentication request object
AccountCreditRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| DataAreaId |
The Ax Company (AMSA/USA...) |
string |
Required Max length: 5 |
| Code |
The Account Code (BEPR/PRVT...) |
string |
Required Max length: 4 |
| UserName |
The provided user name. |
string |
Required |
| Salt |
A random number(at least 9 digits) |
integer |
Required |
| Digest |
A digest of the user credentials and the request |
string |
Required |
Request Formats
application/json, text/json
Sample:
{
"DataAreaId": "sample string 1",
"Code": "sample string 2",
"UserName": "sample string 3",
"Salt": 4,
"Digest": "sample string 5"
}
application/xml, text/xml
Sample:
<AccountCreditRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" UserName="sample string 3" Salt="4" Digest="sample string 5"> <DataAreaId>sample string 1</DataAreaId> <Code>sample string 2</Code> </AccountCreditRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
accounts json object
AccountCreditResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Account | PoorAccountDetails |
None. |
|
| Success |
Indicate if the operation was success |
boolean |
None. |
| Message |
Return of errors or indicated return message/data |
string |
None. |
| Extra1 |
Additional info 1 to return |
string |
None. |
| Extra2 |
Additional info 2 to return |
string |
None. |
| Extra3 |
Additional info 3 to return |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Account": {
"DataAreaId": "sample string 1",
"Name": "sample string 2",
"Code": "sample string 3",
"CreditMax": 4.1,
"CreditRemaining": 5.1
},
"Success": true,
"Message": "sample string 2",
"Extra1": "sample string 3",
"Extra2": "sample string 4",
"Extra3": "sample string 5"
}
application/xml, text/xml
Sample:
<AccountCreditResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Success>true</Success>
<Message>sample string 2</Message>
<Extra1>sample string 3</Extra1>
<Extra2>sample string 4</Extra2>
<Extra3>sample string 5</Extra3>
<Account>
<DataAreaId>sample string 1</DataAreaId>
<Name>sample string 2</Name>
<Code>sample string 3</Code>
<CreditMax>4.1</CreditMax>
<CreditRemaining>5.1</CreditRemaining>
</Account>
</AccountCreditResponse>