Scheduler APIs
-
Get Scheduled Alert Profile
Description: Gets the scheduled alert profile for the given schedulecodeUsage:
GET api/Alerts/Schedules/{ScheduleCode}
Parameter Type Source Description ScheduleCode Int32 FromUri Unique numerical code identifying the scheduled item Returns:
ScheduledAlert object
Examples:
<!-- Intent: get the scheduled alert profile for schedulecode 597737 GET to the following url http://api.v4.swiftreach.com/api/Alerts/Schedules/597737 --> <!-- No XML input is required --> <!-- example return value --> <ScheduledAlert xmlns:i="http://www.w3.org/2001/XMLSchema-instance" i:type="Schedule_Run_Once" xmlns="http://schemas.datacontract.org/2004/07/API.V4.DataWrappers"> <ChangeStamp>2013-04-02T10:40:55.4</ChangeStamp> <ChangedByUser></ChangedByUser> <ContactLists xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:int>668447</d2p1:int></ContactLists> <CreateStamp>2013-04-02T10:40:55.4</CreateStamp> <CreatedByUser>sample</CreatedByUser> <Description></Description> <EmailCode>0</EmailCode> <FaxCode>0</FaxCode> <HotlinePhone></HotlinePhone> <HotlineSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Hotline" i:nil="true" /> <IsActive>true</IsActive> <LastRunDate>0001-01-01T00:00:00</LastRunDate> <PagerCode>0</PagerCode> <SMSCode>660197</SMSCode> <ScheduleCode>597737</ScheduleCode> <ScheduleType>run_once</ScheduleType> <TaskDateTime>4/2/2015 12:00 PM</TaskDateTime> <TaskName>Example Scheduled Alert</TaskName> <VoiceCode>0</VoiceCode> </ScheduledAlert>