Pause data session

General Description

The pause-transports endpoint allows pausing the position transmission of an active transport, based on the UIT code. Similar to start and stop, transports are temporarily paused.

It is subject to the restrictions described in Rate Limit.

⚠️ All requests to this endpoint must include the api-version=2.0 parameter in the URL.
URL: POST https://api.trackgps.ro/api/eTransport/pause-transports?api-version=2.0

Request Parameters

Requests to this endpoint must be of type POST and include the following parameters:

  • Query parameter:

    • api-version (string, required) – API version. Recommended value: 2.0

  • Body (JSON):

{
  "transports": [
    {
      "codeUit": "string"
    }
  ]
}
Parameter Type Required Description
transports array Yes List of transports to be paused.
codeUit string Yes Unique UIT identification code of the transport.

Response Structure

{
  "payload": true,
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Property Descriptions

Property Type Description
payload boolean Result of the pause operation (true if successful).
correlationId string Unique request identifier, useful for traceability.
failureReasons array List of errors (if any), each with code and parameters.
isSuccess boolean Indicates if the request was processed successfully (true or false).

Error Responses

HTTP Code Description
400 Missing, invalid, or incorrectly formatted parameters.
401 Unauthenticated user or insufficient permissions.
429 Rate limit exceeded for the user.