FaxReports APIs
-
Count Fax Records Search Results
Description: Gets the total number of records for the given job using the search criteriaUsage:
GET api/Alerts/Reports/Fax/search/Count/{JobCode}/{SearchField}/{SearchCriteria}
Parameter Type Source Description JobCode Int32 FromUri the unique numerical code identifying the job to get records for SearchField String FromUri The field to search for criteria in Value Description Phone Phone number dialed EntityName Name of the called entity EntityGuid Guid uniquely identifying called entity CallResult result of the call CauseCode Cause code for terminating the call CompletePlayback True if message played in its entirety SearchCriteria String FromUri The value to search for in the given field Returns:
Returns the total number of records for the given job
Examples:
<!-- Intent: retrieve the count of records for the fax alerts sent for job 1546907 that contain an EntityName like "Sample". GET to the following url http://api.v4.swiftreach.com/api/Alerts/Reports/Fax/Search/Count/1546907/EntityName/Sample --> <!-- No XML input is required --> <!-- example return value --> <int>1</int>
-
List Fax Records
Description: Returns a paged set of records for the given jobUsage:
GET api/Alerts/Reports/Fax/{JobCode}/{RowIndex}/{PageSize}
Parameter Type Source Description JobCode Int32 FromUri the unique numerical code identifying the job to get records for RowIndex Int32 FromUri the starting row index for the page to get records from. The first row starts with 0. PageSize Int32 FromUri the total number of records to return in a page Returns:
Array of CallRecord objects
Examples:
<!-- Intent: retrieve the records for the fax alerts sent for job 1546907. This will retrieve the 1st page of 5 records. GET to the following url http://api.v4.swiftreach.com/api/Alerts/Reports/Fax/1546907/0/5 --> <!-- No XML input is required --> <!-- example return value --> <ArrayOfCallRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Reports.Voice"> <CallRecord> <Address1/> <City/> <County/> <EntityGuid>cad50a1d-f0bf-45d7-992f-787b22fadf6d</EntityGuid> <EntityName>sample</EntityName> <Latitude>0</Latitude> <Longitude>0</Longitude> <PostalCode/> <StateProv/> <BeginStamp>3/5/2013 11:02:49 AM</BeginStamp> <CallResult>call_answered</CallResult> <CallType>0</CallType> <CauseCode>0</CauseCode> <CompletePlayback>true</CompletePlayback> <ConnectStamp>3/5/2013 11:02:53 AM</ConnectStamp> <CustomerCode>200201</CustomerCode> <DetectedAnsweringMachine>false</DetectedAnsweringMachine> <Digits/> <EndStamp>3/5/2013 11:03:19 AM</EndStamp> <HasFeedback>false</HasFeedback> <JobCode>1546907</JobCode> <Language>English</Language> <ListCode>0</ListCode> <OutboundMinutes>1</OutboundMinutes> <Phone>2012361222</Phone> <PhoneIndex>0</PhoneIndex> <PinValidated>false</PinValidated> <ReplayCount>0</ReplayCount> <ResponseRequired>false</ResponseRequired> <ResponseResult>-1</ResponseResult> <RetryCount>0</RetryCount> <UserInput i:nil="true"/> </CallRecord> </ArrayOfCallRecord>
-
List Fax Records
Description: Returns a paged set of records for the given job sorted as specifiedUsage:
GET api/Alerts/Reports/Fax/{JobCode}/{RowIndex}/{PageSize}/{SortField}/{SortDir}
Parameter Type Source Description JobCode Int32 FromUri the unique numerical code identifying the job to get records for RowIndex Int32 FromUri the starting row index for the page to get records from. The first row starts with 0. PageSize Int32 FromUri the total number of records to return in a page SortField String FromUri The field to sort the results by Value Description BeginStamp Time the call started Phone Phone number dialed EntityName Name of the called entity EntityGuid Guid uniquely identifying called entity CallResult result of the call CauseCode Cause code for terminating the call CompletePlayback True if message played in its entirety SortDir String FromUri The direction to sort the results Value Description ASC Sort in ascending order DESC Sort in descending order Returns:
Array of CallRecord objects
Examples:
<!-- Intent: retrieve the records for the fax alerts sent for job 1546907. This will retrieve the 1st page of 5 records sorted by BeginStamp in an Ascending direction. GET to the following url http://api.v4.swiftreach.com/api/Alerts/Reports/Fax/1546907/0/5/BeginStamp/ASC --> <!-- No XML input is required --> <!-- example return value --> <ArrayOfCallRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Reports.Voice"> <CallRecord> <Address1/> <City/> <County/> <EntityGuid>cad50a1d-f0bf-45d7-992f-787b22fadf6d</EntityGuid> <EntityName>sample</EntityName> <Latitude>0</Latitude> <Longitude>0</Longitude> <PostalCode/> <StateProv/> <BeginStamp>3/5/2013 11:02:49 AM</BeginStamp> <CallResult>call_answered</CallResult> <CallType>0</CallType> <CauseCode>0</CauseCode> <CompletePlayback>true</CompletePlayback> <ConnectStamp>3/5/2013 11:02:53 AM</ConnectStamp> <CustomerCode>200201</CustomerCode> <DetectedAnsweringMachine>false</DetectedAnsweringMachine> <Digits/> <EndStamp>3/5/2013 11:03:19 AM</EndStamp> <HasFeedback>false</HasFeedback> <JobCode>1546907</JobCode> <Language>English</Language> <ListCode>0</ListCode> <OutboundMinutes>1</OutboundMinutes> <Phone>2012361222</Phone> <PhoneIndex>0</PhoneIndex> <PinValidated>false</PinValidated> <ReplayCount>0</ReplayCount> <ResponseRequired>false</ResponseRequired> <ResponseResult>-1</ResponseResult> <RetryCount>0</RetryCount> <UserInput i:nil="true"/> </CallRecord> </ArrayOfCallRecord>
-
Search Fax Records
Description: Returns a paged set of records for the given job sorted as specified and filtered by the search criteriaUsage:
GET api/Alerts/Reports/Fax/Search/{JobCode}/{RowIndex}/{PageSize}/{SortField}/{SortDir}/{SearchField}/{SearchCriteria}
Parameter Type Source Description JobCode Int32 FromUri the unique numerical code identifying the job to get records for RowIndex Int32 FromUri the starting row index for the page to get records from. The first row starts with 0. PageSize Int32 FromUri the total number of records to return in a page SortField String FromUri The field to sort the results by Value Description BeginStamp Time the call started Phone Phone number dialed EntityName Name of the called entity EntityGuid Guid uniquely identifying called entity CallResult result of the call CauseCode Cause code for terminating the call CompletePlayback True if message played in its entirety SortDir String FromUri The direction to sort the results Value Description ASC Sort in ascending order DESC Sort in descending order SearchField String FromUri The field to search for criteria in Value Description Phone Phone number dialed EntityName Name of the called entity EntityGuid Guid uniquely identifying called entity CallResult result of the call CauseCode Cause code for terminating the call CompletePlayback True if message played in its entirety SearchCriteria String FromUri The value to search for in the given field Returns:
Array of CallRecord objects
Examples:
<!-- Intent: search the records for the fax alerts sent for job 1546907 to any EntityName that contains the text "Sample". This will retrieve the 1st page of 5 records sorted by TimeStamp in an Ascending direction. GET to the following url http://api.v4.swiftreach.com/api/Alerts/Reports/Fax/Search/1546907/0/5/BeginStamp/ASC/EntityName/Sample --> <!-- No XML input is required --> <!-- example return value --> <ArrayOfCallRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Reports.Voice"> <CallRecord> <Address1/> <City/> <County/> <EntityGuid>cad50a1d-f0bf-45d7-992f-787b22fadf6d</EntityGuid> <EntityName>sample</EntityName> <Latitude>0</Latitude> <Longitude>0</Longitude> <PostalCode/> <StateProv/> <BeginStamp>3/5/2013 11:02:49 AM</BeginStamp> <CallResult>call_answered</CallResult> <CallType>0</CallType> <CauseCode>0</CauseCode> <CompletePlayback>true</CompletePlayback> <ConnectStamp>3/5/2013 11:02:53 AM</ConnectStamp> <CustomerCode>200201</CustomerCode> <DetectedAnsweringMachine>false</DetectedAnsweringMachine> <Digits/> <EndStamp>3/5/2013 11:03:19 AM</EndStamp> <HasFeedback>false</HasFeedback> <JobCode>1546907</JobCode> <Language>English</Language> <ListCode>0</ListCode> <OutboundMinutes>1</OutboundMinutes> <Phone>2012361222</Phone> <PhoneIndex>0</PhoneIndex> <PinValidated>false</PinValidated> <ReplayCount>0</ReplayCount> <ResponseRequired>false</ResponseRequired> <ResponseResult>-1</ResponseResult> <RetryCount>0</RetryCount> <UserInput i:nil="true"/> </CallRecord> </ArrayOfCallRecord>
-
Count Fax Records
Description: Gets the total number of records for the given jobUsage:
GET api/Alerts/Reports/Fax/Count/{JobCode}
Parameter Type Source Description JobCode Int32 FromUri the unique numerical code identifying the job to get records for Returns:
Returns the total number of records for the given job
Examples:
<!-- Intent: retrieve the count of records for the fax alerts sent for job 1546907. GET to the following url http://api.v4.swiftreach.com/api/Alerts/Reports/Fax/Count/1546907 --> <!-- No XML input is required --> <!-- example return value --> <int>1</int>
-
Download Fax Records
Description: Downloads a zipped comma-delimited CSV file of the raw recordsUsage:
GET api/Alerts/Reports/Fax/Download/{JobCode}
Parameter Type Source Description JobCode Int32 FromUri the unique numerical code identifying the job to get records for Returns:
Zipped File Content
Examples:
<!-- Intent: Initiates a downbload of the raw records for the fax alerts sent for job 1546907. The records are returned in a zip compressed CSV file. GET to the following url http://api.v4.swiftreach.com/api/Alerts/Reports/Fax/Download/1546907 --> <!-- No XML input is required --> <!-- example return value --> <!-- return value is a binary file -->