PHPFUI/InstaDoc

CloneableInstantiable

Extends
PHPFUI\ConstantContact\Base

Public
Protected

Methods

public __construct(PHPFUI\ConstantContact\Client $client)

public get(string $event_id, string $track_id, ?string $registration_status = NULL, ?string $payment_status = NULL, ?string $search_text = NULL, ?string $sort_by = NULL, ?string $sort_order = NULL, ?string $page_size = NULL, ?string $limit = NULL, ?string $prev = NULL, ?string $next = NULL) : ?array

Get a list of registrations for an event.

Use the event_id and track_id path parameters to get a list of registrations for an event. Use optional query parameters to limit the number of results returned per page, the sort order, or to filter results by specific criteria; such as registration status.

param string $event_id The ID that uniquely identifies the event.
param string $track_id The track ID that uniquely identifies the event track.
param string $registration_status Filter registration results by status.
param string $payment_status Filter registration results by payment status.
param string $search_text Filter registration results by first name, last name, or email address.
param string $sort_by Specify the field to use to sort the results.
param string $sort_order Use to specify how you want the results sorted.
param string $page_size Alternative to the limit parameter to limit the number of results returned per page. If specifying both the limit and page_size query parameters, they must be the same value.
param string $limit Limit the number of results returned per page. If specifying both the limit and page_size query parameters, they must be the same value.
param string $prev Cursor for pagination used to get the previous page of results (mutually exclusive with next).
param string $next Cursor for pagination used to get the next page of results (mutually exclusive with prev).

public PHPFUI\ConstantContact\Base::getLastError() : string

public PHPFUI\ConstantContact\Base::getResponseText() : string

public PHPFUI\ConstantContact\Base::getStatusCode() : int

public getTyped(string $event_id, string $track_id, ?string $registration_status = NULL, ?string $payment_status = NULL, ?string $search_text = NULL, ?string $sort_by = NULL, ?string $sort_order = NULL, ?string $page_size = NULL, ?string $limit = NULL, ?string $prev = NULL, ?string $next = NULL) : ?PHPFUI\ConstantContact\Definition\PaginatedRegistrations

public PHPFUI\ConstantContact\Base::next() : array

If the endpoint is paginated, you can call next() to retrieve the next set of data. If no next is provided, an empty array is returned.

return array filled with next part of the response from the endpoint, or empty if no next.

public PHPFUI\ConstantContact\Base::success() : bool

Properties

Methods

ConfigurationCode Formating StyleTab Stop SpacesNumbers (0-9.) only