<back to API Operations

/em/stop/search

The following routes are available for this service:
POST/em/stop/searchsearch stopSearch stop
Parameters:
NameParameterData TypeRequiredDescription
LocationIDqueryYes
SearchFieldContentbodySearchFieldContentYes
TokenqueryYesThe security token
SourcequerystringNoName 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

HTTP + JSON Request

The following are sample HTTP requests. The placeholders shown need to be replaced with actual values.

POST /em/stop/search HTTP/1.1 
Host: eta.cloud.ptvgroup.com 
Content-Type: application/json
Content-Length: length

{
  "locationID": "String",
  "searchFieldContent": {
    "searchFields": [
      {
        "fieldName": "String",
        "fieldValue": "String",
        "fieldLabel": "String"
      }
    ]
  },
  "token": "String",
  "source": "String"
}
                    

HTTP + JSON Response

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"
    }
  },
  "stops": [
    {
      "coordinate": {
        "locationX": 0,
        "locationY": 0
      },
      "earliestArrivalTime": "0001-01-01T00:00:00+00:00",
      "latestDepartureTime": "0001-01-01T00:00:00+00:00",
      "pta": "0001-01-01T00:00:00+00:00",
      "serviceTimeAtStop": 0,
      "useServicePeriodForRecreation": false,
      "weightWhenLeavingStop": 0,
      "stopPositionInTour": 0,
      "customData": {},
      "locationId": "String",
      "useLocationAddress": false,
      "address": {
        "label": "String",
        "country": "String",
        "state": "String",
        "province": "String",
        "postCode": "String",
        "city": "String",
        "city2": "String",
        "street": "String",
        "houseNumber": "String"
      },
      "scemid": "String"
    }
  ]
}