ReportSavedReports
Schema to enable the user to deal with 'saved' reports which are created using methods
0310,
0320 and
0340 with an active 'SavedReport' element.
Only relative date-ranges are permitted: e.g. Today; Last Month or Recent 5 days.
Methods exist both to retrieve information on the type of report required and to delete a user's saved reports.
Retrieved information may be used by a client application to construct a further XML request to obtain the actual report results.
Note that at present it is not possible to simply re-run a report using the 'SavedReportID' value.
The 'UserID' and 'Password' elements identify the account.
The 'ServiceName' element must be set to 'ReportSavedReports'.
The 'SoftwareVersion' element is for internal 2SMS use only and should not be set.
The 'ServiceDetail' element should contain one of the following:
- An empty 'RetrieveSavedReports' child to obtain information on all of a user's saved reports.
- A 'DeleteSavedReports' child element with a set of 'SavedReportID' child elements containing the IDs of the reports to be removed.
These will have been obtained with a previous 'RetrieveSavedReports' call using this schema.
This method returns a successful "00/OK" response if the request was successfully completed.
The 'Result' element contains the number of 'Record' elements.
The information in the 'Detail' element depends on the 'ServiceDetail' child of the initial request:
- A 'RetrieveSavedReports' request returns a set of 'Record' elements
each of which present information about a saved report in the following child elements:
- A 'SavedReportID' element whose value uniquely identifies the report to 2SMS.
- A 'Name' element containing the name chosen by the user to identify the report.
- A 'Detail' element containing the type of report (i.e. ReportStandard, Report2way or ReportOverview).
- A 'DateRange' element containing a date range: relative time period or recent number of days.
- A 'Status' element containing the status filter or 'All' to apply no filter.
- A 'Destination' element containing the destination filter or 'All' to apply no filter.
- A 'GUID' element containing the GUID reference filter or 'All' to apply no filter.
- A 'GroupBy' element containing grouping information for ReportOverview reports
(code 0340).
- A 'ReportFormat' element containing any additional information for the client application (e.g. format for results).
- A 'DeleteSavedReports' request returns a single 'Record' element which contains:
- An 'ItemsDeleted' child element whose 'Count' attribute contains the number of reports successfully deleted.