1. Home
  2. Corporate Node
  3. SOAP requests
  4. readPeopleNearbyList

readPeopleNearbyList

The request readPeopleNearbyList allows to read a list of the users near given point (typically: a till of a shop). The operation should be ordered before by using requestPeopleNearbyList.

Example SOAP request:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="ns1">
   <soapenv:Header/>
   <soapenv:Body>
      <ns1:readPeopleNearbyList soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <taskId xsi:type="xsd:string">00000000000000000001QTB099</taskId>
      </ns1:readPeopleNearbyList>
   </soapenv:Body>
</soapenv:Envelope>

 

Example SOAP response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ns1">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <ns1:readPeopleNearbyListResponse>
         <return xsi:type="ns1:vuiReadPeopleNearbyResponse">
            <requestStatus>SUCCESS</requestStatus>
            <requestStatusDescription>Request succeeded.</requestStatusDescription>
            <taskId>00000000000000000001QTB099</taskId>
            <type>GET_PEOPLE_NEARBY</type>
            <progressPercent>100</progressPercent>
            <status>FINISHED_OK</status>
            <additionalInfo>{
}</additionalInfo>
            <peopleNearbyList/>
         </return>
      </ns1:readPeopleNearbyListResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

 

Request parameters:

parameter type description
taskId string task id received from requestPeopleNearbyListReponse

 

Response parameters:

name type description
peopleNearbyList peopleNearbyList list of people nearby
additionalInfo string additional info
status string task status
type string task type
progressPercent unsigned int progress percent
taskId string id of created task
requestStatus string result of request
requestStatusDescription string status description
Was this article helpful to you? Yes No

How can we help?