Documentação da API de Cargos

URL do Endpoint

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

Descrição

Este endpoint fornece uma lista de cargos disponíveis, 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/cargos/

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` `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:

total: Quantidade de servidores para aquele determinado cargo_nivel
cargo_nivel: Nome/Nível do cargo

[
    {
        "total": 3,
        "cargo_nivel": "AGENTE LEGISLATIVO > CLASSE 1 > NÍVEL 10"
    },
    {
        "total": 1,
        "cargo_nivel": "AGENTE LEGISLATIVO > CLASSE 1 > NÍVEL 6"
    },
    ...
]

CSV

Retorna um arquivo CSV com duas colunas: total e cargo_nivel.

Exemplos de Uso

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