CONTEÚDO
01. VISÃO GERAL
Este endpoint é utilizado para obter informações detalhadas sobre consumo, fornecendo um retorno em formato JSON com diversos atributos relevantes. Ao enviar uma solicitação conforme especificado nos exemplos abaixo, o endpoint processa a requisição e retorna um conjunto de dados que inclui o status mais recente do consumo.
...
02. ENDPOINT
...
03. EXEMPLO DE UTILIZAÇÃO
3.1- Request - Retornar todos os status dos consumos:
Ao fazer essa requisição, o sistema processa a solicitação para obter o status dos consumos indicados, retornando as informações de cada consumo solicitado.
| Payload | Legenda |
|---|
| Bloco de código |
|---|
| title | JSON Para retornar o status de um pedido específico |
|---|
| linenumbers | true |
|---|
| {
"integrationHubServiceId": "7056c970-cb11-400f-9d4f-9f30253f3b0b",
"orderKeyType": "INDOOR",
"orderKey": ["40"]
} |
| | Chave | Tipo | Legenda |
|---|
| integrationHubServiceId | String | Id da configuração da integração | | orderKeyType | String | Procurar pelo order id ou pelo tipo indoor. Enum: [ INDOOR, ORDER_ID ] | | orderKey | Lista de String | Id do pedido, caso vazio retorna todo do type escolhido. |
|
| Nota |
|---|
| title | Nota: HTTP Status Code = 202 Accepted |
|---|
|
O seu pedido foi aceite, mas ainda não foi processado, aguarde alguns instantes e contacte a mesma morada para obter o consumo solicitado. |
...
| Dica |
|---|
|
Campos marcaos com o * (asteristico) o seu preenchimento é obrigatório |
...
04. ERROS
A seguir, alguns dos erros comuns que podem ser apresentados ao lidar com requisições HTTP e suas respectivas respostas:
...
| Nota |
|---|
| title | Nota: HTTP Status Code = 429 - Too Many Requests |
|---|
|
Alguma regra para atender ao seu pedido não foi cumprida; analise o corpo da resposta para descobrir as razões. |
...
05. LINKS
