GET | /em/location/proximity | Proximity search for existing Locations. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
X | query | Yes | Longitude / X (WGS 84) | |
Y | query | Yes | Latitude / Y (WGS 84) | |
Range | query | No | Result in range (Unit meter) | |
FindCriteria | query | No | Query the data using this find criteria(s). If NULL/empty implemented as FindAll | |
SortOrder | query | Yes | sortOrder: comma separated list of tupels of attribute path and sort direction (ASC/DESC), path and sort direction are separated by a pipe (|), e.g.: name|DESC,locationId|ASC | |
ItemsPerPage | query | Yes | Max results per page (Max. 50) | |
StartIndex | query | Yes | Skip the first n result. Index starts with 0. | |
Token | query | Yes | The security token | |
Source | query | string | No | Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests. The placeholders shown need to be replaced with actual values.
GET /em/location/proximity HTTP/1.1
Host: eta.cloud.ptvgroup.com
Content-Type: application/json
Content-Length: length
{
"x": 0,
"y": 0,
"range": 0,
"findCriteria": [
"String"
],
"sortOrder": [
"String"
],
"itemsPerPage": 0,
"startIndex": 0,
"token": "String",
"source": "String"
}
The following are sample HTTP responses. The placeholders shown need to be replaced with actual values.
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length { "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } }, "proximityResults": [ { "location": { "locationId": "String", "revision": 0, "arrivedRange": 0, "searchable": false, "name": "String", "coordinate": { "locationX": 0, "locationY": 0 }, "address": { "label": "String", "country": "String", "state": "String", "province": "String", "postCode": "String", "city": "String", "city2": "String", "street": "String", "houseNumber": "String" }, "customDataFieldsForStop": [ { "name": "String", "format": "String" } ], "customData": {} }, "distance": 0 } ], "currentItemCount": 0, "itemsPerPage": 0, "startIndex": 0, "totalItems": 0 }