GetRegistrationsForCustomField

Description

The GetRegistrationsForCustomField API method returns a list of registration objects for a given custom field. It can also optionally be filtered.

Note: Completed and in-process registrations are returned. To remove in-process registrations from the list, the filter parameter can be used to exclude StatusID 7 or StatusDescription “Incomplete”.

URL

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

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 responses for.

cfid
The ID of the custom field you are pulling the responses for.

filter
This parameter 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 GetRegistrationsForCustomField(), then all registrations for the given custom field are returned (limited to 1000).  Or, filters such as the following can be used:

   IsSubstitute && FirstName.Contains("John")
 
   AddDate >= DateTime(2010, 1, 1)
 
   CancelDate.HasValue

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 GetRegistrationsForCustomField() again, if no orderBy is given, then the sort order is undefined.  Or, expressions such as the following can be used:

   AddBy, AddDate DESC
 
   FirstName ASC

Returns

    <GetRegistrationsForCustomFieldResponse xmlns="http://www.regonline.com/api">
      <GetRegistrationsForCustomFieldResult>
        <Success>boolean</Success>
        <Message>string</Message>
        <Data>
          <APIRegistration>
            <ID>int</ID>
            <EventID>int</EventID>
            <GroupID>int</GroupID>
            <RegTypeID>int</RegTypeID>
            <RegistrationType>string</RegistrationType>
            <RegTypeDescription>string</RegTypeDescription>
            <StatusID>int</StatusID>
            <StatusDescription>string</StatusDescription>
            <Prefix>string</Prefix>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <Suffix>string</Suffix>
            <Title>string</Title>
            <Email>string</Email>
            <Company>string</Company>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <City>string</City>
            <State>string</State>
            <Country>string</Country>
            <PostalCode>string</PostalCode>
            <Phone>string</Phone>
            <HomePhone>string</HomePhone>
            <Extension>string</Extension>
            <Fax>string</Fax>
            <CellPhone>string</CellPhone>
            <CCEmail>string</CCEmail>
            <BadgeName>string</BadgeName>
            <CustID>string</CustID>
            <Photo>string</Photo>
            <DateOfBirth>dateTime</DateOfBirth>
            <Gender>string</Gender>
            <NationalityID>int</NationalityID>
            <Nationality>string</Nationality>
            <RoomSharerID>int</RoomSharerID>
            <MembershipID>string</MembershipID>
            <CheckedIn>boolean</CheckedIn>
            <CancelDate>dateTime</CancelDate>
            <DirectoryOptOut>boolean</DirectoryOptOut>
            <IsSubstitute>boolean</IsSubstitute>
            <Notes>string</Notes>
            <AddBy>string</AddBy>
            <AddDate>dateTime</AddDate>
            <ModBy>string</ModBy>
            <ModDate>dateTime</ModDate>
            <PaymentDocNumber>string</PaymentDocNumber>
          </APIRegistration>
          <APIRegistration>
            ...
          </APIRegistration>
        </Data>
      </GetRegistrationsForCustomFieldResult>
    </GetRegistrationsForCustomFieldResponse>

Authentication

See Login documentation

Posted: June 30th, 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