Consultar una operación de transporte

Parámetros, estructura de datos y respuestas del contrato versionado.

GET/fiscal/ciot/{ciot_uuid}

consultarOperacaoCiotBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

El estado de la operación declarada, sin contactar al proveedor.

Es una consulta de solo lectura: úsela después de un 202 o para recuperar un resultado que no guardó. También funciona para operaciones rechazadas, precisamente cuando nunca existió un número de CIOT.

Autenticación

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

ciot_uuidpath · stringObligatorio

El id devuelto por la declaración.

Restricciones

{
  "type": "string",
  "format": "uuid"
}

Respuestas

200 Respuesta HTTP

La operación.

`application/json`

RespostaCiot ↗

dataobjectObligatorio

OperacaoCiot ↗

environmentobjectObligatorio

Environment ↗

401 Respuesta HTTP

Sin autenticación (autenticacao): credencial ausente, inválida o vencida, incluida una clave API utilizada en el entorno incorrecto. La clave de homologación no es válida en producción, ni la de producción en homologación; el mensaje de error indica el entorno esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Respuesta HTTP

Ámbito no habilitado para esta credencial

`application/json`

Erro ↗

errorobjectOpcional

404 Respuesta HTTP

ciot_nao_encontrado — no existe una operación con este identificador en esta empresa. Una operación de otro tenant devuelve deliberadamente la misma respuesta.

`application/json`

Erro ↗

errorobjectOpcional

Definición Completa de la Operación

{
  "tags": [
    "CIOT"
  ],
  "summary": "Consultar uma operação de transporte",
  "operationId": "consultarOperacaoCiot",
  "description": "O estado da operação declarada, **sem** falar com o provedor.\n\nÉ leitura pura: é o que você chama depois de um `202`, ou para reler um desfecho que\nnão guardou. Funciona inclusive para operações recusadas — que é justamente o caso em\nque o número do CIOT nunca existiu.\n",
  "parameters": [
    {
      "name": "ciot_uuid",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "O `id` devolvido pela declaração."
    }
  ],
  "responses": {
    "200": {
      "description": "A operação.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/RespostaCiot"
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Erro401"
    },
    "403": {
      "$ref": "#/components/responses/Erro403"
    },
    "404": {
      "description": "`ciot_nao_encontrado` — não existe operação com esse id **nesta empresa**. Operação\nde outro tenant responde igual, de propósito.\n",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Erro"
          }
        }
      }
    }
  },
  "method": "GET",
  "path": "/fiscal/ciot/{ciot_uuid}"
}