GET api/v1/Alert/{Email}/Summary/{AgencyId}

Request Information

URI Parameters

Name	Description	Type	Additional information
AgencyId		string	Required
Email		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of AlertSummaryDTO

Name	Type	Additional information
AlertID	string	None.
GoalID	string	None.
AgencyID	string	None.
UserID	string	None.
Type	string	None.
Icon	string	None.
Date	date	None.
Title	string	None.
Description	Collection of string	None.
IsRead	boolean	None.
IsHidden	boolean	None.
GoalData	AlertSummaryGoalData	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "2",
    "AlertID": "sample string 1",
    "GoalID": "sample string 2",
    "AgencyID": "sample string 3",
    "UserID": "sample string 4",
    "Type": "sample string 5",
    "Icon": "sample string 6",
    "Date": "2025-04-29T13:48:51.6701226-04:00",
    "Title": "sample string 8",
    "Description": {
      "$id": "3",
      "$values": [
        "sample string 1",
        "sample string 2"
      ]
    },
    "IsRead": true,
    "IsHidden": true,
    "GoalData": {
      "$id": "4",
      "ID": 1,
      "GoalID": "sample string 2",
      "AgencyDatabaseID": "sample string 3",
      "GoalType": "sample string 4",
      "CarrierCompany": "sample string 5",
      "GoalAmount": 1.0,
      "GoalStartDate": "2025-04-29T13:48:51.6701226-04:00",
      "GoalTargetDate": "2025-04-29T13:48:51.6701226-04:00",
      "GoalProgress": "sample string 6",
      "Active": true,
      "Deleted": true,
      "IsLatest": true,
      "CreatedBy": "sample string 7",
      "CreatedDateTime": "2025-04-29T13:48:51.6701226-04:00",
      "CurrentProgress": "sample string 9",
      "ExpectedProgress": "sample string 10"
    }
  },
  {
    "$ref": "2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAlertSummaryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RAIS.API.Models.MobileApp">
  <AlertSummaryDTO>
    <AgencyID>sample string 3</AgencyID>
    <AlertID>sample string 1</AlertID>
    <Date>2025-04-29T13:48:51.6701226-04:00</Date>
    <Description xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Description>
    <GoalData>
      <Active>true</Active>
      <AgencyDatabaseID>sample string 3</AgencyDatabaseID>
      <CarrierCompany>sample string 5</CarrierCompany>
      <CreatedBy>sample string 7</CreatedBy>
      <CreatedDateTime>2025-04-29T13:48:51.6701226-04:00</CreatedDateTime>
      <CurrentProgress>sample string 9</CurrentProgress>
      <Deleted>true</Deleted>
      <ExpectedProgress>sample string 10</ExpectedProgress>
      <GoalAmount>1</GoalAmount>
      <GoalID>sample string 2</GoalID>
      <GoalProgress>sample string 6</GoalProgress>
      <GoalStartDate>2025-04-29T13:48:51.6701226-04:00</GoalStartDate>
      <GoalTargetDate>2025-04-29T13:48:51.6701226-04:00</GoalTargetDate>
      <GoalType>sample string 4</GoalType>
      <ID>1</ID>
      <IsLatest>true</IsLatest>
    </GoalData>
    <GoalID>sample string 2</GoalID>
    <Icon>sample string 6</Icon>
    <IsHidden>true</IsHidden>
    <IsRead>true</IsRead>
    <Title>sample string 8</Title>
    <Type>sample string 5</Type>
    <UserID>sample string 4</UserID>
  </AlertSummaryDTO>
  <AlertSummaryDTO>
    <AgencyID>sample string 3</AgencyID>
    <AlertID>sample string 1</AlertID>
    <Date>2025-04-29T13:48:51.6701226-04:00</Date>
    <Description xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Description>
    <GoalData>
      <Active>true</Active>
      <AgencyDatabaseID>sample string 3</AgencyDatabaseID>
      <CarrierCompany>sample string 5</CarrierCompany>
      <CreatedBy>sample string 7</CreatedBy>
      <CreatedDateTime>2025-04-29T13:48:51.6701226-04:00</CreatedDateTime>
      <CurrentProgress>sample string 9</CurrentProgress>
      <Deleted>true</Deleted>
      <ExpectedProgress>sample string 10</ExpectedProgress>
      <GoalAmount>1</GoalAmount>
      <GoalID>sample string 2</GoalID>
      <GoalProgress>sample string 6</GoalProgress>
      <GoalStartDate>2025-04-29T13:48:51.6701226-04:00</GoalStartDate>
      <GoalTargetDate>2025-04-29T13:48:51.6701226-04:00</GoalTargetDate>
      <GoalType>sample string 4</GoalType>
      <ID>1</ID>
      <IsLatest>true</IsLatest>
    </GoalData>
    <GoalID>sample string 2</GoalID>
    <Icon>sample string 6</Icon>
    <IsHidden>true</IsHidden>
    <IsRead>true</IsRead>
    <Title>sample string 8</Title>
    <Type>sample string 5</Type>
    <UserID>sample string 4</UserID>
  </AlertSummaryDTO>
</ArrayOfAlertSummaryDTO>