Consultar uma operação de transporte

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/fiscal/ciot/{ciot_uuid}

consultarOperacaoCiotBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

O estado da operação declarada, sem falar com o provedor.

É leitura pura: é o que você chama depois de um 202, ou para reler um desfecho que não guardou. Funciona inclusive para operações recusadas — que é justamente o caso em que o número do CIOT nunca existiu.

Autenticação

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

A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

ciot_uuidpath · stringObrigatório

O id devolvido pela declaração.

Restrições

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

Respostas

200 Resposta HTTP

A operação.

`application/json`

RespostaCiot ↗

dataobjectObrigatório

OperacaoCiot ↗

environmentobjectObrigatório

Environment ↗

401 Resposta HTTP

Não autenticado (autenticacao): credencial ausente, inválida ou expirada — inclusive chave de API usada no ambiente errado. A chave de homologação não vale em produção, nem a de produção em homologação; a mensagem do erro indica o ambiente esperado.

`application/json`

Erro ↗

errorobjectOpcional

403 Resposta HTTP

Escopo não habilitado para esta credencial

`application/json`

Erro ↗

errorobjectOpcional

404 Resposta HTTP

ciot_nao_encontrado — não existe operação com esse id nesta empresa. Operação de outro tenant responde igual, de propósito.

`application/json`

Erro ↗

errorobjectOpcional

Definição Completa da Operação

{
  "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}"
}