Consolidado
Nesta seção, serão apresentadas 4 solicitações para a API de resultados, contendo informações consolidadas onde podemos montar gráficos e afins.
1 - Resultados agrupados por diagnósticos
OBS: Todas as chamadas para o dashboard de resultados são realizadas na API de https://resultadowebapi.asisprojetos.com.br
GET /api/v1/resultado/{path}
Parâmetros:
- path*: Path identificador da obrigação
- cnpj*: CNPJ da empresa para qual foram gerados os resultados
- inicio*: Data inicial dos resultados
- fim*: Data final dos resultados
- impl: Identificador da implementação (string contendo o nome da implementação especializada)
Headers:
- app-key: chave do aplicativo
- account-key: chave da conta
Response:
- JSON contendo a quantidade total de resultados agrupados por diagnóstico. Exemplo:
[
{
"id": "string",
"label": "string",
"total": "integer"
}
]
2 - Resultados sintéticos
POST /api/v1/resultado/{path}/sintetico
Parâmetros:
- path*: Path identificador da obrigação
- cnpj*: CNPJ da empresa para qual foram gerados os resultados
- inicio*: Data inicial dos resultados
- fim*: Data final dos resultados
- diagnostico: Diagnóstico dos resultados
- impl: Identificador da operação
- size: Quantidade máxima de itens retornados por página
- page: Página da consulta
Headers:
- app-key: chave do aplicativo
- account-key: chave da conta
Response:
- JSON contendo os resultados das auditorias para o período especificado. Exemplo:
{
"content": [
{
"auditoriaId": "integer",
"codigo": "integer",
"nome": "string",
"ementa": "string",
"nivelId": "integer",
"diagnostico": "string",
"qtde": "integer",
"soma": "integer"
}
],
"pageable": {
"sort": {
"sorted": "boolean",
"unsorted": "boolean",
"empty": "boolean"
},
"pageNumber": "integer",
"pageSize": "integer",
"offset": "integer",
"unpaged": "boolean",
"paged": "boolean"
},
"totalPages": "integer",
"totalElements": "integer",
"last": "boolean",
"first": "boolean",
"sort": {
"sorted": "boolean",
"unsorted": "boolean",
"empty": "boolean"
},
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"empty": "boolean"
}
3 - Resultados analíticos
POST /api/v1/resultado/{path}/analitico
Parâmetros:
- path*: Path identificador da obrigação
- cnpj*: CNPJ da empresa para qual foram gerados os resultados
- inicio*: Data inicial dos resultados
- fim*: Data final dos resultados
- auditoriaId*: ID da auditoria para qual foram gerados os resultados
- impl: Identificador da operação
- size: Quantidade máxima de itens retornados por página
- page: Página da consulta
Headers:
- app-key: chave do aplicativo
- account-key: chave da conta
Response:
- JSON contendo os resultados dos itens das auditorias para o período especificado. Exemplo:
{
"content": [
{
"numProt": "integer",
"mesRef": "integer",
"qtde": "integer",
"razaoSocial": "string",
"cnpj": "string"
}
],
"pageable": {
"sort": {
"sorted": "boolean",
"unsorted": "boolean",
"empty": "boolean"
},
"pageSize": "integer",
"pageNumber": "integer",
"offset": "integer",
"paged": "boolean",
"unpaged": "boolean"
},
"totalPages": "integer",
"totalElements": "integer",
"last": "boolean",
"first": "boolean",
"sort": {
"sorted": "boolean",
"unsorted": "boolean",
"empty": "boolean"
},
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"empty": "boolean"
}
4 - Resultados agrupados por obrigação
POST /api/v1/resultado/obrigacao
Parâmetros:
- cnpj*: CNPJ da empresa para qual foram gerados os resultados
- inicio*: Data inicial dos resultados
- fim*: Data final dos resultados
Headers:
- app-key: chave do aplicativo
- account-key: chave da conta
Response:
- JSON contendo a quantidade de auditorias por obrigação para o período especificado. Exemplo:
[
{
"nome": "string",
"path": "string",
"qtde": "integer"
}
]