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

FormFieldSet.List();

Return Object

FilesList<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

using FilesCom.Models;

var parameters = new Dictionary<string, object>();
parameters.Add("user_id", (Int64?) 1);

try
{
    var formFieldSetIterator = FormFieldSet.List(parameters);
    foreach (FormFieldSet formFieldSet in formFieldSetIterator.ListAutoPaging()) {
        // Operate on formFieldSet
    }
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

Show Form Field Set

SDK Method

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

using FilesCom.Models;

try
{
    var formFieldSet = await FormFieldSet.Find(id);
    // Operate on formFieldSet
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

Create Form Field Set

SDK Method

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

using FilesCom.Models;

var parameters = new Dictionary<string, object>();
parameters.Add("user_id", (Int64?) 1);

try
{
    var formFieldSet = await FormFieldSet.Create(parameters);
    // Operate on formFieldSet
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

Update Form Field Set

SDK Method

formFieldSet.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

using FilesCom.Models;

var parameters = new Dictionary<string, object>();
parameters.Add("title", "Sample Form Title");

try
{
    // Find the formFieldSet object by its id.
    var formFieldSet = await FormFieldSet.Find(id);
    await formFieldSet.Update(parameters);
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

Delete Form Field Set

SDK Method

formFieldSet.Delete();

Return Object

No return value.

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

using FilesCom.Models;

try
{
    // Find the formFieldSet object by its id.
    var formFieldSet = await FormFieldSet.Find(id);
    await formFieldSet.Delete();
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

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