Bundle Registrations

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

SDK Method

bundleregistration.List()

Return Object

[]*BundleRegistration

Authorization Requirement

Available to all authenticated keys or sessions.

BundleRegistrationListParams Fields

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

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    bundle_registration "github.com/Files-com/files-sdk-go/v3/bundleregistration"
)

bundleRegistrationIterator, err := bundle_registration.List(files_sdk.BundleRegistrationListParams{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 bundleRegistrationIterator.Next() {
    bundleRegistration := bundleRegistrationIterator.bundleRegistration()
}
err = bundleRegistrationIterator.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())
    }
}

The BundleRegistration Object

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

AttributeDescription
Code
string
Registration cookie code
Name
string
Registrant name
Company
string
Registrant company name
Email
string
Registrant email address
Ip
string
Registrant IP Address
InboxCode
string
InboxRegistration cookie code, if there is an associated InboxRegistration
ClickwrapBody
string
Clickwrap text that was shown to the registrant
FormFieldSetId
int64
Id of associated form field set
FormFieldData
object
Data for form field set with form field ids as keys and user data as values
BundleCode
string
Bundle URL code
BundleId
int64
Id of associated bundle
BundleRecipientId
int64
Id of associated bundle recipient
WorkspaceId
int64
Workspace ID. 0 means the default workspace.
CreatedAt
date-time
Registration creation date/time