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-am.sesc.com.br/transparencia/dados/api/181
| PARÂMETROS | |||
|---|---|---|---|
| Parâmetro | Tipo | Obrigatoriedade | Descrição |
| search | string | Opcional | Busca geral |
| RETORNO | |||
|---|---|---|---|
| Parâmetro | Tipo | Descrição | |
| registros | Exercicio | Texto curto | Exercício |
| Titular_ou_Suplente | Texto curto | Titular ou Suplente | |
| Nome_Completo | Texto curto | Nome Completo | |
| Cargo_ou_Funcao | Texto curto | Cargo ou Função | |
| Inicio_do_Periodo_de_Gestao | Data | Início do Período de Gestão | |
| Termino_do_Periodo_de_Gestao | Data | Término do Período de Gestão | |
| Data_de_Designacao | Data | Data de Designação | |
| Ato_de_designacao | Texto curto | Ato de Designação | |