Reports: GetArchivedReportsListByScheduleGets a list of the given Account's archived Reports to which the session has access

Usage Notes

By specifying the ScheduleID of zero or less, the method returns all saved non-scheduled (ad hoc) Reports.

This method does not retrive the report results, only the details about the archived report.

There are two Raw nodes under Targets and Filters. These nodes return the specific targets used to retrieve the results of the Report. The Raw nodes are always the first-child node.

The rest of the child nodes under Targets and Filters represent the hierarchial view of the targets and filters used. This information is presented to make creating human-readable report results eeasier.

The Results node is always present, however the TotalsRows, SummaryRows, and BreakdownRows attributes are all optional and may not be present for each report type.

Example of Returned Data

<GetArchivedReportsListBySchedule Success="?" Message="">
<Report Identifier="" UserID="#" UserName="" ScheduleID="#" ScheduleName="" GMTAdded="yyyy-MM-dd HH:mm:ss.fff" GMTCompleted="yyyy-MM-dd HH:mm:ss.fff" Archived="?" Name="" AccountID="#" Notes="">
<ReportType ID="#" Name="">
description
</ReportType>
<Parameters StartDate="yyyy-MM-dd HH:mm:ss.fff" EndDate="yyyy-MM-dd HH:mm:ss.fff">
<Parameter Name="" other="attributes" />
<Parameter Name="" other="attributes" />
<!-- etc -->
</Parameters>
<Targets>
<Raw>
<account>
#
</account>
<fleet>
#
</fleet>
<device>
#
</device>
<!-- etc -->
</Raw>
<Account ID="#" Name="" IconSrc="">
<Fleet ID="#" Name="" IconSrc="">
<Device ID="#" Name="" IconSrc="" />
<!-- etc -->
</Fleet>
</Account>
<!-- etc -->
</Targets>
<Filters Type="">
<Raw>
<account type="">
#
</account>
<fleet type="">
#
</fleet>
<zone color="" />
<zone>
#
</zone>
<location>
#
</location>
<!-- etc -->
</Raw>
<Account ID="#" Name="" IconSrc="">
<Fleet ID="#" Name="" IconSrc="">
<Zone ID="#" Name="" IconSrc="" />
<!-- etc -->
</Fleet>
</Account>
<!-- etc -->
<Country Code="" Name="">
<Province Code="" Name="" />
<State Code="" Name="" />
<!-- etc -->
</Country>
</Filters>
<Results TotalsRows="#" SummaryRows="#" BreakdownRows="#" />
</Report>
<Report Identifier="" UserID="#" UserName="" ScheduleID="#" ScheduleName="" GMTAdded="yyyy-MM-dd HH:mm:ss.fff" GMTCompleted="yyyy-MM-dd HH:mm:ss.fff" Archived="?" Name="" AccountID="#" Notes="">
<ReportType ID="#" Name="">
description
</ReportType>
<Parameters StartDate="yyyy-MM-dd HH:mm:ss.fff" EndDate="yyyy-MM-dd HH:mm:ss.fff">
<Parameter Name="" other="attributes" />
<Parameter Name="" other="attributes" />
<!-- etc -->
</Parameters>
<Targets>
<Raw>
<account>
#
</account>
<fleet>
#
</fleet>
<device>
#
</device>
<!-- etc -->
</Raw>
<Account ID="#" Name="" IconSrc="">
<Fleet ID="#" Name="" IconSrc="">
<Device ID="#" Name="" IconSrc="" />
<!-- etc -->
</Fleet>
</Account>
<!-- etc -->
</Targets>
<Filters Type="">
<Raw>
<account type="">
#
</account>
<fleet type="">
#
</fleet>
<zone color="" />
<zone>
#
</zone>
<location>
#
</location>
<!-- etc -->
</Raw>
<Account ID="#" Name="" IconSrc="">
<Fleet ID="#" Name="" IconSrc="">
<Zone ID="#" Name="" IconSrc="" />
<!-- etc -->
</Fleet>
</Account>
<!-- etc -->
<Country Code="" Name="">
<Province Code="" Name="" />
<State Code="" Name="" />
<!-- etc -->
</Country>
</Filters>
<Results TotalsRows="#" SummaryRows="#" BreakdownRows="#" />
</Report>
<!-- etc -->
</GetArchivedReportsListBySchedule>

Test Method

ParameterValueTypeUsage
ScheduleIDint32Unique Report Schedule identifier