Inclusão de Transporte

POST 
/transportes

Envie um objeto JSON na raiz do body, sem envelope data. POST indica inclusão, PUT alteração e DELETE exclusão. A query opcional operacao=N indica operação não definida.

Request

Query Parameters

application/json

Body

Body

required

matricula int64required
pais stringnullable
uf stringnullable
codCidade int64nullable
nomeCidade stringnullable
codBairro int64nullable
descrBairro stringnullable
codPonto int64nullable
descrPonto stringnullable
dataVigenciaInicial datenullable
dataVigenciaFinal datenullable

exemplo

Exemplo de requisição

{
  "codEmpresa": "EMP01",
  "matricula": 1001,
  "pais": "BR",
  "uf": "SP",
  "codCidade": 3550308,
  "nomeCidade": "São Paulo",
  "codBairro": 1,
  "descrBairro": "Centro",
  "codPonto": 10,
  "descrPonto": "Terminal Bandeira",
  "dataVigenciaInicial": "2024-01-01",
  "dataVigenciaFinal": null
}

Responses

200

Resultado do processamento. Consulte observacao para detalhes.

application/json

Schema

Schema

success booleanrequired
seqRegistro int64nullable
observacao stringnullable

Example (from schema)

{
  "success": true,
  "seqRegistro": 0,
  "observacao": "string",
  "error": [
    null
  ]
}

sucesso

Exemplo de resultado

{
  "success": true,
  "seqRegistro": 128027,
  "observacao": null,
  "error": null
}

400

Falha no processamento ou nos parâmetros da requisição.

application/json

Schema

Schema

anyOf

IntfolResponse

success booleanrequired

seqRegistro int64nullable

observacao stringnullable

ParametroInvalidoResponse

errors

object

required

property name* any

observacao stringrequired

MensagemResponse

message stringrequired

Example (from schema)

{}

empresaAusente

Exemplo de resultado

{
  "message": "Operação Negada. Parâmetro codEmpresa ausente na requisição."
}

erroProcessamento

Exemplo de resultado

{
  "success": false,
  "seqRegistro": null,
  "observacao": "Mensagem de erro retornada pelo processamento.",
  "error": null
}

Loading...