API - Application Programming Interface

Documentação API Preventech


Sócios


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

URL

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

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.
Existem as seguintes opções : "memberList" ,"validateMember","validateMemberExternal"
memberList
id integer Sim* Identificador específico pelo qual pretende procurar um determinado sócio.


* Este parâmetro só se torna obrigatório , caso o method seja: "validateMember" ou "validateMemberExternal"
433022

Responses

200 SUCCESS
Listagem de sócios 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

{
    "members": [
        {
            "id": "1",
            "numero": "#1",
            "nome": "Carlos Eduardo Matos",
            "data_entrada": "",
            "tipo_socio": "Efectivo",
            "foto": "https://preventech.pt/img/user_default_small.png"
        },
        {
            "id": "433022",
            "numero": "S4",
            "nome": "Telmo Silva Leal",
            "data_entrada": "",
            "tipo_socio": "Fundador",
            "foto": "https://preventech.pt/img/user_default_small.png"
        },
        {
            "id": "1683355",
            "numero": "S9",
            "nome": "XPTO255255",
            "data_entrada": "22-12-2020",
            "tipo_socio": "Efectivo",
            "foto": "https://preventech.pt/img/user_default_small.png"
        }
    ]
}