HotlineReports APIs
-
Search Hotline Records
Description: Searchs through the hotline records for calls meeting the search criteriaUsage:
GET api/Hotlines/Reports/Search/{PhoneNumber}/{BeginDate}/{EndDate}/{RowIndex}/{PageSize}/{SortField}/{SortDir}/{SearchField}/{SearchCriteria}
Parameter Type Source Description PhoneNumber String FromUri The hotline phone number BeginDate String FromUri The date to start returning records from EndDate String FromUri The last date to return records from 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 The timestamp of the start of the call CallerID Phone number of the person who called the hotline DialedNumber The phone number (if any) that hotline dialed out and connected the caller to CallResult The result of the hotline call ResponseResult The digit response (if any) keyed by the caller 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 CallerID Phone number of the person who called the hotline DialedNumber The phone number (if any) that hotline dialed out and connected the caller to CallResult The result of the hotline call ResponseResult The digit response (if any) keyed by the caller SearchCriteria String FromUri The value to search for in the given field Returns:
Array of HotlineRecord objects
Examples:
//-- Currently no examples for XML --//