Os dados abertos podem ser acessados a qualquer momento em formato JSON (JavaScript Object Notation) e são atualizados dinamicamente conforme o Portal da Transparência.
Todos os endpoints da API possuem em comum os parâmetros abaixo:
| Parâmetro | Tipo | Obrigatoriedade | Descrição |
|---|---|---|---|
| page | inteiro | Opcional | Página atual a exibir, caso não informado ou incorreto o valor padrão será 1 |
| page_size | inteiro | Opcional | Quantidade de registros da página (Mínimo 1, máximo 1000), caso não informado ou incorreto o valor padrão será 10 |
Todos os endpoints da API possuem em comum os retornos abaixo:
| Parâmetro | Tipo | Descrição |
|---|---|---|
| pagina_total | inteiro | Retorna o número total de páginas |
| pagina_atual | inteiro | Retorna o número da página em exibição |
| pagina_anterior | inteiro | Retorna o número da página anterior, caso não houver, o valor null será retornado |
| pagina_proxima | inteiro | Retorna o número da próxima página, caso não houver, o valor null será retornado |
| registro_total | inteiro | Retorna o número total de registros |
| registro_atual | inteiro | Retorna o número de registros da página atual |
| mensagens | lista | Retorna mensagens de possíveis erros caso ocorram |
Endpoint: https://transparencia-dn.sesc.com.br/transparencia/dados/api/188
| PARÂMETROS | |||
|---|---|---|---|
| Parâmetro | Tipo | Obrigatoriedade | Descrição |
| search | string | Opcional | Busca geral |
| RETORNO | |||
|---|---|---|---|
| Parâmetro | Tipo | Descrição | |
| registros | Ano | Inteiro | Ano |
| UF | Texto curto | UF | |
| Janeiro | Decimal | Janeiro | |
| Fevereiro | Decimal | Fevereiro | |
| Marco | Decimal | Março | |
| Abril | Decimal | Abril | |
| Maio | Decimal | Maio | |
| Junho | Decimal | Junho | |
| Julho | Decimal | Julho | |
| Agosto | Decimal | Agosto | |
| Setembro | Decimal | Setembro | |
| Outubro | Decimal | Outubro | |
| Novembro | Decimal | Novembro | |
| Dezembro_13 | Decimal | Dezembro 13º | |
| Dezembro | Decimal | Dezembro | |
| Total | Decimal | Total | |