GET v2/alerts?DateFrom={DateFrom}&DateTo={DateTo}&CustomerID={CustomerID}&Account={Account}&PayerID={PayerID}&ClaimID={ClaimID}&ShowCompleted={ShowCompleted}

Returns All Claim Alerts

Request Information

URI Parameters

NameDescriptionTypeAdditional information
DateFrom

Alerts Generated From Date

 string

Required
DateTo

Alerts Generated To Date

 string

Required
CustomerID

Provide the customer ID if you are a Trading Partner and would like to filter for a specific customer, otherwise all Customers for your trading partner ID will be returned

 integer

None.
Account

Account

 string

None.
PayerID

Payer ID

 string

None.
ClaimID

Internal ClaimID

 integer

None.
ShowCompleted

When set to true, all alerts that fall into the query range will be returned even if they have been marked as completed.

 boolean

None.

Body Parameters

None.

Response Information

Resource Description

Returns All Claim Alerts for all Alert Types

Collection of Alert
NameDescriptionTypeAdditional information
AlertTypeID

The alert type id.

 AlertType

None.
AlertTypeTitle

The name of the alert type

 string

None.
TimeStamp

The timestamp of when the alerts were requested

 string

None.
ClaimCount

The count of claims in this alert type

 integer

None.
Alerts

Contains all alerts for a given alert type

 Collection of Alerts

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "AlertTypeID": 1,
    "AlertTypeTitle": "sample string 1",
    "TimeStamp": "sample string 2",
    "ClaimCount": 3,
    "Alerts": [
      {
        "AlertID": 1,
        "CustomerName": "sample string 2",
        "AccountNumber": "sample string 3",
        "PayerID": "sample string 4",
        "ActionDays": 5,
        "Threshold": 6,
        "AlertText": "sample string 7",
        "AlertResult": {
          "ResponseType": 1,
          "Response": "sample string 1"
        },
        "AlertDate": "sample string 8",
        "Completed": true
      },
      {
        "AlertID": 1,
        "CustomerName": "sample string 2",
        "AccountNumber": "sample string 3",
        "PayerID": "sample string 4",
        "ActionDays": 5,
        "Threshold": 6,
        "AlertText": "sample string 7",
        "AlertResult": {
          "ResponseType": 1,
          "Response": "sample string 1"
        },
        "AlertDate": "sample string 8",
        "Completed": true
      }
    ]
  },
  {
    "AlertTypeID": 1,
    "AlertTypeTitle": "sample string 1",
    "TimeStamp": "sample string 2",
    "ClaimCount": 3,
    "Alerts": [
      {
        "AlertID": 1,
        "CustomerName": "sample string 2",
        "AccountNumber": "sample string 3",
        "PayerID": "sample string 4",
        "ActionDays": 5,
        "Threshold": 6,
        "AlertText": "sample string 7",
        "AlertResult": {
          "ResponseType": 1,
          "Response": "sample string 1"
        },
        "AlertDate": "sample string 8",
        "Completed": true
      },
      {
        "AlertID": 1,
        "CustomerName": "sample string 2",
        "AccountNumber": "sample string 3",
        "PayerID": "sample string 4",
        "ActionDays": 5,
        "Threshold": 6,
        "AlertText": "sample string 7",
        "AlertResult": {
          "ResponseType": 1,
          "Response": "sample string 1"
        },
        "AlertDate": "sample string 8",
        "Completed": true
      }
    ]
  }
]