API - Application Programming Interface

---

Retorna uma listagem com todos os bombeiros. Pode usar filtros de pesquisa passando parâmetros na string de consulta.

URL

https://api.gescorp.pt/api/v1/firefighters

HEADERS

Accept: application/json
                            
apikey: API_KEY
                            
X-AccessKey: ACCESS_KEY

Parâmetros

Nome	Tipo	Obrigatório	Descrição	Exemplo
method	string	Sim	Método a invocar.	firefightersList
id	integer		Identificador específico pelo qual pretende procurar um determinado bombeiro.	99

Responses

200	SUCCESS Listagem de bombeiros obtida com sucesso.
401	AUTHENTICATION ERROR Parâmetros de autentificação incorrectos.	(Empty Response)
404	INVALID METHOD O método inserido é inválido ou é de uso obrigatório.

Example Success Body Response

{
    "firefighters": [
        {
            "id": "99",
            "codigo": "1",
            "n_mecanografico": "1764363",
            "nome": "António Ferreira Peixoto",
            "foto": "https://preventech.pt/img/user_default_small.png",
            "cat_codigo": "CMDTE",
            "cat_designacao": "COMANDANTE",
            "cat_foto": "https://preventech.pt/img/categorias/comandante.png",
            "quadro_codigo": "QCOM",
            "quadro_designacao": "QUADRO COMANDO"
        },
        {
            "id": "93374",
            "codigo": "12345",
            "n_mecanografico": "12345",
            "nome": "Marina Santos",
            "foto": "https://preventech.pt/img/user_default_small.png",
            "cat_codigo": "ADCOM",
            "cat_designacao": "ADJUNTO DE COMANDO",
            "cat_foto": "https://preventech.pt/img/categorias/adjunto.png",
            "quadro_codigo": "QCOM",
            "quadro_designacao": "QUADRO COMANDO"
        },
        {
            "id": "19",
            "codigo": "002",
            "n_mecanografico": "123456",
            "nome": "Carlos Matos",
            "foto": "https://preventech.pt/img/user_default_small.png",
            "cat_codigo": "B2C",
            "cat_designacao": "BOMBEIRO 2º CLASSE",
            "cat_foto": "https://preventech.pt/img/categorias/bomb_2a.png",
            "quadro_codigo": "QACTI",
            "quadro_designacao": "QUADRO ACTIVO"
        }
    ]
}