Skip to content

Commit

Permalink
HubSoft updated postman_doc
Browse files Browse the repository at this point in the history
  • Loading branch information
hubsoftbrasil committed Nov 28, 2022
1 parent 49206e9 commit 7819bce
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions Postman Collections/postman_doc.json
Original file line number Diff line number Diff line change
Expand Up @@ -1231,7 +1231,7 @@
}
]
},
"description": "**GET**\n\nNo método `GET`, irá consultar os dados dos clientes e retornar um `JSON` como resposta. Os seguintes parâmetros podem/devem ser utilizados:\n\n| **Atributo** | **Descrição** | **Obrigatório** |\n| --- | --- | --- |\n| data_inicio | Data de Cadastro Inicial | Não |\n| data_fim | Data de Cadastro Final | Não |\n| cancelado | Retornar serviços cancelados | Não |\n| ultima_conexao | Informa se deseja trazer os dados da última conexão | Não |\n| codigo_pacote | Retorna apenas os clientes que contém pacotes com o código especificado | Não |\n| relacoes | Carrega apenas os relacionamentos especificados | Não |\n| limit | Limite de resultados | Não |\n| offset | Deslocamento em relação ao limite de dados | Não |\n| order_by | Campo que será utilizado para ordenação | Não |\n| order_type | Tipo de Ordenação | Não |\n\nOs atributos podem conter os seguintes valores:\n\n| **Atributo** | **Descrição** | **Valor Default** |\n| --- | --- | --- |\n| data_inicio | Valor no formato DateTime (YYYY-MM-DD) | Nenhum |\n| data_fim | Valor no formato DateTime (YYYY-MM-DD) Obs: Maior ou igual data_inicio | Nenhum |\n| cancelado | sim,nao | nao |\n| ultima_conexao | sim,nao | nao |\n| codigo_pacote | Valor no formato string | Nenhum |\n| relacoes | endereco_instalacao,endereco_cadastral,endereco_cobranca,endereco_fiscal,pacotes,interface,interface_roteamento,equipamento_conexao,equipamento_roteamento,grupos,porta_atendimento,senhas,status_conexao | Nenhum |\n| limit | Número Inteiro maior que 0 | Nenhum |\n| offset | Número Inteiro maior que 0 | Nenhum |\n| order_by | data_cadastro,data_fechamento | data_cadastro |\n| order_type | asc,desc | asc |\n\n**IMPORTANTE:** Por se tratar de uma requisição que poderá trazer uma quantidade muito grande dados, o sistema irá armazenar o resultado da requisição em um Cache. Portanto, em chamadas consecutivas em curtos intervalos de tempo dessa rota, o sistema irá retornar o mesmo resultado. Recomendamos o uso dessa API poucas vezes ao dia (EX: 1 vez de madrugada e outra na parte da tarde por exemplo). Chamadas consecutivas nessa API pode parar seu sistema."
"description": "**GET**\n\nNo método `GET`, irá consultar os dados dos clientes e retornar um `JSON` como resposta. Os seguintes parâmetros podem/devem ser utilizados:\n\n| **Atributo** | **Descrição** | **Obrigatório** |\n| --- | --- | --- |\n| data_inicio | Data de Cadastro Inicial | Não |\n| data_fim | Data de Cadastro Final | Não |\n| cancelado | Retornar serviços cancelados | Não |\n| ultima_conexao | Informa se deseja trazer os dados da última conexão | Não |\n| codigo_pacote | Retorna apenas os clientes que contém pacotes com o código especificado | Não |\n| relacoes | Carrega apenas os relacionamentos especificados | Não |\n| limit | Limite de resultados | Não |\n| offset | Deslocamento em relação ao limite de dados | Não |\n| order_by | Campo que será utilizado para ordenação | Não |\n| order_type | Tipo de Ordenação | Não |\n\nOs atributos podem conter os seguintes valores:\n\n| **Atributo** | **Descrição** | **Valor Default** |\n| --- | --- | --- |\n| data_inicio | Valor no formato DateTime (YYYY-MM-DD) | Nenhum |\n| data_fim | Valor no formato DateTime (YYYY-MM-DD) Obs: Maior ou igual data_inicio | Nenhum |\n| cancelado | sim,nao | nao |\n| ultima_conexao | sim,nao | nao |\n| codigo_pacote | Valor no formato string | Nenhum |\n| relacoes | endereco_instalacao, endereco_cadastral, endereco_cobranca, endereco_fiscal, pacotes, interface, interface_roteamento, equipamento_conexao, equipamento_roteamento, grupos, porta_atendimento, senhas, status_conexao | Nenhum |\n| limit | Número Inteiro maior que 0 | Nenhum |\n| offset | Número Inteiro maior que 0 | Nenhum |\n| order_by | data_cadastro,data_fechamento | data_cadastro |\n| order_type | asc,desc | asc |\n\n**IMPORTANTE:** Por se tratar de uma requisição que poderá trazer uma quantidade muito grande dados, o sistema irá armazenar o resultado da requisição em um Cache. Portanto, em chamadas consecutivas em curtos intervalos de tempo dessa rota, o sistema irá retornar o mesmo resultado. Recomendamos o uso dessa API poucas vezes ao dia (EX: 1 vez de madrugada e outra na parte da tarde por exemplo). Chamadas consecutivas nessa API pode parar seu sistema."
},
"response": [
{
Expand Down Expand Up @@ -3505,37 +3505,37 @@
],
"variable": [
{
"id": "7ab5b69c-f10c-4842-a2e5-ace87f0617fb",
"id": "ff670772-a127-480d-9a3a-149e574234c7",
"key": "url",
"value": ""
},
{
"id": "634dd90d-f657-4ad2-ad9b-2ec79824af65",
"id": "013c3cc8-0d7e-4dad-8a3f-9f336588e30e",
"key": "client_id",
"value": ""
},
{
"id": "85111871-05f5-4501-9000-e310a550f583",
"id": "f93fe039-65a0-4463-b4fa-6c0f3880e531",
"key": "client_secret",
"value": ""
},
{
"id": "0b6bf7c9-c0c8-4f65-9daa-2b71fc4476bc",
"id": "7d6c5f4b-1252-41bf-9f8d-830478cedc90",
"key": "username",
"value": ""
},
{
"id": "1fa9a7fd-39fa-4380-8e2c-dd4be44530ba",
"id": "76f2d9fb-b8ce-47c1-8189-61ffd1c40e2e",
"key": "password",
"value": ""
},
{
"id": "129bd104-d079-4a82-b921-ee17ee375034",
"id": "28bfcd1a-15fe-4029-88f3-fac636b69e05",
"key": "grant_type",
"value": ""
},
{
"id": "6d4ad58e-e9c8-4ca1-88c1-9e26a2e55565",
"id": "8ebd0dfe-1c2b-4e11-8101-7581daf2c32e",
"key": "access_token",
"value": ""
}
Expand Down

0 comments on commit 7819bce

Please sign in to comment.