The RegOnline API is subject to both call rate and result set limiting. They are detailed below.
Calls to the RegOnline API are limited to a maximum of 50 per minute. In order to deal with this maximum, please make sure you cache data on your end and are not calling the RegOnline API for each page load on your system. This will also provide a better experience for your end users.
When you have hit the rate limit you will receive the following response:
<ResultsOfListOfEvent xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns="https://www.regonline.com/api"> <Success>false</Success> <Message>Your API Token is invalid or you have reached the maximum number of API calls per minute.</Message> </ResultsOfListOfEvent>
All methods that are not already limited by per event or registration will have a maximum of 1,000 records returned. For example, GetRegistrations which by default pulls all registrations for the user’s account if no filter is passed in, will be limited to 1,000 records. GetRegistrationsForEvent will not however, be limited. The full list of methods which have a return limit are below:
To get around these limits you can specify filters to limit your result size. For example, if you wanted to get all registrations from your account this year and that number was over 1,000, you could make a call for each month using the filter parameter to specify the dates for each month.