GET cashdesk/getDinerById?PersonSystemId={PersonSystemId}&CashDesk={CashDesk}&Token={Token}
Retrieve diner by system ID.
Request Information
Authorization
- Authorization by token required
Availability
- Method can be used
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| PersonSystemId |
Person system internal identifier. |
globally unique identifier |
Required |
| CashDesk |
The cash desk identification. The cash desk identification is used to identify the cash desk where the request is coming from. |
string |
Required |
| Token |
The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Response Codes
| Http Code | Error Number | Description |
|---|---|---|
| 200 request succesfully done | 0 | Successfully done |
| 400 bad request | 1002 | Entry parameter missing or parameter bindigs failed |
| 401 unauthorized | 1000 | Token {0} not found |
| 401 unauthorized | 1001 | Token {0} already expired |
| 401 unauthorized | 1006 | Ip filter violated for ip client address [{0}] |
| 401 unauthorized | 1007 | Ip filter [{0}] parsing failed |
| 401 unauthorized | 1008 | Request rate policy violated for [{0}] |
| 403 server refuses fo fulfill the request | 1601 | Privilege View of agenda Diners violated for [Diner {0}] |
| 403 server refuses fo fulfill the request | 8 | Not licensed |
| 404 required resource does not exist on the server | 1540 | Diner not found |
| 415 unsupported Media Type | The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported | |
| 500 internal error | Server exception description |
Resource Description
CashDeskGetDinerResp| Name | Description | Type | Additional information |
|---|---|---|---|
| PersonSystemId |
Person system internal identifier. |
globally unique identifier |
None. |
| Name |
Diner's Name. |
string |
None. |
| Surname |
Diner's Surname. |
string |
None. |
| PersonId |
Unique identification of the person in the system |
string |
None. |
| DegreeInFrontName |
Academic degree in front of the name |
string |
None. |
| DegreeAfterName |
Academic degree after the name |
string |
None. |
| ActualBalance |
The actual balance of the diner. |
decimal number |
None. |
| BalanceWarning |
The actual balance limit warning. |
decimal number |
None. |
| SpendingLimit |
Actual spending limit from deposit. |
decimal number |
None. |
| AllowDeposit |
Diner can deposit money at cashdesk |
boolean |
None. |
| Valid |
Valid diner. |
boolean |
None. |
| ErrorCode |
Error code. 0 - no error, 1 - not registered cashdesk, 2 - diner not found, 3 - not valid diner, 4 - not properly configured casdesk, 7 - no products specified, 8 - not rights to purchase, 9 - spending limit exceeded, 12 - closed period, 13 - no conversion rate specified |
integer |
None. |
| ErrorText |
Error description. |
string |
None. |
| WarnText |
Warning text. |
string |
None. |
Response Formats
application/json
{"PersonSystemId":"f1f8d01b-f3f8-414a-b264-03f81f1e8b19","Name":"John","Surname":"Doe","PersonId":"00005","DegreeInFrontName":null,"DegreeAfterName":null,"ActualBalance":-370.5,"BalanceWarning":null,"SpendingLimit":4629.5,"AllowDeposit":true,"Valid":true,"ErrorCode":0,"ErrorText":null,"WarnText":null}
application/xml
<CashDeskGetDinerResp> <PersonSystemId>f1f8d01b-f3f8-414a-b264-03f81f1e8b19</PersonSystemId> <PersonId>00005</PersonId> <ActualBalance>-370.5</ActualBalance> <BalanceWarning d2p1:nil="true" xmlns:d2p1="http://www.w3.org/2001/XMLSchema-instance" /> <SpendingLimit>4629.5</SpendingLimit> <AllowDeposit>true</AllowDeposit> <Valid>true</Valid> <ErrorCode>0</ErrorCode> </CashDeskGetDinerResp>