Skip to content

Latest commit

 

History

History
69 lines (53 loc) · 3.29 KB

get-registration-list.md

File metadata and controls

69 lines (53 loc) · 3.29 KB

Get Registration List

{% swagger baseUrl="[PlatformAddress]/api/1.0/" path="event?action=getRegistrationList" method="post" summary="Get Registration List" %} {% swagger-description %} Get a list of registrations {% endswagger-description %}

{% swagger-parameter name="perPage" type="integer" in="path" %} The number of registrations to get in a single api call. Must be an integer greater than 0 and maximum 100 {% endswagger-parameter %}

{% swagger-parameter name="start" type="integer" in="path" %} The starting result of the page. Note this is zero based (i.e. sending start = 0 will start from first result). Must be 0 or greater {% endswagger-parameter %}

{% swagger-parameter name="eventId" type="integer" in="path" %} The event identifier. {% endswagger-parameter %}

{% swagger-response status="200" description="" %}

{% endswagger-response %} {% endswagger %}

Additional Filter Properties

Property Description Type
modifiedDate Filter by modified date iVvy Timestamp Format

Returns

A collection object with the following properties in the results

Property Description
id The unique registration identifier
eventName The name of event that event registration belongs
currentStatus The current status of the event registration
isExhibitor Whether or not event registration is exhibitor
completedDate The registered date time of event registration
mainContactId The main contact id of event registration
firstName The first name of the event registration
lastName The last name of the event registration
phone The phone number of event registration
privacyConsentData The object of Privacy Consent field objects of the event registration.
invoiceTotalCost The total cost of event registration
invoiceTotalPaid The total amount paid of event registration
createdDate The date & time the registration was created
modifiedDate The date & time the registration was last modified

The result from this call will be a collection of all the events the user has access to. This call also accepts the pagination and filter properties.

The result from this call will be a collection of all the events the user has access to. This call also accepts the pagination and filter properties.

Throws

Code Description
Specific Code: 24206 Unable to find event

Registration Current Status Details

Property Description
1 In Progress
2 Completed
4 Payment Waiting