Documentação da API de Servidores

URL do Endpoint

https://dadosabertos.alepe.pe.gov.br/api/v1/servidores/

Descrição

Este endpoint fornece uma lista de servidores, com os dados provenientes do Portal de Dados Abertos da Alepe. É possível filtrar por vínculo de servidor, bem como optar pelo formato de saída JSON ou CSV.

Requisição HTTP

Método

GET

URL

https://dadosabertos.alepe.pe.gov.br/api/v1/servidores/

Parâmetros de Consulta

Parâmetro	Descrição	Tipo	Opcional
`formato`	Especifica o formato da resposta. Os formatos suportados são `json` (padrão) e `csv`.	String	Sim
`vinculo`	Filtra os resultados pelo vínculo do servidor. Valores possíveis: `efetivo` (mostra todos `Efetivo`, incluindo os efetivos cedidos) `efetivo-cedido` (apenas servidores efetivos que estejam `À DISPOSIÇÃO`) `comissionado` `a-disposicao` (corresponde a `À Disposição`) Se não for informado, serão incluídos todos os vínculos `Efetivo`, `Comissionado` e `À Disposição`.	String	Sim

Resposta

Formato

A resposta pode estar em formato JSON ou CSV, dependendo do parâmetro de consulta formato.

JSON

Retorna um array de objetos. Cada objeto contém (excluindo o campo ENTIDADE):

SEQ
NOME
CODIGO_LOTACAO
NOME_LOTACAO
CARGO_NIVEL
VINCULO
SITUACAO

[
    {
        "NOME": "THIAGO FREITAS LIRA",
        "CODIGO_LOTACAO": "40",
        "NOME_LOTACAO": "Gerência de Apoio à Sistematização da Legislação Estadual",
        "CARGO_NIVEL": "GERENTE",
        "VINCULO": "Efetivo",
        "SITUACAO": "Admitido"
    },
    ...
]

CSV

Retorna um arquivo CSV com as colunas (acima) em cabeçalho, porém sem o campo ENTIDADE.

Exemplos de Uso

Sem parâmetro de vínculo
GET https://dadosabertos.alepe.pe.gov.br/api/v1/servidores/
Retorna servidores com vínculos Efetivo, Comissionado e À Disposição.
Filtrar por Efetivo
GET https://dadosabertos.alepe.pe.gov.br/api/v1/servidores/?vinculo=efetivo
Retorna somente servidores com vinculo = 'Efetivo'.
Filtrar por Efetivo-Cedido
GET https://dadosabertos.alepe.pe.gov.br/api/v1/servidores/?vinculo=efetivo-cedido
Retorna somente servidores efetivos que estejam À DISPOSIÇÃO.
Filtrar por Comissionado
GET https://dadosabertos.alepe.pe.gov.br/api/v1/servidores/?vinculo=comissionado
Filtrar por À Disposição
GET https://dadosabertos.alepe.pe.gov.br/api/v1/servidores/?vinculo=a-disposicao
Retorno em CSV
GET https://dadosabertos.alepe.pe.gov.br/api/v1/servidores/?vinculo=efetivo&formato=csv