Consultar
GET {{url}}/api/v1/integracao/pacote/consultar?pagina=0&itens_por_pagina=20
Endpoint (Rota)
Neste endpoint
, será possível consultar todos os Pacotes que foram adicionados nos Serviços dos Clientes, obtendo o retorno no formato JSON
como resposta. Os seguintes parâmetros podem/devem ser utilizados:
Atributo | Descrição | Obrigatório |
---|---|---|
pagina | Página a ser exibida | Sim |
itensporpagina | Itens por Página a serem exibidos. Mínimo: 1, Máximo: 500. | Sim |
data_inicio | Data inicial de referência para consulta de pacotes em um intervalo | Não |
data_fim | Data final de referência para consulta de pacotes em um intervalo | Não |
tipo_data | O tipo de data poderá ser: datacadastro, dataatualizacao, data_limite | Não |
tipo_busca | O tipo de busca poderá ser: idpacote ou codigopacote | Sim |
termo_busca | O termo de busca poderá será o código do pacote ou o id do pacote. | Sim |
Os atributos podem conter os seguintes valores:
Atributo | Descrição | Valor Default |
---|---|---|
pagina | Campo Inteiro (integer) | 0 |
itensporpagina | Campo Inteiro (integer) | 50 |
data_inicio | Formato date (2024-04-01) | Nenhum |
data_fim | Formato date (2024-04-30) | Nenhum |
tipo_data | Texto | data_cadastro |
termo_busca | Texto | Nenhum |
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
pagina | number | ||
itens_por_pagina | number |