Bundle Registrations

A BundleRegistration is a registration record when a user fills out the form to access the bundle.

SDK Method

\Files\Model\BundleRegistration::list;

Return Object

BundleRegistration[]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

Argument	Description
user_id int64	User ID. Provide a value of `0` to operate the current session's user.
bundle_id int64	ID of the associated Bundle

Additional Arguments

Example Request

try {
  $bundle_registrations = \Files\Model\BundleRegistration::list([
    'user_id' => 1
  ]);
  foreach ($bundle_registrations as $bundle_registration) {
    // Operate on $bundle_registration
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The BundleRegistration Object

Some of the methods above return a BundleRegistration object. The attributes of this object are listed below.

Attribute	Description
code string	Registration cookie code
name string	Registrant name
company string	Registrant company name
email string	Registrant email address
ip string	Registrant IP Address
inbox_code string	InboxRegistration cookie code, if there is an associated InboxRegistration
clickwrap_body string	Clickwrap text that was shown to the registrant
form_field_set_id int64	Id of associated form field set
form_field_data object	Data for form field set with form field ids as keys and user data as values
bundle_code string	Bundle URL code
bundle_id int64	Id of associated bundle
bundle_recipient_id int64	Id of associated bundle recipient
workspace_id int64	Workspace ID. `0` means the default workspace.
created_at date-time	Registration creation date/time