API - Application Programming Interface

Documentação API Preventech


Veículos


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

URL

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

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. vehiclesList
id integer Identificador específico pelo qual pretende procurar um determinado veículo. 19015

Responses

200 SUCCESS
Listagem de veículos 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

{
    "vehicles": [
        {
            "id": "19015",
            "estado": "em_reparacao",
            "matricula": "23-SA-23",
            "codigo_tipo_viatura": "ABTD",
            "descricao": "ABCDV1",
            "marca": "FORD",
            "modelo": "TRANSIT",
            "kilometros_actuais": "0",
            "cor_viatura": "#FFFFFF",
            "combustivel": "GASÓLEO",
            "lotacao": "",
            "fornecedor": "",
            "data_registo": "05-06-2023",
            "data_abate": "",
            "foto": "https://preventech.pt/img/viatura_default_small.png"
        },
        {
            "id": "77",
            "estado": "em_reparacao",
            "matricula": "82-HA-89",
            "codigo_tipo_viatura": "ABCI",
            "descricao": "ABCI01",
            "marca": "Mercedes",
            "modelo": "Sprinter 316CDI/35",
            "kilometros_actuais": "174230",
            "cor_viatura": "#3F38FF",
            "combustivel": "",
            "lotacao": "",
            "fornecedor": "",
            "data_registo": "19-02-2015",
            "data_abate": "",
            "foto": "https://preventech.pt/img/viatura_default_small.png"
        },
        {
            "id": "63",
            "estado": "activo",
            "matricula": "13-23-NN",
            "codigo_tipo_viatura": "VTTU",
            "descricao": "VTTU01",
            "marca": "VOLVO",
            "modelo": "FL 615-37 KH",
            "kilometros_actuais": "9",
            "cor_viatura": "#ffffff",
            "combustivel": "",
            "lotacao": "",
            "fornecedor": "",
            "data_registo": "27-09-2022",
            "data_abate": "",
            "foto": "https://preventech.pt/img/viatura_default_small.png"
        }
    ]
}