11.8. Consultar Todos Documentos de uma Contratação
Serviço que permite consultar a lista de documentos pertencentes a uma contratação.
11.8.1. Detalhes da Requisição
Endpoint |
Método HTTP |
|---|---|
/v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/arquivos |
GET |
11.8.2. Exemplo Requisição (cURL)
1 curl -k -X GET \
2 "${BASE_URL}/v1/orgaos/10000000000003/compras/2021/1/arquivos" \
3 -H "Accept: */*"
11.8.2.1. Exemplo de Payload
1 Não se aplica
11.8.3. Dados de Entrada
Nota
Alimentar os parâmetros cnpj, ano e sequencial na URL.
Id |
Campo |
Tipo |
Obrigatório |
Descrição |
|---|---|---|---|---|
1 |
cnpj |
Texto (14) |
Sim |
Cnpj do órgão originário da contratação informado na inclusão (proprietário da contratação ou alienação de bens) |
2 |
ano |
Inteiro |
Sim |
Ano da contratação |
3 |
sequencial |
Inteiro |
Sim |
Sequencial da Contratação no PNCP; Número sequencial gerado no momento que a contratação foi inserida no PNCP; |
11.8.4. Dados de Retorno
Id |
Campo |
Tipo |
Descrição |
|---|---|---|---|
1 |
documentos |
Lista |
Lista de documentos |
1.1 |
sequencialDocumento |
Inteiro |
Número sequencial atribuído ao arquivo |
1.2 |
url |
Texto |
URL para download do arquivo |
1.3 |
tipoDocumentoId |
Inteiro |
Código do tipo de documento conforme PNCP |
1.4 |
tipoDocumentoNome |
Texto |
Nome do tipo de documento conforme PNCP |
1.5 |
titulo |
Texto |
Título referente ao arquivo |
1.6 |
dataPublicacaoPncp |
Data |
Data de publicação do arquivo no portal PNCP |
11.8.5. Códigos de Retorno
Código HTTP |
Mensagem |
Tipo |
|---|---|---|
200 |
OK |
Sucesso |
400 |
BadRequest |
Erro |
422 |
Unprocessable Entity |
Erro |
500 |
Internal Server Error |
Erro |