Consulta de versão de uma API do VPCEP especificada

version

Sim

String

Especifica o número da versão a ser consultada. O valor começa com v, por exemplo, v1. Se esse parâmetro for deixado em branco, as versões de todas as APIs do VPCEP serão consultadas.

Tipo de conteúdo

Sim

String

Especifica o tipo MIME do corpo da solicitação. O valor padrão application/json é recomendado. Para as API usadas para carregar objetos ou imagens, o tipo MIME pode variar dependendo do tipo de fluxo.

version

VersionObject object

Especifica as versões da API do VPCEP.

Estado

String

Especifica o status da versão.● CURRENT: indica uma versão primária.● SUPPORT: indica uma versão anterior que ainda é suportada. ● DEPRECATED: indica uma versão obsoleta que pode ser excluída posteriormente.

id

String

Especifica a versão da API.

Atualização bem-sucedida

String

Especifica a hora em que versão da API foi lançada. O formato de hora UTC aplicado é AAAA-MMDDTHH:MM:SSZ.

version

String

Especifica o número de versão suportado.

min_version

String

Especifica o número de microversão suportado. Se as APIs não suportarem microversões, o parâmetro será deixado em branco.

links

Array of Link objects

Especifica o URL da API.

href

String

Especifica o endereço de referência da versão atual da API.

type

String

Especifica o tipo MIME do corpo da solicitação. O valor é application/json.

rel

String

Especifica a relação entre a versão atual da API e o endereço referenciado.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

error

Error object

Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa.

message

String

Descrição do erro da tarefa

code

String

Código de erro de uma exceção de tarefa.

200

O servidor processou a solicitação com sucesso.

400

A solicitação não pôde ser entendida pelo servidor devido à sintaxe mal formada.

401

A página solicitada requer um nome de usuário e senha.

403

O servidor entendeu o pedido, mas está se recusando a cumpri-lo.

404

A página solicitada não foi encontrada.

405

O método especificado na linha de solicitação não é permitido para o recurso identificado pelo URI da solicitação.

406

O recurso identificado pela solicitação só é capaz de gerar entidades de resposta que tenham características de conteúdo não aceitáveis de acordo com os cabeçalhos de aceitação enviados na solicitação.

407

O cliente deve primeiro autenticar-se com o proxy.

408

O cliente não produziu uma solicitação dentro do tempo que o servidor estava preparado para esperar.

409

A solicitação não pôde ser concluída devido a um conflito com o estado atual do recurso.

500

Falhou ao concluir a solicitação. Anormalidade de serviço.

501

Falhou ao concluir a solicitação. O servidor não suporta a função solicitada.

502

Falhou ao concluir a solicitação. porque o servidor recebe uma resposta inválida.

503

Falhou ao concluir a solicitação. porque o sistema não está disponível.

504

Gateway expirou o tempo limite