GET cashdesk/getDinersIdBySurname?Surname={Surname}&UseDiacritics={UseDiacritics}&CashDesk={CashDesk}&Token={Token}

Retrieve a list of diners with basic information by surname.

Request Information

Authorization

Authorization by token required

Availability

Method can be used

URI Parameters

Name	Description	Type	Additional information
Surname	Searched diner name in format "name" + "surname". The symbol % can be used as wildcard.	string	Required String length: inclusive between 0 and 100
UseDiacritics	Optional parameter may be omitted. Search data by using case sensitivity and diacritical signs or not. The meaning is: 1 - with diacritical signs and case sensitivity; 0 - without diacritical signs and case insensitivity. Default value is 0	integer	Range: inclusive between 0 and 1
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

CashDeskGetDinersIdBySurnameResp

Name	Description	Type	Additional information
Diners	List of diners.	Collection of CashDeskDinerSimple	None.

Response Formats

application/json

Sample:

{"Diners":[{"PersonSystemId":"f1f8d01b-f3f8-414a-b264-03f81f1e8b19","Name":"John","Surname":"Doe","PersonId":"00005","DegreeInFrontName":null,"DegreeAfterName":null,"Valid":true}]}

application/xml

Sample:


<CashDeskGetDinersIdBySurnameResp>
  <Diners>
    <CashDeskDinerSimple>
      <PersonSystemId>f1f8d01b-f3f8-414a-b264-03f81f1e8b19</PersonSystemId>
      <Name>John</Name>
      <Surname>Doe</Surname>
      <PersonId>00005</PersonId>
      <Valid>true</Valid>
    </CashDeskDinerSimple>
  </Diners>
</CashDeskGetDinersIdBySurnameResp>