exceptions
All PTV xServer services can throw an XServerFault which is specified in this namespace. This exception contains a message and for further details a subtype of XServerFault. There are five main subtypees of XServerFault:
- SetupFault: For anything that relates to the xServer's setup like configuration faults. These faults can only occur while starting the xServer and should not be caught by a client.
- RejectedRequestFault: If a request can not be executed and is not even evaluated. For example, if a request has timed out or if there is no valid license.
- InvalidRequestFault: If the request is invalid due to missing or conflicting parameters.
- ProcessingFault: All faults which occur while processing the request.
- InternalErrorFault: If an unexpected internal error occurs in the xServer.
See request and response for details on when a result limitation will be returned instead of an exception.
Types
SuppressedXServerException
used by ContentSnapshotInformation, FeatureLayerInformation, HighPerformanceRoutingNetworkInformation, DistanceMatrixInformation, LocationsBulkResponseItem
since 2.5
This entity wraps a former exception in order to return it in a regular response, for example of a bulk or list method. This 'exception' cannot be caught but the contents can be treated as if they originate from an XServerException.
Field Name | Type | Required | Default | Since | Description |
---|---|---|---|---|---|
message | String | yes | - | 2.5 | The message of the suppressed exception. |
faultInfo | XServerFault | yes | - | 2.5 | The fault information of the suppressed exception. |
This fault is thrown if the sender does not have the rights to execute the request. This may be due to required admin privileges or blocked methods by a middleware.
If this fault is thrown, REST and JSON calls return a http status code 403
, a SOAP call returns a http status code 500
.
No fields defined. |
This fault is thrown if the insertion position of an order is not clearly determinable.
The insertion position of an order contained in a MoveOrdersAction can be ambiguous. Either orders from different sites shall be moved to a specified insertion position which means the resulting stop sequence is unclear. Or all orders of the target trip shall be moved such that the target trip would be dissolved after removing the orders. In that case it is not clear how to interpret the specified insertion position when there are no more stops left.
Furthermore the insertion position of a transport order contained in a stop of a MoveStopsAction can be ambiguous. More precisely a partner task belonging to a task contained in a stop of a MoveStopsAction could have multiple options where to be inserted in the target trip. For further explanation please have a look at the documentation of the MoveStopsAction.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
orderId | String | 2.11 | ID of the order with unclear insertion position. |
taskType | TaskType | 2.11 | Task type of the task with unclear insertion position. |
This fault is thrown if an entry in a configuration file leads to a problem.
If this fault is thrown, REST and JSON calls return a http status code 500
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
fileName | FileName (String) | 2.0 | The name of the configuration file that contains the wrongly configured parameter. |
parameter | String | 2.0 | The name of the wrongly configured parameter. |
value | String | 2.0 | The wrongly configured value. |
This fault is thrown if due to a specific parameter of the request certain data is required to calculate the response but the data is not available.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
This fault is thrown if a delivery task is executed before the corresponding pickup task in an input tour or a ChangeToursRequest would lead to this wrong order of tasks.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
This fault is thrown if a visit order is to be executed at a depot.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
orderId | String | 2.11 | ID of the visit order causing the exception. |
siteId | String | 2.11 | ID of the depot site the visit order refers to. |
This fault is thrown if a distance matrix with the specified ID could not be found on the server.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
This fault is thrown if the profile folder contains two files with the same name in different subfolders.
If this fault is thrown, REST and JSON calls return a http status code 500
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
fileName | FileName (String) | 2.6 | The name of the profile file that is present in two folders. |
This fault is thrown if a parameter of type EncodedContent contains a value which does not match the map.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
This fault is thrown if an unexpected internal error occurs. It may happen when a module runs out of memory or lacks an important resource. If the error persists, report it to PTV's xServer support.
If this fault is thrown, REST and JSON calls return a http status code 500
, a SOAP call returns a http status code 500
.
No fields defined. |
This fault is thrown if the type of a fetch request, to get the response of an asynchronous job, is invalid. For example if the response of a startPlanTours request is fetched with fetchDistanceMatrixResponse.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
This fault is thrown if a site in an input tour is left although there is still load for it on the vehicle or is served although there is still load from it on the vehicle or a ChangeToursRequest would lead to this wrong loading sequence. For more information please have a look at the section valid loading sequence of the technical concept for tours and trips.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Fault
InvalidRequestFault
extends XServerFault
extended by DataNotAvailableFault, DistanceMatrixIdNotFoundFault, InvalidFetchTypeFault, InvalidProfileNameFault, InvalidTourRequestFault, InvalidValueFault, LicenseViolationFault, MissingParameterFault, ParameterConflictFault, TransformFault, UTCOffsetNotDeterminableFault
since 2.0
This fault is thrown if a request is invalid, for instance if it does not fit the WSDL specification.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
No fields defined. |
This fault is thrown if a delivery task is not at the beginning of a stop or a pickup task is not at the end of a stop.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Fault
InvalidTourRequestFault
extends InvalidRequestFault
extended by OrderAlreadyPlannedFault, TourStructureFault
since 2.11
This fault is thrown if a PlanToursRequest or a ChangeToursRequest is invalid.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
No fields defined. |
Fault
InvalidValueFault
extends InvalidRequestFault
extended by EncodedContentMapMismatchFault
since 2.0
This fault is thrown if a request parameter is set to an invalid value.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
This fault is thrown if a license is missing for some services or if some data content is unlicensed.
If this fault is thrown, REST and JSON calls return a http status code 500
, a SOAP call returns a http status code 500
.
This fault is thrown if a request exceeds the licensed range of a specific feature. For example if only data in Germany is licensed, but coordinates in Switzerland are requested.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
This fault is thrown if a AddTripAction or InsertionPositionsForOrdersQuery contains an order that is not an unplanned order.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
orderId | String | 2.11 | ID of the order in the AddTripAction or InsertionPositionsForOrdersQuery that is already planned. |
This fault is thrown if two parameters are in conflict with each other.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Fault
ProcessingFault
extends XServerFault
extended by ProcessingTimedOutFault, RouteNotFoundFault, WaypointNotLinkableFault
since 2.0
This fault is thrown if the request could not be processed by the service.
If this fault is thrown, REST and JSON calls return a http status code 500
, a SOAP call returns a http status code 500
.
No fields defined. |
This fault is thrown if the processing of a request is aborted by an internal timeout. In contrast to RequestTimedOutFault, there is no user-configurable timeout value that could be changed to prevent this. An internal timeout is meant to control corner cases where an algorithm behaves poorly.
If this fault is thrown, REST and JSON calls return a http status code 500
, a SOAP call returns a http status code 500
.
No fields defined. |
This fault is thrown if there are too many requests in the xServer's request queue. If this happens frequently, you may have to increase the size of the request queue in the xServer configuration.
If this fault is thrown, REST and JSON calls return a http status code 503
, a SOAP call returns a http status code 500
.
No fields defined. |
Fault
RejectedRequestFault
extends XServerFault
extended by AccessDeniedFault, QueueOverflowFault, RequestDeletedFault, RequestTimedOutFault, ServiceNotConfiguredFault
since 2.0
This fault is thrown if the request is rejected by the server for some reason.
If this fault is thrown, REST and JSON calls return a http status code 500
, a SOAP call returns a http status code 500
.
No fields defined. |
This fault is thrown if the request was deleted from the outside, for example via the status monitor.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
No fields defined. |
This fault is thrown if the request ran into a timeout. If this happens frequently, you may have to increase the timeout values in the xServer configuration.
If this fault is thrown, REST and JSON calls return a http status code 500
, a SOAP call returns a http status code 500
.
No fields defined. |
This fault is thrown if a route between the given waypoints could not be found with the current configuration and profile. This may be caused by road blockings without the possibility of a detour.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
waypointIndex | Index (Integer) | 2.32 | The index of the input waypoint where the problematic part that could not be routed starts, i.e., the problematic part of the route is between this input waypoint and the next one. Note that only the first problematic part that was encountered during the routing algorithm is reported. |
This fault is thrown if a requested service is not configured in the current deployment.
If this fault is thrown, REST and JSON calls return a http status code 500
, a SOAP call returns a http status code 500
.
Fault
SetupFault
extends XServerFault
extended by ConfigurationFault, DuplicateProfileFault, LicenseFault
since 2.0
This fault is thrown if an error occurred during the setup of the xServer. SetupFaults are never raised by a request, they only occur on startup.
If this fault is thrown, REST and JSON calls return a http status code 500
, a SOAP call returns a http status code 500
.
No fields defined. |
This fault is thrown if the singleDepotPerTour restriction is set but an input tour consists of multiple depots or a ChangeToursRequest would lead to multiple depots per tour.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
vehicleId | String | 2.11 | ID of the vehicle serving the input tour with invalid structure in case of a PlanToursRequest. In case of a ChangeToursRequest this parameter contains the ID of the vehicle that would serve a tour with invalid structure. |
This fault is thrown if the singleTripPerTour restriction is set but an input tour consists of multiple trips or a ChangeToursRequest would lead to multiple trips per tour.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
vehicleId | String | 2.11 | ID of the vehicle serving the input tour with invalid structure in case of a PlanToursRequest. In case of a ChangeToursRequest this parameter contains the ID of the vehicle that would serve a tour with invalid structure. |
This fault is thrown if a stop structure is violated. For more information please have a look at the technical concept Orders, Locations, and Stops.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Fault
TourStructureFault
extends InvalidTourRequestFault
extended by DepotVisitFault, SingleDepotPerTourRestrictionFault, SingleTripPerTourRestrictionFault, TripStructureFault, TripsMergedFault
since 2.11
This fault is thrown if a tour structure is violated. For more information please have a look at the section valid tour structures of the technical concept for tours and trips.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
No fields defined. |
This fault is thrown if an exception occured during transformation of input coordinates, geometries or bounds.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
wrongCoordinate | Coordinate | 2.0 | Represents the coordinate which could not be transformed. |
srid | String | 2.0 | The SRID of the request coordinates. |
This fault is thrown if a trip structure is violated regarding depot sites.
This fault references one of the following:
- A pickup task at a depot that is not part of the consecutive pickup depot stops at the start of a trip.
- A task that is not a delivery at a depot but is executed after or in between the consecutive delivery depot stops at the end of a trip.
For more information please have a look at the technical concepts Tours and Trips and Orders, Locations and Stops.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
orderId | String | 2.11 | ID of the order that violates the trip depot structure. |
taskType | TaskType | 2.11 | Task type of the task that violates the trip depot structure. |
Fault
TripStructureFault
extends TourStructureFault
extended by AmbiguousInsertionPositionFault, DeliveryBeforePickupFault, InvalidLoadingSequenceFault, StopStructureFault, TripDepotStructureFault
since 2.11
This fault is thrown if a trip structure is violated. For more information please have a look at the section valid tour structures of the technical concept for tours and trips.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
vehicleId | String | 2.11 | ID of the vehicle serving the input tour with invalid structure in case of a PlanToursRequest. In case of a ChangeToursRequest this parameter contains the ID of the vehicle that would serve a tour with invalid structure. |
tripId | String | 2.11 | ID of the input trip with invalid structure in case of a PlanToursRequest. In case of a ChangeToursRequest this parameter contains the ID of the trip that would have an invalid structure. |
This fault is thrown if a ChangeToursRequest results in merging two trips.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
vehicleId | String | 2.11 | ID of the vehicle that would serve a tour with invalid structure. |
tripIdA | String | 2.11 | ID of the trip that would be merged with the trip corresponding to tripIdB. |
tripIdB | String | 2.11 | ID of the trip that would be merged with the trip corresponding to tripIdA. |
objectId | String | 2.11 | ID of the object in the ChangeToursAction that would cause the merge of two trips.
|
This fault is thrown if the UTC offset for a request depending on some reference time could not be determined.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
No fields defined. |
This fault is thrown if some routing waypoints could not be linked to the road network.
If this fault is thrown, REST and JSON calls return a http status code 400
, a SOAP call returns a http status code 500
.
Field Name | Type | Since | Description |
---|---|---|---|
waypointIndices | Index[] (Integer[]) | 2.0 | The list of indices of waypoints that could not be linked. The indices refer to the array of waypoints in the request. |
locationsIndices | Index[] (Integer[]) | 2.33 | The list of indices of locations that could not be linked. The indices refer to the array of locations in the request. |
Fault
XServerFault
extended by InternalErrorFault, InvalidRequestFault, ProcessingFault, RejectedRequestFault, SetupFault
since 2.0
The base type for all types of fault info that can be included in an XServerException.
If this fault is thrown, REST and JSON calls return a http status code 500
, a SOAP call returns a http status code 500
.
Exception
XServerException
This is the exception which is thrown by all xServer operations. See the included XServerFault and its subtypes for details.
The http status code that is returned when an exception is thrown depends on the type of XServerFault that is included in the exception.
Field Name | Type | Description |
---|---|---|
message | String | The detailed message. |
faultInfo | XServerFault | Contains detailed information on this exception. |