Mensagens do aplicativo OnyxERP® - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki

GET /v1/person/messages/{offset}/{limit}/

Lista de forma pagina todas as mensagens vinculadas ao pf_id do token, ordenando da seguinte forma: não lidas primeiro e depois por data/hora em order decrescente.

1. Verificar na collection Messages todos os documentos vinculados ao usuário na sua entidade selecionada, conforme os dados do token.

   Caso nenhum documento seja localizado, retornar status-code 404;

2. Listar os dados conforme o exemplo abaixo.

Header:

Authorization: Bearer {JWT} //token de usuário externo

Resposta

{
  "success": true,
  "data": {
    "SocialAPI": [
      {
        "message_id": "{snowflake-id}",
        "pf_id": "5405255321377019675",
        "oid": "{snowflake-id}",
        "oeid": "{snowflake-id}",
        "type": "PERICIA_MEDICA",
        "title": "Boas vindas!",
        "body": "Olá, seja bem-vindo ao App OnyxERP® ;)",
        "read": false,
        "uupfid": "{snowflake-id}",
        "data_hora": "YYYY-MM-DD HH:mm:ss"
      }
    ]
  }
}

200 | 404

PATCH /v1/person/messages/

Marca uma ou várias mensagens como lidas de acordo com os dados do usuário do token e o payload.

1. Verificar na collection Messages se todas as message_ids informados no payload estão vinculados ao pf_id e na mesma entidade(oid + oeid) de acordo com o token.

   Caso nenhum documento seja localizado, retornar status-code 404;

2. Marcar todos os documentos localizados no passo 1 como lidos(read = true).

Header:

Authorization: Bearer {JWT} //token de usuário externo

Resposta

{
  "success": true,
  "data": {
    "SocialAPI": [
      "{message_id}",
      "{message_id}",
      "{message_id}"
    ]
  }
}

200 | 404