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

[]*FormFieldSet

Authorization Requirement

Available to all authenticated keys or sessions.

FormFieldSetListParams Fields

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

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    form_field_set "github.com/Files-com/files-sdk-go/v3/formfieldset"
)

formFieldSetIterator, err := form_field_set.List(files_sdk.FormFieldSetListParams{UserId: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

for formFieldSetIterator.Next() {
    formFieldSet := formFieldSetIterator.formFieldSet()
}
err = formFieldSetIterator.Err()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Show Form Field Set

SDK Method

formfieldset.Find()

Return Object

FormFieldSet

Authorization Requirement

Available to all authenticated keys or sessions.

FormFieldSetFindParams Fields

FieldDescription
Id
int64
Required		Form Field Set ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    form_field_set "github.com/Files-com/files-sdk-go/v3/formfieldset"
)

formFieldSet, err := form_field_set.Find(files_sdk.FormFieldSetFindParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Create Form Field Set

SDK Method

formfieldset.Create()

Return Object

FormFieldSet

Authorization Requirement

Available to all authenticated keys or sessions.

FormFieldSetCreateParams Fields

FieldDescription
UserId
int64		User ID. Provide a value of 0 to operate the current session's user.
Title
string		Title to be displayed
WorkspaceId
int64		Workspace ID
SkipEmail
boolean		Skip validating form email
SkipName
boolean		Skip validating form name
SkipCompany
boolean		Skip validating company
FormFields
array(object)

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    form_field_set "github.com/Files-com/files-sdk-go/v3/formfieldset"
)

formFieldSet, err := form_field_set.Create(files_sdk.FormFieldSetCreateParams{UserId: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Update Form Field Set

SDK Method

formfieldset.Update()

Return Object

FormFieldSet

Authorization Requirement

Available to all authenticated keys or sessions.

FormFieldSetUpdateParams Fields

FieldDescription
Id
int64
Required		Form Field Set ID.
Title
string		Title to be displayed
WorkspaceId
int64		Workspace ID
SkipEmail
boolean		Skip validating form email
SkipName
boolean		Skip validating form name
SkipCompany
boolean		Skip validating company
FormFields
array(object)

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    form_field_set "github.com/Files-com/files-sdk-go/v3/formfieldset"
)

formFieldSet, err := form_field_set.Update(files_sdk.FormFieldSetUpdateParams{
  Id: 1,
  Title: "Sample Form Title"
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

Delete Form Field Set

SDK Method

formfieldset.Delete()

Return Object

No return value.

Authorization Requirement

Available to all authenticated keys or sessions.

FormFieldSetDeleteParams Fields

FieldDescription
Id
int64
Required		Form Field Set ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    form_field_set "github.com/Files-com/files-sdk-go/v3/formfieldset"
)

err := form_field_set.Delete(files_sdk.FormFieldSetDeleteParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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
FormLayout
array(int64)		Layout of the form
FormFields
array(object)		Associated form fields
SkipName
boolean		Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
SkipEmail
boolean		Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
SkipCompany
boolean		Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
InUse
boolean		Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration