Listar atividades

Retorna a lista de atividades de uma entidade por id de entidade ou número de contribuinte.

GET https://segurosapi.libax.com/v1/{token}/EntityHistories
Obter uma lista com os filtros definidos

GET https://segurosapi.libax.com/v1/{token}/EntityHistoriesCount
Obter quantos registos é possível obter com os filtros definidos. Skip e Take são ignorados.

Permissão requerida: leitura

Parâmetro   Descrição
EntityID int Id da entidade que pretende obter informação.
VatNumber string Número de contribuinte da entidade que pretende obter informação.
AssignedToUserID int Id do user responsável pela realização da atividade.
HistoryID int Id da atividade que pretende consultar. Pode enviar vários separados por virgula.
Subject string Assunto da atividade que pretende obter informação (por aproximação).
FromDate datetime Data da atividade a partir da qual pretende obter a lista.
ToDate datetime Data de atividade até à qual pretende obter a lista.
Status int Situação da atividade (enum History.Status) que pretende obter a lista.
Skip int Número de registos que pretende ignorar. Normalmente defina o número de registo que já obteve.
Take int Número de registos a obter. Entre 1 e 50. Se não enviado será assumido 50

Respostas

HTTP: 200

            [
                {
                    "EntityID": int,
                    "HistoryID": int,
                    "HistoryDate": datetime,
                    "Subject": string,
                    "ContactType": int,
                    "Details": string|null,
                    "AssignedToUser": {
                        "Name": string,
                        "NickName": string|null,
                        "Email": string
                    },
                    "Status": int,
                    "StatusComment": string|null,
                    "RelativeTo": {
                        "Context": int,
                        "Code": int
                    }|null
                },
                ...
            ]
        

Notas:

  • RelativeTo.Context - identifica se é uma apólice ou participação que está relacionada. Ver enumerações
  • RelativeTo.Code - id da apólice ou participação associada
HTTP: 200

            int