Notification

getNotification

get

Get a notification by its NGUID.

Path parameters

nguidstringRequired

Notification GUID.

Responses

200

OK

application/json

404

Not Found

application/json

get

/notification/{nguid}

HTTPcURLJavaScriptPython

GET /gbds/v2/notification/{nguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

{
  "data": {
    "operation": "UNKNOWN",
    "tguid": "123e4567-e89b-12d3-a456-426614174000",
    "newTguid": "123e4567-e89b-12d3-a456-426614174000",
    "pguid": "123e4567-e89b-12d3-a456-426614174000",
    "enrollPguid": "123e4567-e89b-12d3-a456-426614174000",
    "status": "text",
    "sender": "text",
    "uguid": "123e4567-e89b-12d3-a456-426614174000",
    "treatment": "text",
    "update": true,
    "trusted": true,
    "origin": "API",
    "additionalData": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "relatedTransactions": [
      {
        "status": "text",
        "tguid": "text",
        "pguid": "text",
        "operation": "UNKNOWN"
      }
    ],
    "nguid": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": 1,
    "acks": [
      {
        "client": "text",
        "timestamp": 1,
        "comments": "text"
      }
    ]
  }
}

listNotifications

get

List notifications according to parameter filters.

Query parameters

startstring · dateOptional

Start date to filter notifications by timestamp. Format: yyyy-MM-dd-HH-mm-ss. (optional)

endstring · dateOptional

End date to filter notifications by timestamp. Format: yyyy-MM-dd-HH-mm-ss. (optional)

ackClientstringOptional

Return notifications that were acknowledged by this client. If it starts with !, returns all notifications that WERE NOT not acknowledged by this client. (optional)

tguidstringOptional

Filter notifications by TGUID. (optional)

newTguidstringOptional

Filter notifications by new TGUID, when it was edited during quality analysis. (optional)

pguidstringOptional

Filter notifications by PGUID. (optional)

enrollPguidstringOptional

Filter notifications by enroll PGUID, when an exception treatment is performed. (optional)

treatmentstringOptional

Filter notifications by exception treatment. (optional)

operationstring · enumOptional

Filter notifications by operation. (optional) This parameter can be provided more than once to form a list.

Possible values:

statusstringOptional

Filter notifications by status. (optional) This parameter can be provided more than once to form a list.

senderstringOptional

Filter notifications by sender. (optional)

uguidstringOptional

Filter notifications by UGUID (UL GUID). (optional)

additionalDatastringOptional

Filter notifications by additional data (any string inside of it). (optional)

pageIndexintegerOptional

Page index for pagination. Default: 0. (optional)

pageSizeintegerOptional

Page size for pagination. Default: 20. (optional)

Responses

200

OK

application/json

400

Bad Request

application/json

get

/notification

HTTPcURLJavaScriptPython

GET /gbds/v2/notification HTTP/1.1
Host: <ip>:8085
Accept: */*

{
  "data": [
    {
      "operation": "UNKNOWN",
      "tguid": "123e4567-e89b-12d3-a456-426614174000",
      "newTguid": "123e4567-e89b-12d3-a456-426614174000",
      "pguid": "123e4567-e89b-12d3-a456-426614174000",
      "enrollPguid": "123e4567-e89b-12d3-a456-426614174000",
      "status": "text",
      "sender": "text",
      "uguid": "123e4567-e89b-12d3-a456-426614174000",
      "treatment": "text",
      "update": true,
      "trusted": true,
      "origin": "API",
      "additionalData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "relatedTransactions": [
        {
          "status": "text",
          "tguid": "text",
          "pguid": "text",
          "operation": "UNKNOWN"
        }
      ],
      "nguid": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "acks": [
        {
          "client": "text",
          "timestamp": 1,
          "comments": "text"
        }
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "count": 1,
    "pageSize": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

getFinalNotificationByPguid

get

Get the last notification with a final enroll status for a PGUID. Using the provided PGUID, this method will search for all notifications with operation ENROLL or DELETE and will return the last enroll notification. It may be: - Delete notification for PGUID - Last enrolled notification - Last enroll exception notification (not update) - Last pending enroll notification (not update)

Path parameters

pguidstringRequired

Person GUID.

Responses

200

OK

application/json

get

/notification/final/{pguid}

HTTPcURLJavaScriptPython

GET /gbds/v2/notification/final/{pguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{
  "data": {
    "operation": "UNKNOWN",
    "tguid": "123e4567-e89b-12d3-a456-426614174000",
    "newTguid": "123e4567-e89b-12d3-a456-426614174000",
    "pguid": "123e4567-e89b-12d3-a456-426614174000",
    "enrollPguid": "123e4567-e89b-12d3-a456-426614174000",
    "status": "text",
    "sender": "text",
    "uguid": "123e4567-e89b-12d3-a456-426614174000",
    "treatment": "text",
    "update": true,
    "trusted": true,
    "origin": "API",
    "additionalData": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "relatedTransactions": [
      {
        "status": "text",
        "tguid": "text",
        "pguid": "text",
        "operation": "UNKNOWN"
      }
    ],
    "nguid": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": 1,
    "acks": [
      {
        "client": "text",
        "timestamp": 1,
        "comments": "text"
      }
    ]
  }
}

getFinalNotificationByTguid

get

Get the last notification with a final enroll status for a PGUID related to a TGUID. Using the provided TGUID, this method will get a PGUID related to it and then search for all notifications with operation ENROLL or DELETE. Then, it will return the last enroll notification. It may be: - Delete notification for PGUID - Last enrolled notification - Last enroll exception notification (not update) - Last pending enroll notification (not update)

Path parameters

tguidstringRequired

Transaction GUID.

Responses

200

OK

application/json

get

/notification/final/tguid/{tguid}

HTTPcURLJavaScriptPython

GET /gbds/v2/notification/final/tguid/{tguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{
  "data": {
    "operation": "UNKNOWN",
    "tguid": "123e4567-e89b-12d3-a456-426614174000",
    "newTguid": "123e4567-e89b-12d3-a456-426614174000",
    "pguid": "123e4567-e89b-12d3-a456-426614174000",
    "enrollPguid": "123e4567-e89b-12d3-a456-426614174000",
    "status": "text",
    "sender": "text",
    "uguid": "123e4567-e89b-12d3-a456-426614174000",
    "treatment": "text",
    "update": true,
    "trusted": true,
    "origin": "API",
    "additionalData": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "relatedTransactions": [
      {
        "status": "text",
        "tguid": "text",
        "pguid": "text",
        "operation": "UNKNOWN"
      }
    ],
    "nguid": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": 1,
    "acks": [
      {
        "client": "text",
        "timestamp": 1,
        "comments": "text"
      }
    ]
  }
}

trackNotificationsByPguid

get

Get all notifications related to a PGUID. Using the provided PGUID, this method will return all notifications for the PGUID and associated to it by TGUID, PGUID, newTguid, and enrollPguid.

Path parameters

pguidstringRequired

Person GUID.

Responses

200

OK

application/json

get

/notification/trackPguid/{pguid}

HTTPcURLJavaScriptPython

GET /gbds/v2/notification/trackPguid/{pguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{
  "data": [
    {
      "operation": "UNKNOWN",
      "tguid": "123e4567-e89b-12d3-a456-426614174000",
      "newTguid": "123e4567-e89b-12d3-a456-426614174000",
      "pguid": "123e4567-e89b-12d3-a456-426614174000",
      "enrollPguid": "123e4567-e89b-12d3-a456-426614174000",
      "status": "text",
      "sender": "text",
      "uguid": "123e4567-e89b-12d3-a456-426614174000",
      "treatment": "text",
      "update": true,
      "trusted": true,
      "origin": "API",
      "additionalData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "relatedTransactions": [
        {
          "status": "text",
          "tguid": "text",
          "pguid": "text",
          "operation": "UNKNOWN"
        }
      ],
      "nguid": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "acks": [
        {
          "client": "text",
          "timestamp": 1,
          "comments": "text"
        }
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "count": 1,
    "pageSize": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

trackNotificationsByTguid

get

Get all notifications related to a TGUID. Using the provided TGUID, this method will return all notifications for the TGUID and associated to it by PGUID, newTguid, and enrollPguid.

Path parameters

tguidstringRequired

Transaction GUID.

Responses

200

OK

application/json

get

/notification/trackTguid/{tguid}

HTTPcURLJavaScriptPython

GET /gbds/v2/notification/trackTguid/{tguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{
  "data": [
    {
      "operation": "UNKNOWN",
      "tguid": "123e4567-e89b-12d3-a456-426614174000",
      "newTguid": "123e4567-e89b-12d3-a456-426614174000",
      "pguid": "123e4567-e89b-12d3-a456-426614174000",
      "enrollPguid": "123e4567-e89b-12d3-a456-426614174000",
      "status": "text",
      "sender": "text",
      "uguid": "123e4567-e89b-12d3-a456-426614174000",
      "treatment": "text",
      "update": true,
      "trusted": true,
      "origin": "API",
      "additionalData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "relatedTransactions": [
        {
          "status": "text",
          "tguid": "text",
          "pguid": "text",
          "operation": "UNKNOWN"
        }
      ],
      "nguid": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "acks": [
        {
          "client": "text",
          "timestamp": 1,
          "comments": "text"
        }
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "count": 1,
    "pageSize": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

acknowledgeNotification

put

Acknowledge a notification, indicating that the client has processed it. This endpoint can be called even if the notification is already acknowledged. The notification will store the timestamp of acknowledgment and its comments.

Body

application/json

nguidstring · uuidOptional

Notification GUID.

clientstringOptional

Name of the client that is acknowledging the notification. Example: ETR, BEST.

commentsstringOptional

Comments from the client about the notification. (optional)

Responses

200

OK

404

Not Found

application/json

put

/notification/ack

HTTPcURLJavaScriptPython

PUT /gbds/v2/notification/ack HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "nguid": "123e4567-e89b-12d3-a456-426614174000",
  "client": "text",
  "comments": "text"
}

No content

acknowledgeNotificationByTguid

put

Acknowledge all notifications related to a TGUID, indicating that the client has processed them. This endpoint can be called even if the notifications are already acknowledged. The notifications will store the timestamp of acknowledgment and the same comments.

Body

application/json

tguidstring · uuidOptional

Notification GUID.

clientstringOptional

Name of the client that is acknowledging the notification. Example: ETR, BEST.

commentsstringOptional

Comments from the client about the notification. (optional)

Responses

200

OK

application/json

404

Not Found

application/json

put

/notification/ack/tguid

HTTPcURLJavaScriptPython

PUT /gbds/v2/notification/ack/tguid HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "tguid": "123e4567-e89b-12d3-a456-426614174000",
  "client": "text",
  "comments": "text"
}

{
  "data": [
    {
      "operation": "UNKNOWN",
      "tguid": "123e4567-e89b-12d3-a456-426614174000",
      "newTguid": "123e4567-e89b-12d3-a456-426614174000",
      "pguid": "123e4567-e89b-12d3-a456-426614174000",
      "enrollPguid": "123e4567-e89b-12d3-a456-426614174000",
      "status": "text",
      "sender": "text",
      "uguid": "123e4567-e89b-12d3-a456-426614174000",
      "treatment": "text",
      "update": true,
      "trusted": true,
      "origin": "API",
      "additionalData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "relatedTransactions": [
        {
          "status": "text",
          "tguid": "text",
          "pguid": "text",
          "operation": "UNKNOWN"
        }
      ],
      "nguid": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": 1,
      "acks": [
        {
          "client": "text",
          "timestamp": 1,
          "comments": "text"
        }
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "count": 1,
    "pageSize": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}