Alerts APIs
-
List Alert Campaigns
Description: Returns a page from the list of jobs that ran within the given datesUsage:
GET api/Alerts/List/{BeginDate}/{EndDate}/{PageSize}/{PageIndex}
Parameter Type Source Description BeginDate String FromUri The starting date of the period to look in. Must be in the format of MM-DD-YYYY. EndDate String FromUri The ending date of the period to look in. Must be in the format of MM-DD-YYYY. PageSize Int32 FromUri The total number of items to return in a page PageIndex Int32 FromUri The current page to return Returns:
Array of AlertProfile objects
Examples:
<!-- Intent: retrieve a list of alerting campaigns between the given dates of 12/1/2012 and 12/31/2012. This will return the first set of 5 results. (Page 1 with 5 rows per page) GET to the following url http://api.v4.swiftreach.com/api/Alerts/List/12-1-2012/12-31-2012/5/1 --> <!-- No XML input is required --> <!-- example return values --> <ArrayOfAlertProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.V4.DataWrappers"> <AlertProfile> <BeginStamp>12/1/2012 10:54:39 PM</BeginStamp> <CompanyCode>200201</CompanyCode> <ContactLists xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.ContactLists"> <d3p1:ContactList> <d3p1:ChangeStamp>2012-08-01T15:21:12.653</d3p1:ChangeStamp> <d3p1:ChangedByUser>sample</d3p1:ChangedByUser> <d3p1:CreateStamp>2012-08-01T14:47:57.38</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Bob's Personal Contact Information</d3p1:Description> <d3p1:ExposeHomePortal>false</d3p1:ExposeHomePortal> <d3p1:ExposeVisitorPortal>false</d3p1:ExposeVisitorPortal> <d3p1:ListCode>668027</d3p1:ListCode> <d3p1:ListName>Bob's Contact List</d3p1:ListName> <d3p1:ListSize>1</d3p1:ListSize> <d3p1:ListType>List</d3p1:ListType> <d3p1:PendingApprovalCount>0</d3p1:PendingApprovalCount> <d3p1:SubscriptionRequiresApproval>false</d3p1:SubscriptionRequiresApproval> </d3p1:ContactList> </ContactLists> <EmailObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Email"/> <EndStamp>12/1/2012 10:54:59 PM</EndStamp> <FaxObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> <JobCode>1541867</JobCode> <JobState>job_completed</JobState> <PagerObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Pager"/> <SMSObject xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.SMS"> <d3p1:Body> <d3p1:SMS_Content> <d3p1:Body> <d3p1:SMS_TEXT_SOURCE i:type="d3p1:SMS_TEXT_SOURCE_TEXT"> <d3p1:TextType>sms_text_source_text</d3p1:TextType> <d3p1:Text>Dense Fog Advisory for Atlantic; Atlantic Coastal Cape May; Camden; Cape May; Coastal Atlantic; Coast...More: http://tinyurl.com/cbjbo3d</d3p1:Text> </d3p1:SMS_TEXT_SOURCE> </d3p1:Body> <d3p1:SpokenLanguage>English</d3p1:SpokenLanguage> <d3p1:Subject>Middlesex County Weather Alerts</d3p1:Subject> </d3p1:SMS_Content> </d3p1:Body> <d3p1:ChangeStamp>2012-12-01T22:54:35.443</d3p1:ChangeStamp> <d3p1:ChangedByUser/> <d3p1:CreateStamp>2012-12-01T22:54:35.443</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DefaultSpokenLanguage>English</d3p1:DefaultSpokenLanguage> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Weather Alert</d3p1:Description> <d3p1:FromAddress/> <d3p1:FromName>S911V4</d3p1:FromName> <d3p1:LastUsed>0001-01-01T00:00:00</d3p1:LastUsed> <d3p1:Name>Bob's Weather Alert</d3p1:Name> <d3p1:ReplyConfirmation/> <d3p1:ReplyCriteria/> <d3p1:ReplyType>None</d3p1:ReplyType> <d3p1:ReplyWindow>15</d3p1:ReplyWindow> <d3p1:SMSCode>653047</d3p1:SMSCode> <d3p1:Visibility>Temporary</d3p1:Visibility> </SMSObject> <TaskName>Bob's Weather Alert</TaskName> <Username>sample</Username> <VoiceObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> </AlertProfile> <AlertProfile> <BeginStamp>12/2/2012 3:28:44 AM</BeginStamp> <CompanyCode>200201</CompanyCode> <ContactLists xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.ContactLists"> <d3p1:ContactList> <d3p1:ChangeStamp>2012-08-01T15:21:12.653</d3p1:ChangeStamp> <d3p1:ChangedByUser>sample</d3p1:ChangedByUser> <d3p1:CreateStamp>2012-08-01T14:47:57.38</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Bob's Personal Contact Information</d3p1:Description> <d3p1:ExposeHomePortal>false</d3p1:ExposeHomePortal> <d3p1:ExposeVisitorPortal>false</d3p1:ExposeVisitorPortal> <d3p1:ListCode>668027</d3p1:ListCode> <d3p1:ListName>Bob's Contact List</d3p1:ListName> <d3p1:ListSize>1</d3p1:ListSize> <d3p1:ListType>List</d3p1:ListType> <d3p1:PendingApprovalCount>0</d3p1:PendingApprovalCount> <d3p1:SubscriptionRequiresApproval>false</d3p1:SubscriptionRequiresApproval> </d3p1:ContactList> </ContactLists> <EmailObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Email"/> <EndStamp>12/2/2012 3:29:04 AM</EndStamp> <FaxObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> <JobCode>1541897</JobCode> <JobState>job_completed</JobState> <PagerObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Pager"/> <SMSObject xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.SMS"> <d3p1:Body> <d3p1:SMS_Content> <d3p1:Body> <d3p1:SMS_TEXT_SOURCE i:type="d3p1:SMS_TEXT_SOURCE_TEXT"> <d3p1:TextType>sms_text_source_text</d3p1:TextType> <d3p1:Text>Dense Fog Advisory for Atlantic; Atlantic Coastal Cape May; Camden; Cape May; Coastal Atlantic; Coast...More: http://tinyurl.com/cbc9yjt</d3p1:Text> </d3p1:SMS_TEXT_SOURCE> </d3p1:Body> <d3p1:SpokenLanguage>English</d3p1:SpokenLanguage> <d3p1:Subject>Middlesex County Weather Alerts</d3p1:Subject> </d3p1:SMS_Content> </d3p1:Body> <d3p1:ChangeStamp>2012-12-02T03:28:42.367</d3p1:ChangeStamp> <d3p1:ChangedByUser/> <d3p1:CreateStamp>2012-12-02T03:28:42.367</d3p1:CreateStamp> <d3p1:CreatedByUser>sample</d3p1:CreatedByUser> <d3p1:DefaultSpokenLanguage>English</d3p1:DefaultSpokenLanguage> <d3p1:DeleteLocked>false</d3p1:DeleteLocked> <d3p1:Description>Weather Alert</d3p1:Description> <d3p1:FromAddress/> <d3p1:FromName>S911V4</d3p1:FromName> <d3p1:LastUsed>0001-01-01T00:00:00</d3p1:LastUsed> <d3p1:Name>Bob's Weather Alert</d3p1:Name> <d3p1:ReplyConfirmation/> <d3p1:ReplyCriteria/> <d3p1:ReplyType>None</d3p1:ReplyType> <d3p1:ReplyWindow>15</d3p1:ReplyWindow> <d3p1:SMSCode>653077</d3p1:SMSCode> <d3p1:Visibility>Temporary</d3p1:Visibility> </SMSObject> <TaskName>Bob's Weather Alert</TaskName> <Username>sample</Username> <VoiceObject i:nil="true" xmlns:d3p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"/> </AlertProfile> </ArrayOfAlertProfile>