<back to API Operations

/em/journal/batch

The following routes are available for this service:
GET/em/journal/batchGet the journals of a tour or stopGet journal of tour or stop with the assigned token and SCEM-ID
Parameters:
NameParameterData TypeRequiredDescription
SCEMIDsqueryYesComma seperated list of SCEMIDs for tours or stops.
FromqueryNoGet journals from duration (timestamp)
UntilqueryNoGet journals till duration (timestamp)
EntryTypesqueryNoComma seperated availabe journal types
EventTypesqueryNoComma seperated filter with event types. Supported: POSITION, OBUTACHO, STATUS_STOP
SortOrderqueryNoSort journals (entryCreateTime|ASC, scemid|DESC)
StartIndexqueryNoSkip the first n result. Page index starts with 0 - offset (default 0))
ItemsPerPagequeryNoMax results per page - limit(default is 0 for all)
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/journal/batch HTTP/1.1 
Host: eta.cloud.ptvgroup.com 
Content-Type: application/json
Content-Length: length

{
  "scemiDs": "String",
  "from": "0001-01-01T00:00:00+00:00",
  "until": "0001-01-01T00:00:00+00:00",
  "entryTypes": "String",
  "eventTypes": "String",
  "sortOrder": "String",
  "startIndex": 0,
  "itemsPerPage": 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

{
  "journalEntries": [
    {
      "entryType": "UNDEFINED",
      "description": "String",
      "entry": "String",
      "entryCreateTime": "0001-01-01T00:00:00+00:00",
      "scemid": "String"
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  },
  "currentItemCount": 0,
  "itemsPerPage": 0,
  "startIndex": 0,
  "totalItems": 0
}