ORordemenfermeiros
OEGest

Obtém a ficha do membro pelo codpesso para a aplicação OE Despesas.

Changed on

Autentica a conta mobapi com username e password enviados no corpo do pedido. A password é validada no SIGENF, pelo mesmo mecanismo usado em SendSMS. Não requer JWT. O codpesso é o identificador da pessoa no SIGENF, em formato UUID/GUID. Os campos numero_cc e validade_cc correspondem ao documento de identificação registado, independentemente do tipo (CC, BI, passaporte ou outro). Os seis campos são sempre devolvidos; dados em falta são representados por null.

Exemplo de pedido:

POST /api/OEGest/membro
Content-Type: application/json
        
{
  "username": "mobapi",
  "password": "palavra-passe-da-conta",
  "codpesso": "11111111-2222-3333-4444-555555555555"
}

Exemplo de resposta:

{
  "nome": "Maria Silva",
  "email": "maria.silva@example.com",
  "telemovel": "912345678",
  "nif": "123456789",
  "numero_cc": "01234567",
  "validade_cc": "2030-12-31"
}
post/api/OEGest/membro

Request

  • Base URL
    https://api.ordemenfermeiros.pt (the document declares no server; this is the origin it was published from)
  • URL
    https://api.ordemenfermeiros.pt/api/OEGest/membro
  • Auth
    none declared

Request body

usernamestring required

Conta técnica autorizada a consultar membros.

passwordstring password required

Password da conta técnica, validada no SIGENF.

codpessostring uuid required

GUID da pessoa guardado na OE Despesas.

Example request

{
  "username": "mobapi",
  "codpesso": "11111111-2222-3333-4444-555555555555"
}

Response

OK

nomestring nullable

Nome completo do membro.

emailstring nullable

Email pessoal do membro.

telemovelstring nullable

Telemóvel pessoal do membro.

nifstring nullable

Número de identificação fiscal, preservado como texto.

numero_ccstring nullable

Número do documento de identificação registado (CC, BI, passaporte ou outro). Corresponde a NRDOCID no SIGENF, independentemente do tipo de documento.

validade_ccstring date nullable

Validade do documento registado, no formato YYYY-MM-DD.

Example response

{
  "nome": "Maria Silva",
  "email": "maria.silva@example.com",
  "telemovel": "912345678",
  "nif": "123456789",
  "numero_cc": "01234567",
  "validade_cc": "2030-12-31"
}

Changes