Form Field Sets

A Form Field Set is a custom form to be used for bundle and inbox registrations.

Each Form Field Set contains one or more Form Fields. A form and all of its form fields are submitted in a single create request. The order of form fields in the array is the order they will be displayed.

Once created, a form field set can then be associated with one or more bundle(s) and/or inbox(s). Once associated, you will be required to submit well-formatted form-data when creating a bundle-registration or inbox registration.

List Form Field Sets

SDK Method

\Files\Model\FormFieldSet::list;

Return Object

FormFieldSet[]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.

Additional Arguments

Example Request

try {
  $form_field_sets = \Files\Model\FormFieldSet::list([
    'user_id' => 1
  ]);
  foreach ($form_field_sets as $form_field_set) {
    // Operate on $form_field_set
  }
} 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";
}

Show Form Field Set

SDK Method

\Files\Model\FormFieldSet::find;

Return Object

FormFieldSet

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Form Field Set ID.

Example Request

try {
  $form_field_set = \Files\Model\FormFieldSet::find($id);
  // Operate on $form_field_set
} 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";
}

Create Form Field Set

SDK Method

\Files\Model\FormFieldSet::create;

Return Object

FormFieldSet

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
title
string		Title to be displayed
workspace_id
int64		Workspace ID
skip_email
boolean		Skip validating form email
skip_name
boolean		Skip validating form name
skip_company
boolean		Skip validating company
form_fields
array(object)

Example Request

try {
  $form_field_set = \Files\Model\FormFieldSet::create([
    'user_id' => 1
  ]);
  // Operate on $form_field_set
} 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";
}

Update Form Field Set

SDK Method

$form_field_set->update;

Return Object

FormFieldSet

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
title
string		Title to be displayed
workspace_id
int64		Workspace ID
skip_email
boolean		Skip validating form email
skip_name
boolean		Skip validating form name
skip_company
boolean		Skip validating company
form_fields
array(object)

Example Request

try {
  // Find the form_field_set object by its id.
  $form_field_set = \Files\Model\FormFieldSet::find(id);
  $form_field_set->update([
    'title' => "Sample Form Title"
  ]);
} 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";
}

Delete Form Field Set

SDK Method

$form_field_set->delete;

Return Object

No return value.

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

try {
  // Find the form_field_set object by its id.
  $form_field_set = \Files\Model\FormFieldSet::find(id);
  $form_field_set->delete();
} 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 FormFieldSet Object

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

AttributeDescription
id
int64		Form field set id
title
string		Title to be displayed
form_layout
array(int64)		Layout of the form
form_fields
array(object)		Associated form fields
skip_name
boolean		Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
skip_email
boolean		Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
skip_company
boolean		Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
in_use
boolean		Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration