{
"openapi": "3.0.0",
"servers": [
{
"url": "http://sse001.cloud.ptvlogistics.com/em"
}
],
"info": {
"title": "PTVDriveAndArrive",
"version": "1.0"
},
"paths": {
"/tour": {
"post": {
"tags": [
"tour"
],
"summary": "Create a tour",
"description": "Create a tour (relevant to billing)",
"operationId": "CreateTourV2_Post",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTourV2Response"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"$ref": "#/components/requestBodies/TourContentWrapper"
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/tour/v1": {
"post": {
"tags": [
"tour"
],
"summary": "DEPRECATEDCreate a tour",
"description": "Create a tour (relevant to billing)",
"operationId": "CreateTourv1_Post",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTourResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TourContentWrapper"
}
}
},
"description": "The legacy tour (with time intervals as mandatory)"
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/tour/batch": {
"get": {
"tags": [
"tour"
],
"summary": "read tours",
"description": "Read multiple tours which belongs to the specified SCEM-IDs",
"operationId": "ReadToursbatch_Get",
"parameters": [
{
"name": "SCEMIDS",
"in": "query",
"description": "Comma separated list of tour SCEMIDs. Parametertype = query",
"required": true,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadToursResponse"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"tour"
],
"summary": "update tour objects",
"description": "update multiple tours which belongs to the specified SCEM-IDs",
"operationId": "UpdateToursbatch_Create",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateToursResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TourContentListWrapper"
}
}
},
"description": "The tours (json)",
"required": true
}
},
"delete": {
"tags": [
"tour"
],
"summary": "delete tour objects",
"description": "Delete multiple tours which belongs to the specified SCEM-IDs",
"operationId": "DeleteToursbatch_Delete",
"parameters": [
{
"name": "SCEMIDS",
"in": "query",
"description": "Comma separated list of tour SCEMIDs",
"required": true,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteToursResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/tour/tokentags/": {
"get": {
"tags": [
"tour"
],
"summary": "EXPERIMENTAL Get all tags of the specified Token",
"description": "tags of Token",
"operationId": "FindAllTagsOfTokentokentags_Get",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FindAllTagsOfTokenResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/tour/taggedtours/": {
"get": {
"tags": [
"tour"
],
"summary": "EXPERIMENTAL Find all tours with matching tags",
"description": "Find trips for the given tags",
"operationId": "FindTaggedTourstaggedtours_Get",
"parameters": [
{
"name": "Tags",
"in": "query",
"description": "The requested tags (space seperated [0-9a-zA-Z])",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "MaxItemCount",
"in": "query",
"description": "Maximum return items. Default=DAveCache(MaxReadTourCount)",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "From",
"in": "query",
"description": "EXPERIMENTAL, not used: Timeframe from.",
"required": false,
"x-nullable": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Until",
"in": "query",
"description": "EXPERIMENTAL, not used: Timeframe until",
"required": false,
"x-nullable": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "AddTourData",
"in": "query",
"description": "If true, return all tour information: False return inly the Tour.SCEMID. Default=false",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FindTaggedToursResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/subscription/batch": {
"post": {
"tags": [
"subscription"
],
"summary": "Create multiple subscriptions",
"description": "Create multiple subscriptions which belongs to the specified SCEM-IDs",
"operationId": "CreateSubscriptionsbatch_Post",
"parameters": [
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSubscriptionsResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionContentListWrapper"
}
}
},
"description": "The subscriptions (json)",
"required": true
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/subscription/{SCEMID}": {
"get": {
"tags": [
"subscription"
],
"summary": "Find the suscriptions for a tour or stop",
"description": "Search subscriptions for a specified SCEMID",
"operationId": "ReadSubscriptionsSCEMID_Get",
"parameters": [
{
"name": "SCEMID",
"in": "path",
"description": "A 10 digit identifier (SCEM-ID) for a tour or a stop",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "SubscriptionIDS",
"in": "query",
"description": "Comma separated list of SubscriptionIDs",
"required": true,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadSubscriptionsResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/subscription/deviceidentifier": {
"get": {
"tags": [
"subscription"
],
"summary": "EXPERIMENTAL get device identifier",
"description": "Request device unique identifier",
"operationId": "GetDeviceIdentifierdeviceidentifier_Get",
"parameters": [
{
"name": "AppId",
"in": "query",
"description": "The OneSignalApp used assigned to this caller",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "UniqueReqPrefix",
"in": "query",
"description": "Key for a unique identifer",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "UniqueIdentifier",
"in": "query",
"description": "Value for a unique identifer",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDeviceIdentifierResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/subscription/uniqueidentifier": {
"get": {
"tags": [
"subscription"
],
"summary": "EXPERIMENTAL 2 unique parameter (Key/Value)",
"description": "Request unique identifiers",
"operationId": "GetUniqueIdentifieruniqueidentifier_Get",
"parameters": [
{
"name": "AppId",
"in": "query",
"description": "The OneSignal App used assigned to this caller",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetUniqueIdentifierResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/event/batch": {
"post": {
"tags": [
"event"
],
"summary": "Create events",
"description": "Create events for ETA tracking",
"operationId": "CreateEventsbatch_Post",
"parameters": [
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEventsResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventContentListWrapper"
}
}
},
"description": "The events (json)",
"required": true
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/journal/batch": {
"get": {
"tags": [
"journal"
],
"summary": "Get the journals of a tour or stop",
"description": "Get journal of tour or stop with the assigned token and SCEM-ID",
"operationId": "ReadJournalBatchbatch_Get",
"parameters": [
{
"name": "SCEMIDs",
"in": "query",
"description": "Comma seperated list of SCEMIDs for tours or stops.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "From",
"in": "query",
"description": "Get journals from duration (timestamp)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Until",
"in": "query",
"description": "Get journals till duration (timestamp)",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EntryTypes",
"in": "query",
"description": "Comma seperated availabe journal types",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "EventTypes",
"in": "query",
"description": "Comma seperated filter with event types. Supported: POSITION, OBUTACHO, STATUS_STOP",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "SortOrder",
"in": "query",
"description": "Sort journals (entryCreateTime|ASC, scemid|DESC)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "StartIndex",
"in": "query",
"description": "Skip the first n result. Page index starts with 0 - offset (default 0))",
"required": false,
"x-nullable": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ItemsPerPage",
"in": "query",
"description": "Max results per page - limit(default is 0 for all)",
"required": false,
"x-nullable": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadJournalBatchResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/stop/batch/eta": {
"get": {
"tags": [
"stop"
],
"summary": "get current etas",
"description": "Get the current ETA´s by the specified SCEM-ID´s instead of getting notified",
"operationId": "ReadStopsETAbatcheta_Get",
"parameters": [
{
"name": "SCEMIDs",
"in": "query",
"description": "Comma separated list of stop SCEMIDs",
"required": true,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "Token",
"in": "query",
"description": "Token used to get extended information, premium members only",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadStopsETAResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/stop/eta/{SCEMID}": {
"get": {
"tags": [
"stop"
],
"summary": "DEPRECATED get current eta",
"description": "Get the current ETA by the specified SCEM-ID instead of getting notified",
"operationId": "ReadStopETAetaSCEMID_Get",
"parameters": [
{
"name": "SCEMID",
"in": "path",
"description": "A 10 digit identifier (SCEM-ID) for a stop",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadStopETAResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/stop/search": {
"post": {
"tags": [
"stop"
],
"summary": "search stop",
"description": "Search stop ",
"operationId": "ReadStopSearchsearch_Post",
"parameters": [
{
"name": "LocationID",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadStopSearchResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchFieldContentWrapper"
}
}
},
"required": true
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/stop/batch": {
"get": {
"tags": [
"stop"
],
"summary": "read stops",
"description": "Read multiple stops which belongs to the specified SCEM-IDs",
"operationId": "ReadStopsbatch_Get",
"parameters": [
{
"name": "SCEMIDS",
"in": "query",
"description": "Comma separated list of stop SCEMIDs",
"required": true,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadStopsResponse"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"stop"
],
"summary": "update stop objects",
"description": "Update multiple stops which belongs to the specified SCEM-IDs",
"operationId": "UpdateStopsbatch_Create",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateStopsResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StopContentListWrapper"
}
}
},
"description": "The stops (json)",
"required": true
}
},
"delete": {
"tags": [
"stop"
],
"summary": "delete stop objects",
"description": "Delete multiple stops which belongs to the specified SCEM-IDs",
"operationId": "DeleteStopsbatch_Delete",
"parameters": [
{
"name": "SCEMIDS",
"in": "query",
"description": "Comma separated list of stop SCEMIDs",
"required": true,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteStopsResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/subscription": {
"post": {
"tags": [
"subscription"
],
"summary": "Create a subscription",
"description": "Create a subscription for specified SCEM-ID",
"operationId": "CreateSubscription_Post",
"parameters": [
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSubscriptionResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionContentWrapper"
}
}
},
"description": "The subscription (json)",
"required": true
}
},
"delete": {
"tags": [
"subscription"
],
"summary": "Remove a subscription",
"description": "Remove a subscription for a specified SCEM-ID",
"operationId": "DeleteSubscription_Delete",
"parameters": [
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteSubscriptionResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionContentWrapper"
}
}
},
"description": "The subscription",
"required": true
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/event": {
"post": {
"tags": [
"event"
],
"summary": "Create a event",
"description": "Create a event for ETA tracking",
"operationId": "CreateEvent_Post",
"parameters": [
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEventResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventContentWrapper"
}
}
},
"description": "The event (json)",
"required": true
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/stop": {
"get": {
"tags": [
"stop"
],
"summary": "read stop",
"description": "Read details of stop with the specified SCEM-ID",
"operationId": "ReadStop_Get",
"parameters": [
{
"name": "SCEMID",
"in": "query",
"description": "A 10 digit identifier (SCEM-ID) for a stop",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadStopResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/journal": {
"get": {
"tags": [
"journal"
],
"summary": "Get the journal of a tour",
"description": "Get journal of tour with the assigned token and SCEM-ID",
"operationId": "ReadJournal_Get",
"parameters": [
{
"name": "SCEMID",
"in": "query",
"description": "A 10 digit identifier (SCEM-ID) for a tour",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "StartIndex",
"in": "query",
"description": "Skip the first n result. Page index starts with 0 - offset (default 0))",
"required": false,
"x-nullable": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ItemsPerPage",
"in": "query",
"description": "Max results per page - limit(default is 0 for all)",
"required": false,
"x-nullable": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadJournalResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/token/tour/scemids": {
"get": {
"tags": [
"token"
],
"summary": "List all tour SCEM_IDs",
"description": "List all tour SCEM-IDs associated with the assigned token",
"operationId": "ReadTourSCEMIDStourscemids_Get",
"parameters": [
{
"name": "From",
"in": "query",
"description": "Tour.SCEM-ID >= From time",
"required": false,
"x-nullable": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Until",
"in": "query",
"description": "Tour.SCEM-ID before Until time",
"required": false,
"x-nullable": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "StartIndex",
"in": "query",
"description": "Skip items",
"required": false,
"x-nullable": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "MaxItems",
"in": "query",
"description": "The maximum items in the response.",
"required": false,
"x-nullable": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Descending",
"in": "query",
"description": "Sorting CreationTime, TRUE-> descending, default=FALSE.",
"required": false,
"x-nullable": false,
"schema": {
"type": "boolean"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadTourSCEMIDSResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/tour/vehicle/profile": {
"put": {
"tags": [
"tour"
],
"summary": "update tour vehicle profile",
"description": "Update Tour VehicleProfileID using Custom search fields",
"operationId": "UpdateVehicleProfilevehicleprofile_Create",
"parameters": [
{
"name": "LocationID",
"in": "query",
"description": "Stop's locationId",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "VehicleProfileID",
"in": "query",
"description": "Vehicle Profile to update",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateVehicleProfileResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchFieldContentWrapper"
}
}
},
"description": "Search Criteria on customData",
"required": true
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/tour/tags/{SCEMID}": {
"get": {
"tags": [
"tour"
],
"summary": "EXPERIMENTAL Read tags of a tour",
"description": "Read all tags for the tour with the specified Tour.SCEM-ID",
"operationId": "ReadTagsOfTourtagsSCEMID_Get",
"parameters": [
{
"name": "SCEMID",
"in": "path",
"description": "A 10 digit identifier (SCEM-ID) for a tour",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadTagsOfTourResponse"
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"tour"
],
"summary": "EXPERIMENTAL Create tags for a tour",
"description": "Create additional tags (comma seperated) for the tour with the specified Tour.SCEM-ID",
"operationId": "CreateTagsForTourtagsSCEMID_Post",
"parameters": [
{
"name": "SCEMID",
"in": "path",
"description": "A 10 digit identifier (SCEM-ID) for a tour",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Tags",
"in": "query",
"description": "Add tags (space separated [0-9a-zA-Z]) to Tour.Tags",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTagsForTourResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTagsForTourWrapper"
}
}
}
}
},
"delete": {
"tags": [
"tour"
],
"summary": "EXPERIMENTAL Delete tags of a tour",
"description": "Delete all specified tags for the tour with the specified Tour.SCEM-ID",
"operationId": "DeleteTagsOfTourtagsSCEMID_Delete",
"parameters": [
{
"name": "SCEMID",
"in": "path",
"description": "A 10 digit identifier (SCEM-ID) for a tour",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Tags",
"in": "query",
"description": "Delete tags (comma separated) from Tour.Tags[]",
"required": true,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTagsOfTourResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/tour/batch/telematic": {
"put": {
"tags": [
"tour"
],
"summary": "Alter telematic information for the tours",
"description": "Alter telematic information for the tours",
"operationId": "UpdateTelematicDatabatchtelematic_Create",
"parameters": [
{
"name": "SCEMIDS",
"in": "query",
"description": "comma seperated list of tour scemids",
"required": true,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTelematicDataResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TelematicDataWrapper"
}
}
},
"description": "Telematic Data for the tour(s)",
"required": true
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/oem/config": {
"post": {
"tags": [
"oem"
],
"summary": "Creates or updates application config",
"description": "Creates or updates application config",
"operationId": "CreateUpdateOEMConfigconfig_Post",
"parameters": [
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUpdateOEMConfigResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OEMConfigDataWrapper"
}
}
},
"description": "Config data as JSON",
"required": true
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/oem/oemscript": {
"post": {
"tags": [
"oem"
],
"summary": "Triggers a POST OEMScript execution",
"description": "Must be an existing Script",
"operationId": "CreateOEMScriptExecutoroemscript_Post",
"parameters": [
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOEMScriptExecutorResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OEMScriptWrapper"
}
}
},
"description": "Script specific data",
"required": true
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/oem/telematic": {
"get": {
"tags": [
"oem"
],
"summary": "Query something",
"description": "irgendein Text",
"operationId": "ReadProviderInfotelematic_Get",
"parameters": [
{
"name": "Provider",
"in": "query",
"description": "The telematic provider",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "IsStopSCEMID",
"in": "query",
"description": "SCEMID type",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "SCEMID",
"in": "query",
"description": "The SCEMID",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadProviderInfoResponse"
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"oem"
],
"summary": "Create a new telematic provider",
"description": "irgendein Text",
"operationId": "CreateTelematicProvidertelematic_Post",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTelematicProviderResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderSettingsWrapper"
}
}
},
"description": "Config data as JSON",
"required": true
}
},
"delete": {
"tags": [
"oem"
],
"summary": "Delete an existing Telematic provider",
"description": "irgendein Text",
"operationId": "DeleteTelematicProvidertelematic_Delete",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTelematicProviderResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderSettingsWrapper"
}
}
},
"description": "The provider which should be deleted",
"required": true
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/oem/config/{ConfigToken}": {
"get": {
"tags": [
"oem"
],
"summary": "Read stored app config",
"description": "Read stored app config",
"operationId": "ReadOEMConfigconfigConfigToken_Get",
"parameters": [
{
"name": "ConfigName",
"in": "query",
"description": "ConfigName for config",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ConfigToken",
"in": "path",
"description": "Security Token to real all configs",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadOEMConfigResponse"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"oem"
],
"summary": "Delete one or all existing applications config",
"description": "Delete config",
"operationId": "DeleteOEMConfigconfigConfigToken_Delete",
"parameters": [
{
"name": "ConfigName",
"in": "query",
"description": "ConfigName for config",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ConfigToken",
"in": "path",
"description": "Securtiy token, used on creating the app configs",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "DeleteAll",
"in": "query",
"description": "Activate this to delete all configs with this token!",
"required": false,
"x-nullable": false,
"schema": {
"type": "boolean"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteOEMConfigResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/oem/telematic/pollingtrigger": {
"post": {
"tags": [
"oem"
],
"summary": "API entry to force TELEMATIC polling",
"description": "irgendein Text",
"operationId": "CreatePollingTriggertelematicpollingtrigger_Post",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePollingTriggerResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"$ref": "#/components/requestBodies/TelematicTriggerWrapper"
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/oem/telematic/trigger": {
"post": {
"tags": [
"oem"
],
"summary": "DAve Callback fuer Telematik Provider",
"description": "irgendein Text",
"operationId": "CreateTelematicTriggertelematictrigger_Post",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTelematicTriggerResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"$ref": "#/components/requestBodies/TelematicTriggerWrapper"
}
},
"delete": {
"tags": [
"oem"
],
"summary": "Delete specified triggers",
"description": "irgendein Text",
"operationId": "DeleteTelematicTriggertelematictrigger_Delete",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTelematicTriggerResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TelematicTriggerListWrapper"
}
}
},
"description": "Get provider specific telematic data",
"required": true
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/oem/telematic/readtrigger": {
"post": {
"tags": [
"oem"
],
"summary": "Get specified triggers",
"description": "irgendein Text",
"operationId": "ReadTelematicTriggertelematicreadtrigger_Post",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadTelematicTriggerResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TelematicTriggerWrapper"
}
}
},
"description": "Get provider specific telematic data",
"required": true
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/location": {
"get": {
"tags": [
"location"
],
"summary": "Search existing Locations matching the specified Token.",
"description": "",
"operationId": "FindLocations_Get",
"parameters": [
{
"name": "SortOrder",
"in": "query",
"description": "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",
"required": true,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "ItemsPerPage",
"in": "query",
"description": "Max results per page (Max. 50)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartIndex",
"in": "query",
"description": "Skip the first n result. Index starts with 0.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FindLocationsResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KeyValuePair_String_String_"
}
}
}
},
"description": "List of KeyValuePair, e.g. {key:location.address.postCode,value:76131}, {key:location.address.city,value:Karlsruhe}"
}
},
"put": {
"tags": [
"location"
],
"summary": "Update an existing Location. LocationOwner",
"description": "",
"operationId": "UpdateLocation_Create",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLocationResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"$ref": "#/components/requestBodies/LocationWrapper"
}
},
"post": {
"tags": [
"location"
],
"summary": "Create a new unique Location",
"description": "",
"operationId": "CreateLocation_Post",
"parameters": [
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateLocationResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"$ref": "#/components/requestBodies/LocationWrapper"
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/location/tour": {
"post": {
"tags": [
"location"
],
"summary": "Create a tour",
"description": "",
"operationId": "CreateOneStopTourtour_Post",
"parameters": [
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOneStopTourResponse"
}
}
}
}
},
"deprecated": false,
"requestBody": {
"$ref": "#/components/requestBodies/TourContentWrapper"
}
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/location/{ID}": {
"get": {
"tags": [
"location"
],
"summary": "Read a specified location",
"description": "",
"operationId": "ReadLocationID_Get",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The unique identifier of the requested location",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadLocationResponse"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"location"
],
"summary": "Delete an existing Location, only LocationOwner allowed",
"description": "",
"operationId": "DeleteLocationID_Delete",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The unique identifier of the requested location",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteLocationResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/location/proximity": {
"get": {
"tags": [
"location"
],
"summary": "Proximity search for existing Locations.",
"description": "",
"operationId": "ProximitySearchproximity_Get",
"parameters": [
{
"name": "X",
"in": "query",
"description": "Longitude / X (WGS 84)",
"required": true,
"x-nullable": false,
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "Y",
"in": "query",
"description": "Latitude / Y (WGS 84)",
"required": true,
"x-nullable": false,
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "Range",
"in": "query",
"description": "Result in range (Unit meter)",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "FindCriteria",
"in": "query",
"description": "Query the data using this find criteria(s). If NULL/empty implemented as FindAll",
"required": false,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "SortOrder",
"in": "query",
"description": "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",
"required": true,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "ItemsPerPage",
"in": "query",
"description": "Max results per page (Max. 50)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartIndex",
"in": "query",
"description": "Skip the first n result. Index starts with 0.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProximitySearchResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/location/arrivals/{ID}": {
"get": {
"tags": [
"location"
],
"summary": "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.",
"description": "",
"operationId": "ReadLocArrivalsarrivalsID_Get",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The unique identifier of the requested location",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "From",
"in": "query",
"description": "ETA in range from",
"required": true,
"x-nullable": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Until",
"in": "query",
"description": "ETA in range until",
"required": true,
"x-nullable": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "SortOrder",
"in": "query",
"description": "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",
"required": true,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "ItemsPerPage",
"in": "query",
"description": "Max results per page (Max. 50)",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartIndex",
"in": "query",
"description": "Skip the first n result. Index starts with 0.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadLocArrivalsResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
},
"/analytics/data/tourlist": {
"get": {
"tags": [
"analytics"
],
"summary": "",
"description": "If not set configurations are used from the DAveCache",
"operationId": "ReadTourDatadatatourlist_Get",
"parameters": [
{
"name": "From",
"in": "query",
"description": "Timewindow from",
"required": false,
"x-nullable": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Until",
"in": "query",
"description": "Timewindow until",
"required": false,
"x-nullable": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "SCEMIDs",
"in": "query",
"description": "Optional, comma separated list of tour SCEMIDs",
"required": false,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "SortOrderTourCreationTime",
"in": "query",
"description": "Sort by TourCreationTime. Possible values ASC or DESC, if not set or unknown DEFAULT=DESC",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ItemsPerPage",
"in": "query",
"description": "Max results per page (Max. 50)",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartIndex",
"in": "query",
"description": "Skip the first n result. Index starts with 0.",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Token",
"in": "query",
"description": "The security token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Source",
"in": "query",
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "Default response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadTourDataResponse"
}
}
}
}
},
"deprecated": false
},
"parameters": [
{
"$ref": "#/components/parameters/Accept"
}
]
}
},
"tags": [
{
"name": "analytics"
},
{
"name": "event"
},
{
"name": "journal"
},
{
"name": "location"
},
{
"name": "oem"
},
{
"name": "stop"
},
{
"name": "subscription"
},
{
"name": "token"
},
{
"name": "tour"
}
],
"components": {
"schemas": {
"Object": {
"properties": {},
"description": "Object",
"type": "object"
},
"CreateTourV2": {
"title": "CreateTourV2",
"properties": {
"tour": {
"$ref": "#/components/schemas/TourContent"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateTourV2",
"type": "object"
},
"TourContent": {
"title": "TourContent",
"properties": {
"stops": {
"description": "array of stops",
"type": "array",
"items": {
"$ref": "#/components/schemas/StopContent"
}
},
"vehicle": {
"$ref": "#/components/schemas/Vehicle"
},
"drivers": {
"description": "array of drivers",
"type": "array",
"items": {
"$ref": "#/components/schemas/Driver"
}
},
"customData": {
"$ref": "#/components/schemas/Object"
},
"tags": {
"description": "Tags assigned to this tour",
"type": "array",
"items": {
"type": "string"
}
},
"options": {
"$ref": "#/components/schemas/ExecutionOptions"
},
"notify": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionContent"
}
},
"scemid": {
"description": "Encrypted SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
}
},
"description": "TourContent",
"type": "object"
},
"StopContent": {
"title": "StopContent",
"properties": {
"coordinate": {
"$ref": "#/components/schemas/Coordinate"
},
"earliestArrivalTime": {
"description": "time window to be tracked for ETA calculation",
"type": "string",
"format": "date-time"
},
"latestDepartureTime": {
"description": "time window to be tracked for ETA calculation",
"type": "string",
"format": "date-time"
},
"pta": {
"description": "The planned arrival time at the referenced stop",
"type": "string",
"format": "date-time"
},
"serviceTimeAtStop": {
"description": "service time of truck at this stop (seconds)",
"type": "integer",
"format": "int64",
"nullable": false
},
"useServicePeriodForRecreation": {
"description": "truck can use time at stop as rest time",
"type": "boolean",
"nullable": false
},
"weightWhenLeavingStop": {
"description": "Change of truck weight by loading / unloading events (EMQuantityUnit: 'kg')",
"type": "integer",
"format": "int64",
"nullable": false
},
"stopPositionInTour": {
"type": "integer",
"format": "int32",
"nullable": false
},
"customData": {
"$ref": "#/components/schemas/Object"
},
"locationId": {
"description": "LocationId",
"type": "string"
},
"useLocationAddress": {
"type": "boolean"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"scemid": {
"description": "Encrypted SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
}
},
"description": "StopContent",
"type": "object"
},
"Coordinate": {
"title": "Coordinate",
"properties": {
"locationX": {
"description": "Longitude of coordinate in WGS 84, e.g. 13.4261419 for Berlin",
"type": "number",
"format": "double",
"nullable": false
},
"locationY": {
"description": "Latitude of coordinate in WGS 84, e.g. 52.5075419 for Berlin",
"type": "number",
"format": "double",
"nullable": false
}
},
"description": "Coordinate",
"type": "object"
},
"Address": {
"title": "Address",
"properties": {
"label": {
"type": "string"
},
"country": {
"type": "string"
},
"state": {
"type": "string"
},
"province": {
"type": "string"
},
"postCode": {
"type": "string"
},
"city": {
"type": "string"
},
"city2": {
"type": "string"
},
"street": {
"type": "string"
},
"houseNumber": {
"type": "string"
}
},
"description": "Address",
"type": "object"
},
"Vehicle": {
"title": "Vehicle",
"properties": {
"vehicleProfileID": {
"type": "string"
},
"telematicData": {
"$ref": "#/components/schemas/TelematicData"
}
},
"description": "Vehicle",
"type": "object"
},
"TelematicData": {
"title": "TelematicData",
"properties": {
"provider": {
"type": "string"
},
"vehicleId": {
"type": "string"
},
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
}
},
"description": "TelematicData",
"type": "object"
},
"Driver": {
"title": "Driver",
"properties": {
"driverDescription": {
"type": "string"
},
"raSTime": {
"$ref": "#/components/schemas/RaSTime"
},
"useRaSTime": {
"type": "boolean"
},
"customData": {
"$ref": "#/components/schemas/Object"
}
},
"description": "Driver",
"type": "object"
},
"RaSTime": {
"title": "RaSTime",
"properties": {
"referenceTime": {
"description": "Time to which the RaSt Information refer to.",
"type": "string",
"format": "date-time"
},
"periodDrivenSinceLastBreak": {
"description": "The amount of time the driver has spent operating their vehicle since the last break.",
"type": "integer",
"format": "int32",
"nullable": false
},
"periodDrivenSinceLastRest": {
"description": "The amount of time the driver has spent operating their vehicle since the last rest.",
"type": "integer",
"format": "int32",
"nullable": false
},
"currentIdlePeriod": {
"description": "The amount of time the driver has spent idle right before the reference time.",
"type": "integer",
"format": "int32",
"nullable": false
},
"isSplitBreak": {
"description": "Set whether or not the driver has already completed the first part of their break _and_ has since operated their vehicle or performed active service.",
"type": "boolean"
},
"isSplitRest": {
"description": "Set whether or not the driver has already completed the first part of their rest vehicle or performed active _and_ has since operated their service.",
"type": "boolean"
}
},
"description": "RaSTime",
"type": "object"
},
"ExecutionOptions": {
"title": "ExecutionOptions",
"properties": {
"plannedTourStartTime": {
"description": "Planned tour start time (yyyy-MM-ddThh:mm:ssZ)",
"type": "string",
"format": "date-time"
},
"sessionToken": {
"description": "Session Token for test tour",
"type": "string"
},
"additionalInfo": {
"description": "Additional info",
"type": "string"
},
"doRefRouteCalc": {
"description": "Enable/Disable reference route calculation",
"type": "boolean"
},
"disableDepartedEventOnGeofence": {
"description": "Enable/Disable auto departed status event generation",
"type": "boolean"
}
},
"description": "ExecutionOptions",
"type": "object"
},
"SubscriptionContent": {
"title": "SubscriptionContent",
"properties": {
"notificationType": {
"description": "type of the notification",
"type": "string",
"enum": [
"CALLBACK_URL",
"PTVDEBUG",
"PUSH_NON_MOBILE",
"PUSH_MOBILE",
"PUSH_NON_MOBILE_SSE"
]
},
"topicType": {
"type": "string",
"enum": [
"ETA",
"TOUR_UPDATE",
"TOUR_CREATE",
"POS_ETA_CALC"
]
},
"notificationDescription": {
"$ref": "#/components/schemas/Object"
},
"subscriptionID": {
"type": "string"
},
"scemid": {
"description": "Encrypted SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
}
},
"description": "SubscriptionContent",
"type": "object"
},
"CreateTour": {
"title": "CreateTour",
"properties": {
"tour": {
"$ref": "#/components/schemas/TourContent"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateTour",
"type": "object"
},
"UpdateTours": {
"title": "UpdateTours",
"properties": {
"tours": {
"description": "The tours (json)",
"type": "array",
"items": {
"$ref": "#/components/schemas/TourContent"
}
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "UpdateTours",
"type": "object"
},
"ReadTours": {
"title": "ReadTours",
"properties": {
"scemids": {
"description": "Comma separated list of tour SCEMIDs. Parametertype = query",
"type": "array",
"items": {
"type": "string"
}
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadTours",
"type": "object"
},
"DeleteTours": {
"title": "DeleteTours",
"properties": {
"scemids": {
"description": "Comma separated list of tour SCEMIDs",
"type": "array",
"items": {
"type": "string"
}
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "DeleteTours",
"type": "object"
},
"FindAllTagsOfToken": {
"title": "FindAllTagsOfToken",
"properties": {
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "FindAllTagsOfToken",
"type": "object"
},
"FindTaggedTours": {
"title": "FindTaggedTours",
"properties": {
"tags": {
"description": "The requested tags (space seperated [0-9a-zA-Z])",
"type": "string"
},
"maxItemCount": {
"description": "Maximum return items. Default=DAveCache(MaxReadTourCount)",
"type": "integer",
"format": "int32"
},
"from": {
"description": "EXPERIMENTAL, not used: Timeframe from.",
"type": "string",
"format": "date-time",
"nullable": false
},
"until": {
"description": "EXPERIMENTAL, not used: Timeframe until",
"type": "string",
"format": "date-time",
"nullable": false
},
"addTourData": {
"description": "If true, return all tour information: False return inly the Tour.SCEMID. Default=false",
"type": "boolean"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "FindTaggedTours",
"type": "object"
},
"CreateSubscriptions": {
"title": "CreateSubscriptions",
"properties": {
"subscriptions": {
"description": "The subscriptions (json)",
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionContent"
}
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateSubscriptions",
"type": "object"
},
"ReadSubscriptions": {
"title": "ReadSubscriptions",
"properties": {
"scemid": {
"description": "A 10 digit identifier (SCEM-ID) for a tour or a stop",
"type": "string"
},
"subscriptionIDS": {
"description": "Comma separated list of SubscriptionIDs",
"type": "array",
"items": {
"type": "string"
}
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadSubscriptions",
"type": "object"
},
"GetDeviceIdentifier": {
"title": "GetDeviceIdentifier",
"properties": {
"appId": {
"description": "The OneSignalApp used assigned to this caller",
"type": "string"
},
"uniqueReqPrefix": {
"description": "Key for a unique identifer",
"type": "string"
},
"uniqueIdentifier": {
"description": "Value for a unique identifer",
"type": "string"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "GetDeviceIdentifier",
"type": "object"
},
"GetUniqueIdentifier": {
"title": "GetUniqueIdentifier",
"properties": {
"appId": {
"description": "The OneSignal App used assigned to this caller",
"type": "string"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "GetUniqueIdentifier",
"type": "object"
},
"CreateEvents": {
"title": "CreateEvents",
"properties": {
"events": {
"description": "The events (json)",
"type": "array",
"items": {
"$ref": "#/components/schemas/EventContent"
}
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateEvents",
"type": "object"
},
"EventContent": {
"title": "EventContent",
"properties": {
"eventType": {
"type": "string",
"enum": [
"POSITION",
"OBUTACHO",
"STATUS_STOP"
]
},
"eventSubtype": {
"description": "Currently the following values are available but only if EventType is STATUS_STOP - APPROACHING, ARRIVED, DEPARTED, CANCELLED, SUSPENDED, SERVICE",
"type": "string"
},
"visibility": {
"type": "boolean",
"nullable": false
},
"action": {
"type": "string",
"enum": [
"NONE",
"FORCE_XROUTE_CALC"
]
},
"eventPayLoad": {
"$ref": "#/components/schemas/Object"
},
"scemid": {
"description": "Encrypted SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
}
},
"description": "EventContent",
"type": "object"
},
"ReadJournalBatch": {
"title": "ReadJournalBatch",
"properties": {
"scemiDs": {
"description": "Comma seperated list of SCEMIDs for tours or stops.",
"type": "string"
},
"from": {
"description": "Get journals from duration (timestamp)",
"type": "string",
"format": "date-time"
},
"until": {
"description": "Get journals till duration (timestamp)",
"type": "string",
"format": "date-time"
},
"entryTypes": {
"description": "Comma seperated availabe journal types",
"type": "string"
},
"eventTypes": {
"description": "Comma seperated filter with event types. Supported: POSITION, OBUTACHO, STATUS_STOP",
"type": "string"
},
"sortOrder": {
"description": "Sort journals (entryCreateTime|ASC, scemid|DESC)",
"type": "string"
},
"startIndex": {
"description": "Skip the first n result. Page index starts with 0 - offset (default 0))",
"type": "integer",
"format": "int32",
"nullable": false
},
"itemsPerPage": {
"description": "Max results per page - limit(default is 0 for all)",
"type": "integer",
"format": "int32",
"nullable": false
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadJournalBatch",
"type": "object"
},
"ReadStopsETA": {
"title": "ReadStopsETA",
"properties": {
"scemiDs": {
"description": "Comma separated list of stop SCEMIDs",
"type": "array",
"items": {
"type": "string"
}
},
"token": {
"description": "Token used to get extended information, premium members only",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadStopsETA",
"type": "object"
},
"ReadStopETA": {
"title": "ReadStopETA",
"properties": {
"scemid": {
"description": "A 10 digit identifier (SCEM-ID) for a stop",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadStopETA",
"type": "object"
},
"ReadStopSearch": {
"title": "ReadStopSearch",
"properties": {
"locationID": {
"description": "",
"type": "string"
},
"searchFieldContent": {
"$ref": "#/components/schemas/SearchFieldContent"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadStopSearch",
"type": "object"
},
"SearchFieldContent": {
"title": "SearchFieldContent",
"properties": {
"searchFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchField"
}
}
},
"description": "SearchFieldContent",
"type": "object"
},
"SearchField": {
"title": "SearchField",
"properties": {
"fieldName": {
"type": "string"
},
"fieldValue": {
"type": "string"
},
"fieldLabel": {
"type": "string"
}
},
"description": "SearchField",
"type": "object"
},
"DeleteStops": {
"title": "DeleteStops",
"properties": {
"scemids": {
"description": "Comma separated list of stop SCEMIDs",
"type": "array",
"items": {
"type": "string"
}
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "DeleteStops",
"type": "object"
},
"ReadStops": {
"title": "ReadStops",
"properties": {
"scemids": {
"description": "Comma separated list of stop SCEMIDs",
"type": "array",
"items": {
"type": "string"
}
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadStops",
"type": "object"
},
"UpdateStops": {
"title": "UpdateStops",
"properties": {
"stops": {
"description": "The stops (json)",
"type": "array",
"items": {
"$ref": "#/components/schemas/StopContent"
}
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "UpdateStops",
"type": "object"
},
"CreateSubscription": {
"title": "CreateSubscription",
"properties": {
"subscription": {
"$ref": "#/components/schemas/SubscriptionContent"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateSubscription",
"type": "object"
},
"DeleteSubscription": {
"title": "DeleteSubscription",
"properties": {
"subscription": {
"$ref": "#/components/schemas/SubscriptionContent"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "DeleteSubscription",
"type": "object"
},
"CreateEvent": {
"title": "CreateEvent",
"properties": {
"event": {
"$ref": "#/components/schemas/EventContent"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateEvent",
"type": "object"
},
"ReadStop": {
"title": "ReadStop",
"properties": {
"scemid": {
"description": "A 10 digit identifier (SCEM-ID) for a stop",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadStop",
"type": "object"
},
"ReadJournal": {
"title": "ReadJournal",
"properties": {
"scemid": {
"description": "A 10 digit identifier (SCEM-ID) for a tour",
"type": "string"
},
"startIndex": {
"description": "Skip the first n result. Page index starts with 0 - offset (default 0))",
"type": "integer",
"format": "int32",
"nullable": false
},
"itemsPerPage": {
"description": "Max results per page - limit(default is 0 for all)",
"type": "integer",
"format": "int32",
"nullable": false
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadJournal",
"type": "object"
},
"ReadTourSCEMIDS": {
"title": "ReadTourSCEMIDS",
"properties": {
"from": {
"description": "Tour.SCEM-ID >= From time",
"type": "string",
"format": "date-time",
"nullable": false
},
"until": {
"description": "Tour.SCEM-ID before Until time",
"type": "string",
"format": "date-time",
"nullable": false
},
"startIndex": {
"description": "Skip items",
"type": "integer",
"format": "int32",
"nullable": false
},
"maxItems": {
"description": "The maximum items in the response.",
"type": "integer",
"format": "int32",
"nullable": false
},
"descending": {
"description": "Sorting CreationTime, TRUE-> descending, default=FALSE.",
"type": "boolean",
"nullable": false
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadTourSCEMIDS",
"type": "object"
},
"UpdateVehicleProfile": {
"title": "UpdateVehicleProfile",
"properties": {
"locationID": {
"description": "Stop's locationId",
"type": "string"
},
"vehicleProfileID": {
"description": "Vehicle Profile to update",
"type": "string"
},
"searchFieldContent": {
"$ref": "#/components/schemas/SearchFieldContent"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "UpdateVehicleProfile",
"type": "object"
},
"DeleteTagsOfTour": {
"title": "DeleteTagsOfTour",
"properties": {
"scemid": {
"description": "A 10 digit identifier (SCEM-ID) for a tour",
"type": "string"
},
"tags": {
"description": "Delete tags (comma separated) from Tour.Tags[]",
"type": "array",
"items": {
"type": "string"
}
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "DeleteTagsOfTour",
"type": "object"
},
"UpdateTelematicData": {
"title": "UpdateTelematicData",
"properties": {
"scemids": {
"description": "comma seperated list of tour scemids",
"type": "array",
"items": {
"type": "string"
}
},
"telematicData": {
"$ref": "#/components/schemas/TelematicData"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "UpdateTelematicData",
"type": "object"
},
"CreateTagsForTour": {
"title": "CreateTagsForTour",
"properties": {
"scemid": {
"description": "A 10 digit identifier (SCEM-ID) for a tour",
"type": "string"
},
"tags": {
"description": "Add tags (space separated [0-9a-zA-Z]) to Tour.Tags",
"type": "string"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateTagsForTour",
"type": "object"
},
"ReadTagsOfTour": {
"title": "ReadTagsOfTour",
"properties": {
"scemid": {
"description": "A 10 digit identifier (SCEM-ID) for a tour",
"type": "string"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadTagsOfTour",
"type": "object"
},
"CreateUpdateOEMConfig": {
"title": "CreateUpdateOEMConfig",
"properties": {
"config": {
"$ref": "#/components/schemas/OEMConfigData"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateUpdateOEMConfig",
"type": "object"
},
"OEMConfigData": {
"title": "OEMConfigData",
"properties": {
"configName": {
"type": "string"
},
"revision": {
"type": "integer",
"format": "int32",
"nullable": false
},
"settings": {
"$ref": "#/components/schemas/Object"
},
"configToken": {
"type": "string"
}
},
"description": "OEMConfigData",
"type": "object"
},
"CreateOEMScriptExecutor": {
"title": "CreateOEMScriptExecutor",
"properties": {
"oemScript": {
"$ref": "#/components/schemas/OEMScript"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateOEMScriptExecutor",
"type": "object"
},
"OEMScript": {
"title": "OEMScript",
"properties": {
"script": {
"type": "string"
},
"version": {
"type": "integer",
"format": "int32",
"nullable": false
},
"token": {
"type": "string"
},
"oemData": {
"$ref": "#/components/schemas/Object"
}
},
"description": "OEMScript",
"type": "object"
},
"CreateTelematicProvider": {
"title": "CreateTelematicProvider",
"properties": {
"config": {
"$ref": "#/components/schemas/ProviderSettings"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateTelematicProvider",
"type": "object"
},
"ProviderSettings": {
"title": "ProviderSettings",
"properties": {
"name": {
"type": "string"
},
"callback4Telematic": {
"$ref": "#/components/schemas/TelematikCallBack"
}
},
"description": "ProviderSettings",
"type": "object"
},
"TelematikCallBack": {
"title": "TelematikCallBack",
"properties": {
"url": {
"type": "string"
},
"password": {
"type": "string"
},
"user": {
"type": "string"
}
},
"description": "TelematikCallBack",
"type": "object"
},
"DeleteTelematicProvider": {
"title": "DeleteTelematicProvider",
"properties": {
"providerSettings": {
"$ref": "#/components/schemas/ProviderSettings"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "DeleteTelematicProvider",
"type": "object"
},
"ReadProviderInfo": {
"title": "ReadProviderInfo",
"properties": {
"provider": {
"description": "The telematic provider",
"type": "string"
},
"isStopSCEMID": {
"description": "SCEMID type",
"type": "string"
},
"scemid": {
"description": "The SCEMID",
"type": "string"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadProviderInfo",
"type": "object"
},
"DeleteOEMConfig": {
"title": "DeleteOEMConfig",
"properties": {
"configName": {
"description": "ConfigName for config",
"type": "string"
},
"configToken": {
"description": "Securtiy token, used on creating the app configs",
"type": "string"
},
"deleteAll": {
"description": "Activate this to delete all configs with this token!",
"type": "boolean",
"nullable": false
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "DeleteOEMConfig",
"type": "object"
},
"ReadOEMConfig": {
"title": "ReadOEMConfig",
"properties": {
"configName": {
"description": "ConfigName for config",
"type": "string"
},
"configToken": {
"description": "Security Token to real all configs",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadOEMConfig",
"type": "object"
},
"CreatePollingTrigger": {
"title": "CreatePollingTrigger",
"properties": {
"trigger": {
"$ref": "#/components/schemas/TelematicTrigger"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreatePollingTrigger",
"type": "object"
},
"TelematicTrigger": {
"title": "TelematicTrigger",
"properties": {
"telematicProvider": {
"type": "string"
},
"agheeraTrigger": {
"$ref": "#/components/schemas/AgheeraTrigger"
}
},
"description": "TelematicTrigger",
"type": "object"
},
"AgheeraTrigger": {
"title": "AgheeraTrigger",
"properties": {
"fleetName": {
"type": "string"
},
"vehicleId": {
"type": "string"
},
"start": {
"type": "string",
"format": "date-time",
"nullable": false
},
"end": {
"type": "string",
"format": "date-time",
"nullable": false
},
"callBack4Telematic": {
"$ref": "#/components/schemas/TelematikCallBack"
},
"scemid": {
"type": "string"
},
"licencePlate": {
"type": "string"
},
"pollingInterval": {
"type": "integer",
"format": "int32",
"nullable": false
},
"tripId": {
"type": "string"
}
},
"description": "AgheeraTrigger",
"type": "object"
},
"CreateTelematicTrigger": {
"title": "CreateTelematicTrigger",
"properties": {
"trigger": {
"$ref": "#/components/schemas/TelematicTrigger"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateTelematicTrigger",
"type": "object"
},
"DeleteTelematicTrigger": {
"title": "DeleteTelematicTrigger",
"properties": {
"triggers": {
"description": "Get provider specific telematic data",
"type": "array",
"items": {
"$ref": "#/components/schemas/TelematicTrigger"
}
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "DeleteTelematicTrigger",
"type": "object"
},
"ReadTelematicTrigger": {
"title": "ReadTelematicTrigger",
"properties": {
"trigger": {
"$ref": "#/components/schemas/TelematicTrigger"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadTelematicTrigger",
"type": "object"
},
"CreateLocation": {
"title": "CreateLocation",
"properties": {
"location": {
"$ref": "#/components/schemas/Location"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateLocation",
"type": "object"
},
"Location": {
"title": "Location",
"properties": {
"locationId": {
"type": "string"
},
"revision": {
"type": "integer",
"format": "int32"
},
"arrivedRange": {
"type": "integer",
"format": "int32"
},
"searchable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"coordinate": {
"$ref": "#/components/schemas/Coordinate"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"customDataFieldsForStop": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomDataFieldsForStop"
}
},
"customData": {
"$ref": "#/components/schemas/Object"
}
},
"description": "Location",
"type": "object"
},
"CustomDataFieldsForStop": {
"title": "CustomDataFieldsForStop",
"properties": {
"name": {
"type": "string"
},
"format": {
"type": "string"
}
},
"description": "CustomDataFieldsForStop",
"type": "object"
},
"FindLocations": {
"title": "FindLocations",
"properties": {
"extKeyValueSearch": {
"description": "List of KeyValuePair, e.g. {key:location.address.postCode,value:76131}, {key:location.address.city,value:Karlsruhe}",
"type": "array",
"items": {
"$ref": "#/components/schemas/KeyValuePair_String_String_"
}
},
"sortOrder": {
"description": "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",
"type": "array",
"items": {
"type": "string"
}
},
"itemsPerPage": {
"description": "Max results per page (Max. 50)",
"type": "integer",
"format": "int32"
},
"startIndex": {
"description": "Skip the first n result. Index starts with 0.",
"type": "integer",
"format": "int32"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "FindLocations",
"type": "object"
},
"UpdateLocation": {
"title": "UpdateLocation",
"properties": {
"location": {
"$ref": "#/components/schemas/Location"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "UpdateLocation",
"type": "object"
},
"CreateOneStopTour": {
"title": "CreateOneStopTour",
"properties": {
"tour": {
"$ref": "#/components/schemas/TourContent"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "CreateOneStopTour",
"type": "object"
},
"DeleteLocation": {
"title": "DeleteLocation",
"properties": {
"id": {
"description": "The unique identifier of the requested location",
"type": "string"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "DeleteLocation",
"type": "object"
},
"ProximitySearch": {
"title": "ProximitySearch",
"properties": {
"x": {
"description": "Longitude / X (WGS 84)",
"type": "number",
"format": "double",
"nullable": false
},
"y": {
"description": "Latitude / Y (WGS 84)",
"type": "number",
"format": "double",
"nullable": false
},
"range": {
"description": "Result in range (Unit meter)",
"type": "integer",
"format": "int32"
},
"findCriteria": {
"description": "Query the data using this find criteria(s). If NULL/empty implemented as FindAll",
"type": "array",
"items": {
"type": "string"
}
},
"sortOrder": {
"description": "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",
"type": "array",
"items": {
"type": "string"
}
},
"itemsPerPage": {
"description": "Max results per page (Max. 50)",
"type": "integer",
"format": "int32"
},
"startIndex": {
"description": "Skip the first n result. Index starts with 0.",
"type": "integer",
"format": "int32"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ProximitySearch",
"type": "object"
},
"ReadLocation": {
"title": "ReadLocation",
"properties": {
"id": {
"description": "The unique identifier of the requested location",
"type": "string"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadLocation",
"type": "object"
},
"ReadLocArrivals": {
"title": "ReadLocArrivals",
"properties": {
"id": {
"description": "The unique identifier of the requested location",
"type": "string"
},
"from": {
"description": "ETA in range from",
"type": "string",
"format": "date-time",
"nullable": false
},
"until": {
"description": "ETA in range until",
"type": "string",
"format": "date-time",
"nullable": false
},
"sortOrder": {
"description": "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",
"type": "array",
"items": {
"type": "string"
}
},
"itemsPerPage": {
"description": "Max results per page (Max. 50)",
"type": "integer",
"format": "int32"
},
"startIndex": {
"description": "Skip the first n result. Index starts with 0.",
"type": "integer",
"format": "int32"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadLocArrivals",
"type": "object"
},
"GenericTypes": {
"title": "GenericTypes",
"properties": {
"eventPayLoadPosition": {
"$ref": "#/components/schemas/EventPayLoadPosition"
},
"eventPayLoadObuTacho": {
"$ref": "#/components/schemas/EventPayLoadObuTacho"
},
"eventPayLoadObuFleet": {
"$ref": "#/components/schemas/EventPayLoadObuFleet"
},
"eventPayLoadStatus": {
"$ref": "#/components/schemas/EventPayLoadStatus"
},
"subscriptionPushNonMobilePayLoad": {
"$ref": "#/components/schemas/SubscriptionPushNonMobilePayLoad"
},
"subscriptionCallbackUrlPayLoad": {
"$ref": "#/components/schemas/SubscriptionCallbackUrlPayLoad"
},
"subscriptionPushMobilePayLoad": {
"$ref": "#/components/schemas/SubscriptionPushMobilePayLoad"
},
"subscriptionPushNonMobileSSEPayLoad": {
"$ref": "#/components/schemas/SubscriptionPushNonMobileSSEPayLoad"
},
"notificationMessage": {
"$ref": "#/components/schemas/NotificationMessage"
},
"notificationMessageSSE": {
"$ref": "#/components/schemas/NotificationMessageSSE"
},
"notificationMessagePayLoadETAInfo": {
"$ref": "#/components/schemas/NotificationMessagePayLoadETAInfo"
},
"notificationMessagePayLoadStatusStopApproaching": {
"$ref": "#/components/schemas/NotificationMessagePayLoadStatusStopApproaching"
},
"notificationMessagePayLoadStatusStopCancelled": {
"$ref": "#/components/schemas/NotificationMessagePayLoadStatusStopCancelled"
},
"notificationMessagePayLoadStatusStopDeparted": {
"$ref": "#/components/schemas/NotificationMessagePayLoadStatusStopDeparted"
},
"notificationMessagePayLoadStatusStopArrived": {
"$ref": "#/components/schemas/NotificationMessagePayLoadStatusStopArrived"
},
"notificationMessagePayLoadTourUpdate": {
"$ref": "#/components/schemas/NotificationMessagePayLoadTourUpdate"
},
"notificationMessagePayLoadTourCreate": {
"$ref": "#/components/schemas/NotificationMessagePayLoadTourCreate"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "GenericTypes",
"type": "object"
},
"EventPayLoadPosition": {
"title": "EventPayLoadPosition",
"properties": {
"coordinate": {
"$ref": "#/components/schemas/Coordinate"
},
"timeStamp": {
"description": "Timestamp of event generation on side of the event sender in UTF-Format",
"type": "string",
"format": "date-time",
"nullable": false
},
"heading": {
"description": "degree (0=North 90=East 0-359)",
"type": "number",
"format": "double"
},
"accuracy": {
"description": "accuracy in meter",
"type": "number",
"format": "double"
},
"speed": {
"description": "meter/seconds, 0.0 = no speed",
"type": "number",
"format": "double"
}
},
"description": "EventPayLoadPosition",
"type": "object"
},
"EventPayLoadObuTacho": {
"title": "EventPayLoadObuTacho",
"properties": {
"raSTime": {
"$ref": "#/components/schemas/RaSTime"
},
"driverReference": {
"type": "string"
},
"coordinate": {
"$ref": "#/components/schemas/Coordinate"
},
"timeStamp": {
"description": "Timestamp of event generation on side of the event sender in UTF-Format",
"type": "string",
"format": "date-time",
"nullable": false
},
"heading": {
"description": "degree (0=North 90=East 0-359)",
"type": "number",
"format": "double"
},
"accuracy": {
"description": "accuracy in meter",
"type": "number",
"format": "double"
},
"speed": {
"description": "meter/seconds, 0.0 = no speed",
"type": "number",
"format": "double"
}
},
"description": "EventPayLoadObuTacho",
"type": "object"
},
"EventPayLoadObuFleet": {
"title": "EventPayLoadObuFleet",
"properties": {
"loadQuantity": {
"type": "integer",
"format": "int32",
"nullable": false
},
"loadUnit": {
"type": "string",
"enum": [
"kg"
]
},
"coordinate": {
"$ref": "#/components/schemas/Coordinate"
},
"timeStamp": {
"description": "Timestamp of event generation on side of the event sender in UTF-Format",
"type": "string",
"format": "date-time",
"nullable": false
},
"heading": {
"description": "degree (0=North 90=East 0-359)",
"type": "number",
"format": "double"
},
"accuracy": {
"description": "accuracy in meter",
"type": "number",
"format": "double"
},
"speed": {
"description": "meter/seconds, 0.0 = no speed",
"type": "number",
"format": "double"
}
},
"description": "EventPayLoadObuFleet",
"type": "object"
},
"EventPayLoadStatus": {
"title": "EventPayLoadStatus",
"properties": {
"addInfo": {
"description": "Comment of sender: I'm 10 minutes late because of some reason at stop X",
"type": "string"
},
"distanceToStop": {
"type": "integer",
"format": "int32",
"nullable": false
},
"processState": {
"type": "string",
"enum": [
"NEW",
"IN_PROCESS",
"PROCESSED",
"WARNING",
"ERROR"
]
},
"coordinate": {
"$ref": "#/components/schemas/Coordinate"
},
"timeStamp": {
"description": "Timestamp of event generation on side of the event sender in UTF-Format",
"type": "string",
"format": "date-time",
"nullable": false
},
"heading": {
"description": "degree (0=North 90=East 0-359)",
"type": "number",
"format": "double"
},
"accuracy": {
"description": "accuracy in meter",
"type": "number",
"format": "double"
},
"speed": {
"description": "meter/seconds, 0.0 = no speed",
"type": "number",
"format": "double"
}
},
"description": "EventPayLoadStatus",
"type": "object"
},
"SubscriptionPushNonMobilePayLoad": {
"title": "SubscriptionPushNonMobilePayLoad",
"properties": {
"ident": {
"type": "string"
},
"triggerBeforeSeconds": {
"type": "integer",
"format": "int32"
},
"triggerPosTrackInSeconds": {
"type": "integer",
"format": "int32"
}
},
"description": "SubscriptionPushNonMobilePayLoad",
"type": "object"
},
"SubscriptionCallbackUrlPayLoad": {
"title": "SubscriptionCallbackUrlPayLoad",
"properties": {
"callBackURL": {
"type": "string"
},
"httpBasicLogin": {
"type": "string"
},
"httpBasicPassword": {
"type": "string"
},
"httpTimeoutInSeconds": {
"type": "integer",
"format": "int32",
"nullable": false
},
"triggerBeforeSeconds": {
"type": "integer",
"format": "int32"
},
"triggerPosTrackInSeconds": {
"type": "integer",
"format": "int32"
}
},
"description": "SubscriptionCallbackUrlPayLoad",
"type": "object"
},
"SubscriptionPushMobilePayLoad": {
"title": "SubscriptionPushMobilePayLoad",
"properties": {
"appID": {
"type": "string"
},
"ident": {
"type": "string"
}
},
"description": "SubscriptionPushMobilePayLoad",
"type": "object"
},
"SubscriptionPushNonMobileSSEPayLoad": {
"title": "SubscriptionPushNonMobileSSEPayLoad",
"properties": {
"ident": {
"type": "string"
},
"triggerBeforeSeconds": {
"type": "integer",
"format": "int32"
},
"triggerPosTrackInSeconds": {
"type": "integer",
"format": "int32"
}
},
"description": "SubscriptionPushNonMobileSSEPayLoad",
"type": "object"
},
"NotificationMessage": {
"title": "NotificationMessage",
"properties": {
"notificationContentType": {
"type": "string",
"enum": [
"ETA_INFO",
"STOP_APPROACHING",
"STOP_ARRIVED",
"STOP_DEPARTED",
"STOP_CANCELLED",
"TOUR_UPDATE",
"STOP_UPDATE",
"SUBSCRIPTION_CONFIRMATION",
"STOP_SUSPENDED",
"POS_TRACK",
"POS_ETA_CALC",
"TOUR_CREATE",
"ETA_FAILED_INFO",
"NOTIFICATION"
]
},
"topicType": {
"type": "string",
"enum": [
"ETA",
"TOUR_UPDATE",
"TOUR_CREATE",
"POS_ETA_CALC"
]
},
"version": {
"type": "string"
},
"notificationPayLoad": {
"description": "Currently the following generic notification payload types will be available - NotificationMessagePayLoadETAInfo, NotificationMessagePayLoadStatusStopDeparted, NotificationMessagePayLoadStatusStopArrived, NotificationMessagePayLoadTourUpdate, NotificationMessagePayLoadTourCreate",
"type": "array",
"items": {
"$ref": "#/components/schemas/Object"
}
},
"subscriptionID": {
"type": "string"
}
},
"description": "NotificationMessage",
"type": "object"
},
"NotificationMessageSSE": {
"title": "NotificationMessageSSE",
"properties": {
"notificationContentType": {
"type": "string",
"enum": [
"ETA_INFO",
"STOP_APPROACHING",
"STOP_ARRIVED",
"STOP_DEPARTED",
"STOP_CANCELLED",
"TOUR_UPDATE",
"STOP_UPDATE",
"SUBSCRIPTION_CONFIRMATION",
"STOP_SUSPENDED",
"POS_TRACK",
"POS_ETA_CALC",
"TOUR_CREATE",
"ETA_FAILED_INFO",
"NOTIFICATION"
]
},
"topicType": {
"type": "string",
"enum": [
"ETA",
"TOUR_UPDATE",
"TOUR_CREATE",
"POS_ETA_CALC"
]
},
"version": {
"type": "string"
},
"scemid": {
"type": "string"
},
"ident": {
"type": "string"
},
"notificationPayLoad": {
"description": "Currently the following generic notification payload types will be available - NotificationMessagePayLoadETAInfo, NotificationMessagePayLoadStatusStopDeparted, NotificationMessagePayLoadStatusStopArrived, NotificationMessagePayLoadTourUpdate, NotificationMessagePayLoadTourCreate",
"type": "array",
"items": {
"type": "string"
}
},
"subscriptionID": {
"type": "string"
}
},
"description": "NotificationMessageSSE",
"type": "object"
},
"NotificationMessagePayLoadETAInfo": {
"title": "NotificationMessagePayLoadETAInfo",
"properties": {
"scheduledTime": {
"type": "string",
"format": "date-time"
},
"estimatedTime": {
"type": "string",
"format": "date-time"
},
"info": {
"type": "string"
},
"trafficTimeLoss": {
"type": "integer",
"format": "int32"
},
"breakAndRestPeriod": {
"type": "integer",
"format": "int32"
},
"waitingPeriod": {
"type": "integer",
"format": "int32"
},
"originator": {
"$ref": "#/components/schemas/Object"
},
"uniqSeqId": {
"type": "string"
},
"relatedTime": {
"type": "string",
"format": "date-time"
},
"customData": {
"$ref": "#/components/schemas/Object"
},
"scemid": {
"description": "SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
},
"emCreateTime": {
"type": "string",
"format": "date-time",
"nullable": false
}
},
"description": "NotificationMessagePayLoadETAInfo",
"type": "object"
},
"NotificationMessagePayLoadStatusStopApproaching": {
"title": "NotificationMessagePayLoadStatusStopApproaching",
"properties": {
"timeOfApproach": {
"type": "string",
"format": "date-time"
},
"addInfo": {
"type": "string"
},
"customData": {
"$ref": "#/components/schemas/Object"
},
"coordinate": {
"$ref": "#/components/schemas/Coordinate"
},
"distanceToStop": {
"type": "integer",
"format": "int32",
"nullable": false
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"scemid": {
"description": "SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
},
"emCreateTime": {
"type": "string",
"format": "date-time",
"nullable": false
}
},
"description": "NotificationMessagePayLoadStatusStopApproaching",
"type": "object"
},
"NotificationMessagePayLoadStatusStopCancelled": {
"title": "NotificationMessagePayLoadStatusStopCancelled",
"properties": {
"timeOfCancel": {
"type": "string",
"format": "date-time"
},
"addInfo": {
"type": "string"
},
"customData": {
"$ref": "#/components/schemas/Object"
},
"coordinate": {
"$ref": "#/components/schemas/Coordinate"
},
"distanceToStop": {
"type": "integer",
"format": "int32",
"nullable": false
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"scemid": {
"description": "SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
},
"emCreateTime": {
"type": "string",
"format": "date-time",
"nullable": false
}
},
"description": "NotificationMessagePayLoadStatusStopCancelled",
"type": "object"
},
"NotificationMessagePayLoadStatusStopDeparted": {
"title": "NotificationMessagePayLoadStatusStopDeparted",
"properties": {
"timeOfDeparture": {
"type": "string",
"format": "date-time"
},
"addInfo": {
"type": "string"
},
"customData": {
"$ref": "#/components/schemas/Object"
},
"coordinate": {
"$ref": "#/components/schemas/Coordinate"
},
"distanceToStop": {
"type": "integer",
"format": "int32",
"nullable": false
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"scemid": {
"description": "SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
},
"emCreateTime": {
"type": "string",
"format": "date-time",
"nullable": false
}
},
"description": "NotificationMessagePayLoadStatusStopDeparted",
"type": "object"
},
"NotificationMessagePayLoadStatusStopArrived": {
"title": "NotificationMessagePayLoadStatusStopArrived",
"properties": {
"timeOfArrival": {
"type": "string",
"format": "date-time"
},
"addInfo": {
"type": "string"
},
"customData": {
"$ref": "#/components/schemas/Object"
},
"coordinate": {
"$ref": "#/components/schemas/Coordinate"
},
"distanceToStop": {
"type": "integer",
"format": "int32",
"nullable": false
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"scemid": {
"description": "SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
},
"emCreateTime": {
"type": "string",
"format": "date-time",
"nullable": false
}
},
"description": "NotificationMessagePayLoadStatusStopArrived",
"type": "object"
},
"NotificationMessagePayLoadTourUpdate": {
"title": "NotificationMessagePayLoadTourUpdate",
"properties": {
"info": {
"type": "string"
},
"scemid": {
"description": "SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
},
"emCreateTime": {
"type": "string",
"format": "date-time",
"nullable": false
}
},
"description": "NotificationMessagePayLoadTourUpdate",
"type": "object"
},
"NotificationMessagePayLoadTourCreate": {
"title": "NotificationMessagePayLoadTourCreate",
"properties": {
"info": {
"type": "string"
},
"scemid": {
"description": "SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
},
"emCreateTime": {
"type": "string",
"format": "date-time",
"nullable": false
}
},
"description": "NotificationMessagePayLoadTourCreate",
"type": "object"
},
"ReadTourData": {
"title": "ReadTourData",
"properties": {
"from": {
"description": "Timewindow from",
"type": "string",
"format": "date-time",
"nullable": false
},
"until": {
"description": "Timewindow until",
"type": "string",
"format": "date-time",
"nullable": false
},
"scemiDs": {
"description": "Optional, comma separated list of tour SCEMIDs",
"type": "array",
"items": {
"type": "string"
}
},
"sortOrderTourCreationTime": {
"description": "Sort by TourCreationTime. Possible values ASC or DESC, if not set or unknown DEFAULT=DESC",
"type": "string"
},
"itemsPerPage": {
"description": "Max results per page (Max. 50)",
"type": "integer",
"format": "int32"
},
"startIndex": {
"description": "Skip the first n result. Index starts with 0.",
"type": "integer",
"format": "int32"
},
"token": {
"description": "The security token",
"type": "string"
},
"source": {
"description": "Name of the event provider: Examples are ptvemapp, ptvemportal, jmeter, any customer specific app",
"type": "string"
}
},
"description": "ReadTourData",
"type": "object"
},
"CreateTourV2Response": {
"title": "CreateTourV2Response",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"tour": {
"$ref": "#/components/schemas/TourContent"
}
},
"description": "CreateTourV2Response",
"type": "object"
},
"ResponseStatus": {
"title": "ResponseStatus",
"properties": {
"errorCode": {
"type": "string"
},
"message": {
"type": "string"
},
"stackTrace": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseError"
}
},
"meta": {
"$ref": "#/components/schemas/Dictionary_String_String_"
}
},
"description": "ResponseStatus",
"type": "object"
},
"ResponseError": {
"title": "ResponseError",
"properties": {
"errorCode": {
"type": "string"
},
"fieldName": {
"type": "string"
},
"message": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/Dictionary_String_String_"
}
},
"description": "ResponseError",
"type": "object"
},
"CreateTourResponse": {
"title": "CreateTourResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"tour": {
"$ref": "#/components/schemas/TourContent"
}
},
"description": "CreateTourResponse",
"type": "object"
},
"UpdateToursResponse": {
"title": "UpdateToursResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"tours": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TourContent"
}
}
},
"description": "UpdateToursResponse",
"type": "object"
},
"ReadToursResponse": {
"title": "ReadToursResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"tours": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TourContent"
}
}
},
"description": "ReadToursResponse",
"type": "object"
},
"DeleteToursResponse": {
"title": "DeleteToursResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "DeleteToursResponse",
"type": "object"
},
"FindAllTagsOfTokenResponse": {
"title": "FindAllTagsOfTokenResponse",
"properties": {
"existingTags": {
"type": "array",
"items": {
"type": "string"
}
},
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "FindAllTagsOfTokenResponse",
"type": "object"
},
"FindTaggedToursResponse": {
"title": "FindTaggedToursResponse",
"properties": {
"requestedTags": {
"type": "array",
"items": {
"type": "string"
}
},
"tourSCEMIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"foundTours": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FoundTour"
}
},
"searchCriteria": {
"$ref": "#/components/schemas/SearchCriteria"
},
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "FindTaggedToursResponse",
"type": "object"
},
"FoundTour": {
"title": "FoundTour",
"properties": {
"includedTags": {
"type": "array",
"items": {
"type": "string"
}
},
"scemid": {
"type": "string"
},
"tour": {
"$ref": "#/components/schemas/TourContent"
}
},
"description": "FoundTour",
"type": "object"
},
"SearchCriteria": {
"title": "SearchCriteria",
"properties": {
"maxItemCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"from": {
"type": "string",
"format": "date-time",
"nullable": false
},
"until": {
"type": "string",
"format": "date-time",
"nullable": false
},
"addTourData": {
"type": "boolean",
"nullable": false
}
},
"description": "SearchCriteria",
"type": "object"
},
"CreateSubscriptionsResponse": {
"title": "CreateSubscriptionsResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"subscriptionReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionReference"
}
}
},
"description": "CreateSubscriptionsResponse",
"type": "object"
},
"SubscriptionReference": {
"title": "SubscriptionReference",
"properties": {
"subscriptionID": {
"type": "string"
},
"scemid": {
"type": "string"
}
},
"description": "SubscriptionReference",
"type": "object"
},
"ReadSubscriptionsResponse": {
"title": "ReadSubscriptionsResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionContent"
}
}
},
"description": "ReadSubscriptionsResponse",
"type": "object"
},
"GetDeviceIdentifierResponse": {
"title": "GetDeviceIdentifierResponse",
"properties": {
"deviceIdentifier": {
"type": "string"
},
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "GetDeviceIdentifierResponse",
"type": "object"
},
"GetUniqueIdentifierResponse": {
"title": "GetUniqueIdentifierResponse",
"properties": {
"uniqueIdentifier": {
"type": "string"
},
"uniqueReqPrefix": {
"type": "string"
},
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "GetUniqueIdentifierResponse",
"type": "object"
},
"CreateEventsResponse": {
"title": "CreateEventsResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"respAddInfo": {
"$ref": "#/components/schemas/Object"
}
},
"description": "CreateEventsResponse",
"type": "object"
},
"ReadJournalBatchResponse": {
"title": "ReadJournalBatchResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"journalEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalBatchEntry"
}
},
"currentItemCount": {
"type": "integer",
"format": "int32"
},
"itemsPerPage": {
"type": "integer",
"format": "int32"
},
"startIndex": {
"type": "integer",
"format": "int32"
},
"totalItems": {
"type": "integer",
"format": "int64"
}
},
"description": "ReadJournalBatchResponse",
"type": "object"
},
"JournalBatchEntry": {
"title": "JournalBatchEntry",
"properties": {
"entryType": {
"type": "string",
"enum": [
"UNDEFINED",
"TOUR_CREATED",
"SUBSCRIPTION_CREATED",
"EVENT_CREATED",
"ETA_INFO",
"SUBSCRIPTION_REMOVED",
"TOUR_DELETED",
"REF_ROUTE_CALC",
"ETA_ROUTE_CALC",
"STATUS_TOUR",
"STATUS_STOP",
"STATUS_ORDER",
"TOUR_UPDATED",
"STOP_UPDATED",
"STOP_DELETED",
"SUBSCRIPTION_CONFIRMATION",
"NOTIFICATION_INFO",
"REF_ROUTE_ETA_INFO"
]
},
"description": {
"type": "string"
},
"entry": {
"type": "string"
},
"entryCreateTime": {
"type": "string",
"format": "date-time",
"nullable": false
},
"scemid": {
"description": "Encrypted SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
}
},
"description": "JournalBatchEntry",
"type": "object"
},
"ReadStopsETAResponse": {
"title": "ReadStopsETAResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"stopTimeInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StopTimeInfoExt"
}
}
},
"description": "ReadStopsETAResponse",
"type": "object"
},
"StopTimeInfoExt": {
"title": "StopTimeInfoExt",
"properties": {
"coordinate": {
"$ref": "#/components/schemas/Coordinate"
},
"distance": {
"description": "Distance from last stop",
"type": "number",
"format": "double"
},
"genuineWaitingPeriod": {
"description": "GenuineWaitingPeriod",
"type": "integer",
"format": "int32"
},
"recreationPeriodsAtTourPoint": {
"$ref": "#/components/schemas/ExtETARecreationPeriods"
},
"recreationPeriodsOnRoad": {
"$ref": "#/components/schemas/ExtETARecreationPeriods"
},
"stopSCEMID": {
"description": "StopSCEMID",
"type": "string"
},
"plannedETA": {
"description": "PlannedETA",
"type": "string",
"format": "date-time"
},
"eta": {
"description": "ETA",
"type": "string",
"format": "date-time"
},
"etaSource": {
"description": "EtaSource",
"type": "string",
"enum": [
"PLANNED_TOUR_ETA",
"CALCULATE_REFROUTE_ETA",
"CALCULATE_POS_ETA",
"STATUS_POS"
]
},
"relatedTime": {
"description": "RelatedTime",
"type": "string",
"format": "date-time"
},
"info": {
"description": "Info",
"type": "string"
},
"trafficTimeLoss": {
"description": "Total delay in Route in seconds",
"type": "integer",
"format": "int32"
},
"breakAndRestPeriod": {
"type": "integer",
"format": "int32"
},
"waitingPeriod": {
"type": "integer",
"format": "int32"
},
"lastState": {
"description": "Last status",
"type": "string"
}
},
"description": "StopTimeInfoExt",
"type": "object"
},
"ExtETARecreationPeriods": {
"title": "ExtETARecreationPeriods",
"properties": {
"breakPeriod": {
"type": "integer",
"format": "int32",
"nullable": false
},
"dailyRestPeriod": {
"type": "integer",
"format": "int32",
"nullable": false
},
"weeklyRestPeriod": {
"type": "integer",
"format": "int32",
"nullable": false
}
},
"description": "ExtETARecreationPeriods",
"type": "object"
},
"ReadStopETAResponse": {
"title": "ReadStopETAResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"stopSCEMID": {
"type": "string"
},
"plannedETA": {
"type": "string",
"format": "date-time"
},
"eta": {
"type": "string",
"format": "date-time"
},
"etaSource": {
"type": "string",
"enum": [
"PLANNED_TOUR_ETA",
"CALCULATE_REFROUTE_ETA",
"CALCULATE_POS_ETA",
"STATUS_POS"
]
},
"coordinate": {
"$ref": "#/components/schemas/Coordinate"
},
"relatedTime": {
"type": "string",
"format": "date-time"
},
"info": {
"type": "string"
},
"trafficTimeLoss": {
"type": "integer",
"format": "int32"
},
"lastState": {
"type": "string"
}
},
"description": "ReadStopETAResponse",
"type": "object"
},
"ReadStopSearchResponse": {
"title": "ReadStopSearchResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"stops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StopContent"
}
}
},
"description": "ReadStopSearchResponse",
"type": "object"
},
"DeleteStopsResponse": {
"title": "DeleteStopsResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "DeleteStopsResponse",
"type": "object"
},
"ReadStopsResponse": {
"title": "ReadStopsResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"stops": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StopContent"
}
}
},
"description": "ReadStopsResponse",
"type": "object"
},
"UpdateStopsResponse": {
"title": "UpdateStopsResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "UpdateStopsResponse",
"type": "object"
},
"CreateSubscriptionResponse": {
"title": "CreateSubscriptionResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"subscriptionID": {
"type": "string"
},
"scemid": {
"type": "string"
}
},
"description": "CreateSubscriptionResponse",
"type": "object"
},
"DeleteSubscriptionResponse": {
"title": "DeleteSubscriptionResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "DeleteSubscriptionResponse",
"type": "object"
},
"CreateEventResponse": {
"title": "CreateEventResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"respAddInfo": {
"$ref": "#/components/schemas/Object"
}
},
"description": "CreateEventResponse",
"type": "object"
},
"ReadStopResponse": {
"title": "ReadStopResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"stop": {
"$ref": "#/components/schemas/StopContent"
}
},
"description": "ReadStopResponse",
"type": "object"
},
"ReadJournalResponse": {
"title": "ReadJournalResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"journalEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JournalEntry"
}
},
"currentItemCount": {
"type": "integer",
"format": "int32"
},
"itemsPerPage": {
"type": "integer",
"format": "int32"
},
"startIndex": {
"type": "integer",
"format": "int32"
},
"totalItems": {
"type": "integer",
"format": "int64"
}
},
"description": "ReadJournalResponse",
"type": "object"
},
"JournalEntry": {
"title": "JournalEntry",
"properties": {
"ts": {
"type": "string",
"format": "date-time",
"nullable": false
},
"journalType": {
"type": "string",
"enum": [
"UNDEFINED",
"TOUR_CREATED",
"SUBSCRIPTION_CREATED",
"EVENT_CREATED",
"ETA_INFO",
"SUBSCRIPTION_REMOVED",
"TOUR_DELETED",
"REF_ROUTE_CALC",
"ETA_ROUTE_CALC",
"STATUS_TOUR",
"STATUS_STOP",
"STATUS_ORDER",
"TOUR_UPDATED",
"STOP_UPDATED",
"STOP_DELETED",
"SUBSCRIPTION_CONFIRMATION",
"NOTIFICATION_INFO",
"REF_ROUTE_ETA_INFO"
]
},
"description": {
"type": "string"
},
"entry": {
"type": "string"
},
"entryAsJson": {
"$ref": "#/components/schemas/Object"
},
"eventEntryAsJson": {
"$ref": "#/components/schemas/Object"
},
"etaEntriesAsJson": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Object"
}
},
"etaInfoEntryAsJson": {
"$ref": "#/components/schemas/Object"
},
"tourSCEMID": {
"type": "string"
},
"scemid": {
"description": "SCEM-ID on which the object refers to",
"type": "string"
},
"source": {
"type": "string"
},
"emCreateTime": {
"type": "string",
"format": "date-time",
"nullable": false
}
},
"description": "JournalEntry",
"type": "object"
},
"ReadTourSCEMIDSResponse": {
"title": "ReadTourSCEMIDSResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"scemids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "ReadTourSCEMIDSResponse",
"type": "object"
},
"UpdateVehicleProfileResponse": {
"title": "UpdateVehicleProfileResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "UpdateVehicleProfileResponse",
"type": "object"
},
"DeleteTagsOfTourResponse": {
"title": "DeleteTagsOfTourResponse",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"scemid": {
"type": "string"
},
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "DeleteTagsOfTourResponse",
"type": "object"
},
"UpdateTelematicDataResponse": {
"title": "UpdateTelematicDataResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "UpdateTelematicDataResponse",
"type": "object"
},
"CreateTagsForTourResponse": {
"title": "CreateTagsForTourResponse",
"properties": {
"scemid": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "CreateTagsForTourResponse",
"type": "object"
},
"ReadTagsOfTourResponse": {
"title": "ReadTagsOfTourResponse",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"scemid": {
"type": "string"
},
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "ReadTagsOfTourResponse",
"type": "object"
},
"CreateUpdateOEMConfigResponse": {
"title": "CreateUpdateOEMConfigResponse",
"properties": {
"configNames": {
"type": "array",
"items": {
"type": "string"
}
},
"config": {
"$ref": "#/components/schemas/OEMConfigData"
},
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "CreateUpdateOEMConfigResponse",
"type": "object"
},
"CreateOEMScriptExecutorResponse": {
"title": "CreateOEMScriptExecutorResponse",
"properties": {
"scriptResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Object"
}
},
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "CreateOEMScriptExecutorResponse",
"type": "object"
},
"CreateTelematicProviderResponse": {
"title": "CreateTelematicProviderResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "CreateTelematicProviderResponse",
"type": "object"
},
"DeleteTelematicProviderResponse": {
"title": "DeleteTelematicProviderResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "DeleteTelematicProviderResponse",
"type": "object"
},
"ReadProviderInfoResponse": {
"title": "ReadProviderInfoResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"providerAccessURL": {
"type": "string"
},
"callback4PTV": {
"$ref": "#/components/schemas/TelematikCallBack"
},
"addInfo2Callback4PTV": {
"$ref": "#/components/schemas/TelematicTrigger"
}
},
"description": "ReadProviderInfoResponse",
"type": "object"
},
"DeleteOEMConfigResponse": {
"title": "DeleteOEMConfigResponse",
"properties": {
"configNames": {
"type": "array",
"items": {
"type": "string"
}
},
"config": {
"$ref": "#/components/schemas/OEMConfigData"
},
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "DeleteOEMConfigResponse",
"type": "object"
},
"ReadOEMConfigResponse": {
"title": "ReadOEMConfigResponse",
"properties": {
"configNames": {
"type": "array",
"items": {
"type": "string"
}
},
"config": {
"$ref": "#/components/schemas/OEMConfigData"
},
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "ReadOEMConfigResponse",
"type": "object"
},
"CreatePollingTriggerResponse": {
"title": "CreatePollingTriggerResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "CreatePollingTriggerResponse",
"type": "object"
},
"CreateTelematicTriggerResponse": {
"title": "CreateTelematicTriggerResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "CreateTelematicTriggerResponse",
"type": "object"
},
"DeleteTelematicTriggerResponse": {
"title": "DeleteTelematicTriggerResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "DeleteTelematicTriggerResponse",
"type": "object"
},
"ReadTelematicTriggerResponse": {
"title": "ReadTelematicTriggerResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"telematicTrigger": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TelematicTrigger"
}
}
},
"description": "ReadTelematicTriggerResponse",
"type": "object"
},
"CreateLocationResponse": {
"title": "CreateLocationResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"location": {
"$ref": "#/components/schemas/Location"
}
},
"description": "CreateLocationResponse",
"type": "object"
},
"FindLocationsResponse": {
"title": "FindLocationsResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
},
"currentItemCount": {
"type": "integer",
"format": "int32"
},
"itemsPerPage": {
"type": "integer",
"format": "int32"
},
"startIndex": {
"type": "integer",
"format": "int32"
},
"totalItems": {
"type": "integer",
"format": "int64"
}
},
"description": "FindLocationsResponse",
"type": "object"
},
"UpdateLocationResponse": {
"title": "UpdateLocationResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"location": {
"$ref": "#/components/schemas/Location"
}
},
"description": "UpdateLocationResponse",
"type": "object"
},
"CreateOneStopTourResponse": {
"title": "CreateOneStopTourResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"tour": {
"$ref": "#/components/schemas/TourContent"
}
},
"description": "CreateOneStopTourResponse",
"type": "object"
},
"DeleteLocationResponse": {
"title": "DeleteLocationResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
}
},
"description": "DeleteLocationResponse",
"type": "object"
},
"ProximitySearchResponse": {
"title": "ProximitySearchResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"proximityResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProximityResult"
}
},
"currentItemCount": {
"type": "integer",
"format": "int32"
},
"itemsPerPage": {
"type": "integer",
"format": "int32"
},
"startIndex": {
"type": "integer",
"format": "int32"
},
"totalItems": {
"type": "integer",
"format": "int64"
}
},
"description": "ProximitySearchResponse",
"type": "object"
},
"ProximityResult": {
"title": "ProximityResult",
"properties": {
"location": {
"$ref": "#/components/schemas/Location"
},
"distance": {
"type": "integer",
"format": "int32",
"nullable": false
}
},
"description": "ProximityResult",
"type": "object"
},
"ReadLocationResponse": {
"title": "ReadLocationResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"location": {
"$ref": "#/components/schemas/Location"
}
},
"description": "ReadLocationResponse",
"type": "object"
},
"ReadLocArrivalsResponse": {
"title": "ReadLocArrivalsResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"arrivals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Arrival"
}
},
"currentItemCount": {
"type": "integer",
"format": "int32"
},
"itemsPerPage": {
"type": "integer",
"format": "int32"
},
"startIndex": {
"type": "integer",
"format": "int32"
},
"totalItems": {
"type": "integer",
"format": "int64"
}
},
"description": "ReadLocArrivalsResponse",
"type": "object"
},
"Arrival": {
"title": "Arrival",
"properties": {
"stop": {
"$ref": "#/components/schemas/StopContent"
},
"status": {
"type": "string"
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"etaInfo": {
"$ref": "#/components/schemas/StopTimeInfo"
}
},
"description": "Arrival",
"type": "object"
},
"StopTimeInfo": {
"title": "StopTimeInfo",
"properties": {
"stopSCEMID": {
"description": "StopSCEMID",
"type": "string"
},
"plannedETA": {
"description": "PlannedETA",
"type": "string",
"format": "date-time"
},
"eta": {
"description": "ETA",
"type": "string",
"format": "date-time"
},
"etaSource": {
"description": "EtaSource",
"type": "string",
"enum": [
"PLANNED_TOUR_ETA",
"CALCULATE_REFROUTE_ETA",
"CALCULATE_POS_ETA",
"STATUS_POS"
]
},
"relatedTime": {
"description": "RelatedTime",
"type": "string",
"format": "date-time"
},
"info": {
"description": "Info",
"type": "string"
},
"trafficTimeLoss": {
"description": "Total delay in Route in seconds",
"type": "integer",
"format": "int32"
},
"breakAndRestPeriod": {
"type": "integer",
"format": "int32"
},
"waitingPeriod": {
"type": "integer",
"format": "int32"
},
"lastState": {
"description": "Last status",
"type": "string"
}
},
"description": "StopTimeInfo",
"type": "object"
},
"ReadTourDataResponse": {
"title": "ReadTourDataResponse",
"properties": {
"responseStatus": {
"$ref": "#/components/schemas/ResponseStatus"
},
"tourData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AnalyzedTourData"
}
},
"currentItemCount": {
"type": "integer",
"format": "int32"
},
"itemsPerPage": {
"type": "integer",
"format": "int32"
},
"startIndex": {
"type": "integer",
"format": "int32"
},
"totalItems": {
"type": "integer",
"format": "int64"
}
},
"description": "ReadTourDataResponse",
"type": "object"
},
"AnalyzedTourData": {
"title": "AnalyzedTourData",
"properties": {
"status": {
"type": "boolean",
"nullable": false
},
"scemid": {
"type": "string"
},
"analyzedTourInfos": {
"$ref": "#/components/schemas/AnalyzedTourInfos"
},
"analyzedCountInfos": {
"$ref": "#/components/schemas/AnalyzedCountInfos"
},
"analyzedEtaOKInfo": {
"$ref": "#/components/schemas/AnalyzedEtaOK"
},
"analyzedEventVisibility": {
"$ref": "#/components/schemas/AnalyzedEventVisibility"
},
"arrived_Done": {
"type": "string",
"enum": [
"ANALYZED_TOUR_ARRIVED_STATE_UNKNOWN",
"TOUR_DONE_STOPS_NONE_ARRIVED",
"TOUR_DONE_STOPS_ALL_ARRIVED",
"TOUR_DONE_STOPS_PARTLY_ARRIVED",
"TOUR_STOPORDER_SEQUENCE_UNKNOWN",
"TOUR_STOPORDER_SEQUENCE_VALID",
"TOUR_STOPORDER_SEQUENCE_INVALID",
"TOUR_GEOFENCE_UNKNOWN",
"TOUR_GEOFENCE_VALID",
"TOUR_GEOFENCE_INVALID",
"ANALYZED_STOP_ARRIVED_STATE_UNKNOWN",
"STOP_DONE_NOT_ARRIVED",
"STOP_DONE_ARRIVED",
"STOP_STOPORDER_SEQUENCE_VALID",
"STOP_STOPORDER_SEQUENCE_INVALID",
"STOP_GEOFENCE_VALID",
"STOP_GEOFENCE_INVALID"
]
},
"arrived_StopOrder": {
"type": "string",
"enum": [
"ANALYZED_TOUR_ARRIVED_STATE_UNKNOWN",
"TOUR_DONE_STOPS_NONE_ARRIVED",
"TOUR_DONE_STOPS_ALL_ARRIVED",
"TOUR_DONE_STOPS_PARTLY_ARRIVED",
"TOUR_STOPORDER_SEQUENCE_UNKNOWN",
"TOUR_STOPORDER_SEQUENCE_VALID",
"TOUR_STOPORDER_SEQUENCE_INVALID",
"TOUR_GEOFENCE_UNKNOWN",
"TOUR_GEOFENCE_VALID",
"TOUR_GEOFENCE_INVALID",
"ANALYZED_STOP_ARRIVED_STATE_UNKNOWN",
"STOP_DONE_NOT_ARRIVED",
"STOP_DONE_ARRIVED",
"STOP_STOPORDER_SEQUENCE_VALID",
"STOP_STOPORDER_SEQUENCE_INVALID",
"STOP_GEOFENCE_VALID",
"STOP_GEOFENCE_INVALID"
]
},
"arrived_GeofenceOrder": {
"type": "string",
"enum": [
"ANALYZED_TOUR_ARRIVED_STATE_UNKNOWN",
"TOUR_DONE_STOPS_NONE_ARRIVED",
"TOUR_DONE_STOPS_ALL_ARRIVED",
"TOUR_DONE_STOPS_PARTLY_ARRIVED",
"TOUR_STOPORDER_SEQUENCE_UNKNOWN",
"TOUR_STOPORDER_SEQUENCE_VALID",
"TOUR_STOPORDER_SEQUENCE_INVALID",
"TOUR_GEOFENCE_UNKNOWN",
"TOUR_GEOFENCE_VALID",
"TOUR_GEOFENCE_INVALID",
"ANALYZED_STOP_ARRIVED_STATE_UNKNOWN",
"STOP_DONE_NOT_ARRIVED",
"STOP_DONE_ARRIVED",
"STOP_STOPORDER_SEQUENCE_VALID",
"STOP_STOPORDER_SEQUENCE_INVALID",
"STOP_GEOFENCE_VALID",
"STOP_GEOFENCE_INVALID"
]
},
"duration": {
"type": "number",
"format": "double"
},
"readableTourDuration": {
"type": "string"
}
},
"description": "AnalyzedTourData",
"type": "object"
},
"AnalyzedTourInfos": {
"title": "AnalyzedTourInfos",
"properties": {
"tourCreateTime": {
"type": "string",
"format": "date-time",
"nullable": false
},
"stopCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"roundTrip": {
"type": "boolean",
"nullable": false
},
"destination": {
"type": "string"
}
},
"description": "AnalyzedTourInfos",
"type": "object"
},
"AnalyzedCountInfos": {
"title": "AnalyzedCountInfos",
"properties": {
"journalCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"tourCreatedCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"positionCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"statusArrivedCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"statusDepartedCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"etaInfoCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"notificationCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"tourDeletedCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"stopDeletedCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"subscriptionCreatedCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"subscriptionRemovedCount": {
"type": "integer",
"format": "int32",
"nullable": false
},
"subscriptionConfirmationCount": {
"type": "integer",
"format": "int32",
"nullable": false
}
},
"description": "AnalyzedCountInfos",
"type": "object"
},
"AnalyzedEtaOK": {
"title": "AnalyzedEtaOK",
"properties": {
"tourEtaOKState": {
"type": "string",
"enum": [
"ETA_STATE_UNKNOWN",
"ETA_STATE_STOP_UNKNOWN",
"ETA_STATE_STOP_NOT_APPROACHED",
"ETA_STATE_STOP_OK",
"ETA_STATE_STOP_TIME_VIOLATION",
"ETA_STATE_TOUR_UNKNOWN",
"ETA_STATE_TOUR_OK",
"ETA_STATE_TOUR_NOT_OK",
"ETA_STATE_STOP_APPROACHED",
"ETA_STATE_STOP_ON_TIME",
"ETA_STATE_STOP_NOT_ON_TIME",
"ETA_STATE_TOUR_ON_TIME",
"ETA_STATE_TOUR_NOT_ON_TIME"
]
},
"tourOnTimeState": {
"type": "string",
"enum": [
"ETA_STATE_UNKNOWN",
"ETA_STATE_STOP_UNKNOWN",
"ETA_STATE_STOP_NOT_APPROACHED",
"ETA_STATE_STOP_OK",
"ETA_STATE_STOP_TIME_VIOLATION",
"ETA_STATE_TOUR_UNKNOWN",
"ETA_STATE_TOUR_OK",
"ETA_STATE_TOUR_NOT_OK",
"ETA_STATE_STOP_APPROACHED",
"ETA_STATE_STOP_ON_TIME",
"ETA_STATE_STOP_NOT_ON_TIME",
"ETA_STATE_TOUR_ON_TIME",
"ETA_STATE_TOUR_NOT_ON_TIME"
]
},
"analyzedStopsETAInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StopETAState"
}
}
},
"description": "AnalyzedEtaOK",
"type": "object"
},
"StopETAState": {
"title": "StopETAState",
"properties": {
"scemid": {
"type": "string"
},
"stopApproached": {
"type": "string",
"enum": [
"ETA_STATE_UNKNOWN",
"ETA_STATE_STOP_UNKNOWN",
"ETA_STATE_STOP_NOT_APPROACHED",
"ETA_STATE_STOP_OK",
"ETA_STATE_STOP_TIME_VIOLATION",
"ETA_STATE_TOUR_UNKNOWN",
"ETA_STATE_TOUR_OK",
"ETA_STATE_TOUR_NOT_OK",
"ETA_STATE_STOP_APPROACHED",
"ETA_STATE_STOP_ON_TIME",
"ETA_STATE_STOP_NOT_ON_TIME",
"ETA_STATE_TOUR_ON_TIME",
"ETA_STATE_TOUR_NOT_ON_TIME"
]
},
"stopEtaOKState": {
"type": "string",
"enum": [
"ETA_STATE_UNKNOWN",
"ETA_STATE_STOP_UNKNOWN",
"ETA_STATE_STOP_NOT_APPROACHED",
"ETA_STATE_STOP_OK",
"ETA_STATE_STOP_TIME_VIOLATION",
"ETA_STATE_TOUR_UNKNOWN",
"ETA_STATE_TOUR_OK",
"ETA_STATE_TOUR_NOT_OK",
"ETA_STATE_STOP_APPROACHED",
"ETA_STATE_STOP_ON_TIME",
"ETA_STATE_STOP_NOT_ON_TIME",
"ETA_STATE_TOUR_ON_TIME",
"ETA_STATE_TOUR_NOT_ON_TIME"
]
},
"arrived_Done": {
"type": "string",
"enum": [
"ANALYZED_TOUR_ARRIVED_STATE_UNKNOWN",
"TOUR_DONE_STOPS_NONE_ARRIVED",
"TOUR_DONE_STOPS_ALL_ARRIVED",
"TOUR_DONE_STOPS_PARTLY_ARRIVED",
"TOUR_STOPORDER_SEQUENCE_UNKNOWN",
"TOUR_STOPORDER_SEQUENCE_VALID",
"TOUR_STOPORDER_SEQUENCE_INVALID",
"TOUR_GEOFENCE_UNKNOWN",
"TOUR_GEOFENCE_VALID",
"TOUR_GEOFENCE_INVALID",
"ANALYZED_STOP_ARRIVED_STATE_UNKNOWN",
"STOP_DONE_NOT_ARRIVED",
"STOP_DONE_ARRIVED",
"STOP_STOPORDER_SEQUENCE_VALID",
"STOP_STOPORDER_SEQUENCE_INVALID",
"STOP_GEOFENCE_VALID",
"STOP_GEOFENCE_INVALID"
]
},
"arrived_StopOrder": {
"type": "string",
"enum": [
"ANALYZED_TOUR_ARRIVED_STATE_UNKNOWN",
"TOUR_DONE_STOPS_NONE_ARRIVED",
"TOUR_DONE_STOPS_ALL_ARRIVED",
"TOUR_DONE_STOPS_PARTLY_ARRIVED",
"TOUR_STOPORDER_SEQUENCE_UNKNOWN",
"TOUR_STOPORDER_SEQUENCE_VALID",
"TOUR_STOPORDER_SEQUENCE_INVALID",
"TOUR_GEOFENCE_UNKNOWN",
"TOUR_GEOFENCE_VALID",
"TOUR_GEOFENCE_INVALID",
"ANALYZED_STOP_ARRIVED_STATE_UNKNOWN",
"STOP_DONE_NOT_ARRIVED",
"STOP_DONE_ARRIVED",
"STOP_STOPORDER_SEQUENCE_VALID",
"STOP_STOPORDER_SEQUENCE_INVALID",
"STOP_GEOFENCE_VALID",
"STOP_GEOFENCE_INVALID"
]
},
"arrived_GeofenceOrder": {
"type": "string",
"enum": [
"ANALYZED_TOUR_ARRIVED_STATE_UNKNOWN",
"TOUR_DONE_STOPS_NONE_ARRIVED",
"TOUR_DONE_STOPS_ALL_ARRIVED",
"TOUR_DONE_STOPS_PARTLY_ARRIVED",
"TOUR_STOPORDER_SEQUENCE_UNKNOWN",
"TOUR_STOPORDER_SEQUENCE_VALID",
"TOUR_STOPORDER_SEQUENCE_INVALID",
"TOUR_GEOFENCE_UNKNOWN",
"TOUR_GEOFENCE_VALID",
"TOUR_GEOFENCE_INVALID",
"ANALYZED_STOP_ARRIVED_STATE_UNKNOWN",
"STOP_DONE_NOT_ARRIVED",
"STOP_DONE_ARRIVED",
"STOP_STOPORDER_SEQUENCE_VALID",
"STOP_STOPORDER_SEQUENCE_INVALID",
"STOP_GEOFENCE_VALID",
"STOP_GEOFENCE_INVALID"
]
},
"lowerBound": {
"type": "string",
"format": "date-time",
"nullable": false
},
"upperBound": {
"type": "string",
"format": "date-time",
"nullable": false
},
"earliestArrivalTime": {
"type": "string",
"format": "date-time",
"nullable": false
},
"latestDepartureTime": {
"type": "string",
"format": "date-time",
"nullable": false
},
"onTime": {
"type": "string",
"enum": [
"ETA_STATE_UNKNOWN",
"ETA_STATE_STOP_UNKNOWN",
"ETA_STATE_STOP_NOT_APPROACHED",
"ETA_STATE_STOP_OK",
"ETA_STATE_STOP_TIME_VIOLATION",
"ETA_STATE_TOUR_UNKNOWN",
"ETA_STATE_TOUR_OK",
"ETA_STATE_TOUR_NOT_OK",
"ETA_STATE_STOP_APPROACHED",
"ETA_STATE_STOP_ON_TIME",
"ETA_STATE_STOP_NOT_ON_TIME",
"ETA_STATE_TOUR_ON_TIME",
"ETA_STATE_TOUR_NOT_ON_TIME"
]
}
},
"description": "StopETAState",
"type": "object"
},
"AnalyzedEventVisibility": {
"title": "AnalyzedEventVisibility",
"properties": {
"analyzedEventsVisibility": {
"type": "string",
"enum": [
"ANALYZED_EVENT_VISIBILITY_UNKNOWN",
"ANALYZED_EVENT_VISIBILITY_ALL",
"ANALYZED_EVENT_VISIBILITY_PARTLY",
"ANALYZED_EVENT_VISIBILITY_NONE"
]
},
"visible": {
"type": "integer",
"format": "int32",
"nullable": false
},
"notVisible": {
"type": "integer",
"format": "int32",
"nullable": false
}
},
"description": "AnalyzedEventVisibility",
"type": "object"
},
"TourContentWrapper": {
"title": "TourContentWrapper",
"properties": {
"Tour": {
"$ref": "#/components/schemas/TourContent"
}
},
"description": "TourContentWrapper",
"type": "object"
},
"SubscriptionContentListWrapper": {
"title": "SubscriptionContentListWrapper",
"properties": {
"Subscriptions": {
"description": "array of SubscriptionContent",
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionContent"
}
}
},
"description": "SubscriptionContentListWrapper",
"type": "object"
},
"EventContentListWrapper": {
"title": "EventContentListWrapper",
"properties": {
"Events": {
"description": "array of EventContent",
"type": "array",
"items": {
"$ref": "#/components/schemas/EventContent"
}
}
},
"description": "EventContentListWrapper",
"type": "object"
},
"SearchFieldContentWrapper": {
"title": "SearchFieldContentWrapper",
"properties": {
"SearchFieldContent": {
"$ref": "#/components/schemas/SearchFieldContent"
}
},
"description": "SearchFieldContentWrapper",
"type": "object"
},
"SubscriptionContentWrapper": {
"title": "SubscriptionContentWrapper",
"properties": {
"Subscription": {
"$ref": "#/components/schemas/SubscriptionContent"
}
},
"description": "SubscriptionContentWrapper",
"type": "object"
},
"EventContentWrapper": {
"title": "EventContentWrapper",
"properties": {
"Event": {
"$ref": "#/components/schemas/EventContent"
}
},
"description": "EventContentWrapper",
"type": "object"
},
"CreateTagsForTourWrapper": {
"title": "CreateTagsForTourWrapper",
"properties": {
"body": {
"$ref": "#/components/schemas/CreateTagsForTour"
}
},
"description": "CreateTagsForTourWrapper",
"type": "object"
},
"OEMConfigDataWrapper": {
"title": "OEMConfigDataWrapper",
"properties": {
"Config": {
"$ref": "#/components/schemas/OEMConfigData"
}
},
"description": "OEMConfigDataWrapper",
"type": "object"
},
"OEMScriptWrapper": {
"title": "OEMScriptWrapper",
"properties": {
"OEMScript": {
"$ref": "#/components/schemas/OEMScript"
}
},
"description": "OEMScriptWrapper",
"type": "object"
},
"ProviderSettingsWrapper": {
"title": "ProviderSettingsWrapper",
"properties": {
"Config": {
"$ref": "#/components/schemas/ProviderSettings"
}
},
"description": "ProviderSettingsWrapper",
"type": "object"
},
"TelematicTriggerWrapper": {
"title": "TelematicTriggerWrapper",
"properties": {
"Trigger": {
"$ref": "#/components/schemas/TelematicTrigger"
}
},
"description": "TelematicTriggerWrapper",
"type": "object"
},
"LocationWrapper": {
"title": "LocationWrapper",
"properties": {
"Location": {
"$ref": "#/components/schemas/Location"
}
},
"description": "LocationWrapper",
"type": "object"
},
"TourContentListWrapper": {
"title": "TourContentListWrapper",
"properties": {
"Tours": {
"description": "array of TourContent",
"type": "array",
"items": {
"$ref": "#/components/schemas/TourContent"
}
}
},
"description": "TourContentListWrapper",
"type": "object"
},
"StopContentListWrapper": {
"title": "StopContentListWrapper",
"properties": {
"Stops": {
"description": "array of StopContent",
"type": "array",
"items": {
"$ref": "#/components/schemas/StopContent"
}
}
},
"description": "StopContentListWrapper",
"type": "object"
},
"TelematicDataWrapper": {
"title": "TelematicDataWrapper",
"properties": {
"TelematicData": {
"$ref": "#/components/schemas/TelematicData"
}
},
"description": "TelematicDataWrapper",
"type": "object"
},
"TelematicTriggerListWrapper": {
"title": "TelematicTriggerListWrapper",
"properties": {
"Triggers": {
"description": "array of TelematicTrigger",
"type": "array",
"items": {
"$ref": "#/components/schemas/TelematicTrigger"
}
}
},
"description": "TelematicTriggerListWrapper",
"type": "object"
},
"KeyValuePair_String_String_": {
"title": "KeyValuePair",
"properties": {
"Key": {
"type": "string"
},
"Value": {
"type": "string"
}
},
"description": "KeyValuePair",
"type": "object"
},
"Dictionary_String_String_": {
"title": "Dictionary",
"additionalProperties": {
"type": "string"
},
"description": "Dictionary",
"type": "object"
}
},
"parameters": {
"Accept": {
"name": "Accept",
"in": "header",
"description": "Accept Header",
"required": true,
"schema": {
"type": "string",
"enum": [
"application/json"
]
}
}
},
"requestBodies": {
"TourContentWrapper": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TourContentWrapper"
}
}
},
"description": "The tour",
"required": true
},
"TelematicTriggerWrapper": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TelematicTriggerWrapper"
}
}
},
"description": "Config data as JSON",
"required": true
},
"LocationWrapper": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocationWrapper"
}
}
},
"description": "The location",
"required": true
}
},
"securitySchemes": {
"basic": {
"type": "http",
"scheme": "basic"
}
}
}
}