<back to API Operations

/em/location/arrivals

The following routes are available for this service:
GET/em/location/arrivals/{ID}This function returns stops, which use a reference to the given location id. The location id must belong to the token. The trips on the other side need not belong to the token. If the trip owner knows the location he has been informed by the location owner offline. So it can be assumed, that they agreed to exchange data.
Parameters:
NameParameterData TypeRequiredDescription
IDpathYesThe unique identifier of the requested location
FromqueryYesETA in range from
UntilqueryYesETA in range until
SortOrderqueryYessortOrder: 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
ItemsPerPagequeryYesMax results per page (Max. 50)
StartIndexqueryYesSkip the first n result. Index starts with 0.
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.

GET /em/location/arrivals HTTP/1.1 
Host: eta.cloud.ptvgroup.com 
Content-Type: application/json
Content-Length: length

{
  "from": "0001-01-01T00:00:00+00:00",
  "until": "0001-01-01T00:00:00+00:00",
  "sortOrder": [
    "String"
  ],
  "itemsPerPage": 0,
  "startIndex": 0,
  "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"
    }
  },
  "arrivals": [
    {
      "stop": {
        "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"
      },
      "status": "String",
      "timeStamp": "0001-01-01T00:00:00+00:00",
      "etaInfo": {
        "stopSCEMID": "String",
        "plannedETA": "0001-01-01T00:00:00+00:00",
        "eta": "0001-01-01T00:00:00+00:00",
        "etaSource": "PLANNED_TOUR_ETA",
        "relatedTime": "0001-01-01T00:00:00+00:00",
        "info": "String",
        "trafficTimeLoss": 0,
        "breakAndRestPeriod": 0,
        "waitingPeriod": 0,
        "lastState": "String"
      }
    }
  ],
  "currentItemCount": 0,
  "itemsPerPage": 0,
  "startIndex": 0,
  "totalItems": 0
}