GetCustomFieldListItems

Description

The GetCustomFieldListItems API method returns a list of custom field list item objects for a given event ID and custom field ID.

URL

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

Parameters

Note: Although not all parameters are required, if you do not want to use a particular parameter, an empty value must still be passed with the request.

eventID
The ID of the event you are pulling the custom field list items for.

cfID
The ID of the custom field you are pulling the custom field list items for.

filter
This is an optional parameter that can be used to restrict the results returned from the methods.  Valid filter expressions are basically C# syntax and can contain some .NET framework method calls.  So, for example, if no filter is passed to GetCustomFieldListItems(), then all list items for the given eventID/cfID are returned.  Or, filters such as the following can be used:

   IsVisible && NameOnForm.Contains("Test")
 
   PerGroupLimit > 0

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

   Price DESC
   NameOnForm ASC

Returns

    <GetCustomFieldListItemsResponse xmlns="http://www.regonline.com/api">
      <GetCustomFieldListItemsResult>
        <Success>boolean</Success>
        <Message>string</Message>
        <Data>
          <APICustomFieldListItem>
            <ID>int</ID>
            <EventID>int</EventID>
            <CFID>int</CFID>
            <NameOnForm>string</NameOnForm>
            <NameOnReport>string</NameOnReport>
            <Price>decimal</Price>
            <Capacity>int</Capacity>
            <PerGroupLimit>int</PerGroupLimit>
            <IsVisible>boolean</IsVisible>
            <Order>int</Order>
          </APICustomFieldListItem>
          <APICustomFieldListItem>
            ...
          </APICustomFieldListItem>
        </Data>
      </GetCustomFieldListItemsResult>
    </GetCustomFieldListItemsResponse>

Authentication

See Login documentation

Posted: July 24th, 2012

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