GetCustomReports

Description

The GetCustomReports API method returns a list of all custom reports for the given user’s account.
NOTE: This is just meta data about the report, not the actual report data. The report data must still be obtained using the legacy GetReport method.

URL

https://www.regonline.com/api/default.asmx/GetCustomReports

Parameters

NOTE: Although not all parameters are required, an empty string must still be passed when you do not want to use a particular parameter.

filter
This parameter can be used to restrict the results returned from the method. Valid filter expressions are basically C# syntax and can contain some .NET framework method calls.  So, for example, if no filter is passed to GetCustomReports(), then all custom reports in the user’s account are returned.  Or, filters such as the following can be used:

   EventID == 555444 && Name.Contains("Test")
 
   AddDate >= DateTime(2010, 1, 1)

orderBy
This parameter defines the sort order of the results returned.  Valid expression syntax is similar to a SQL ORDER BY clause.  Taking the example of GetCustomReports() again, if no orderBy is given, then the sort order is undefined.  Or, expressions such as the following can be used:

   AddBy, AddDate DESC
 
   Name ASC

Maximum Results

This method will return a maximum of 1000 results.

Returns

    <GetCustomReportsResponse xmlns="http://www.regonline.com/api">
      <GetCustomReportsResult>
        <Success>boolean</Success>
        <Message>string</Message>
        <Data>
          <APICustomReport>
            <ID>int</ID>
            <Name>string</Name>
            <EventID>int</EventID>
            <AddBy>string</AddBy>
            <AddDate>dateTime</AddDate>
          </APICustomReport>
          <APICustomReport>
            ...
          </APICustomReport>
        </Data>
      </GetCustomReportsResult>
    </GetCustomReportsResponse>

Authentication

See Login documentation

Posted: July 28th, 2011

RegOnline by Lanyon is the easy-to-use, affordable online registration and event management software. Turn your next conference, meeting, trade show into a huge success. Event management solutions include online registration forms, event websites, badges, event marketing, credit card processing and so much more. Sign up today for a free trial.

TRUSTe online privacy certification Lanyon Solutions, Inc.
717 North Harwood
Dallas, Texas 75201
email: info@lanyon.com | Toll Free: 1-888-351-9948

 

© Copyright 2017 | RegOnline by Lanyon | All Rights Reserved