<back to API Operations

/em/tour/batch

The following routes are available for this service:
GET/em/tour/batchread toursRead multiple tours which belongs to the specified SCEM-IDs
Parameters:
NameParameterData TypeRequiredDescription
SCEMIDSqueryYesComma separated list of tour SCEMIDs. Parametertype = query
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/tour/batch HTTP/1.1 
Host: eta.cloud.ptvgroup.com 
Content-Type: application/json
Content-Length: length

{
  "scemids": [
    "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"
    }
  },
  "tours": [
    {
      "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"
        }
      ],
      "vehicle": {
        "vehicleProfileID": "String",
        "telematicData": {
          "provider": "String",
          "vehicleId": "String",
          "startTime": "0001-01-01T00:00:00+00:00",
          "endTime": "0001-01-01T00:00:00+00:00"
        }
      },
      "drivers": [
        {
          "driverDescription": "String",
          "raSTime": {
            "referenceTime": "0001-01-01T00:00:00+00:00",
            "periodDrivenSinceLastBreak": 0,
            "periodDrivenSinceLastRest": 0,
            "currentIdlePeriod": 0,
            "isSplitBreak": false,
            "isSplitRest": false
          },
          "useRaSTime": false,
          "customData": {}
        }
      ],
      "customData": {},
      "tags": [
        "String"
      ],
      "options": {
        "plannedTourStartTime": "0001-01-01T00:00:00+00:00",
        "sessionToken": "String",
        "additionalInfo": "String",
        "doRefRouteCalc": false,
        "disableDepartedEventOnGeofence": false
      },
      "notify": [
        {
          "notificationType": "CALLBACK_URL",
          "topicType": "ETA",
          "notificationDescription": {},
          "subscriptionID": "String",
          "scemid": "String"
        }
      ],
      "scemid": "String"
    }
  ]
}