core_v2_userProfileFieldGroup Script API

Enables scripted content fragments to use User Profile Field Groups

Create
Delete
DynamicFormXml
Get
List
Update

Methods

Create

Create a UserProfileFieldGroup

Velocity

#set($userProfileFieldGroupResponse = $core_v2_userProfileFieldGroup.Create($userProfileFieldGroupTitle, "%{ UserProfileFieldNames = $userProfileFieldNamesArg }"))

JavaScript

var userProfileFieldGroupResponse = core_v2_userProfileFieldGroup.Create(userProfileFieldGroupTitle, { UserProfileFieldNames: userProfileFieldNamesArg });

Parameters

Name	Type	Description	Required
userProfileFieldGroupTitle	`String`	User Profile Field Group Title	Required
options	Options	Set of optional parameters including:	Required
UserProfileFieldNames	`String`	A comma-seperated list of user profile field keys	Optional

Returns

UserProfileFieldGroup

Delete

Delete a UserProfileFieldGroup

Velocity

#set($additionalInfoResponse = $core_v2_userProfileFieldGroup.Delete($userProfileFieldGroupId))

JavaScript

var additionalInfoResponse = core_v2_userProfileFieldGroup.Delete(userProfileFieldGroupId);

Parameters

Name	Type	Description	Required	Default	Options
userProfileFieldGroupId	`Int32`	User Profile Field Group Id	Required

Returns

AdditionalInfo

DynamicFormXml

DynamicFormXml Overload 1

Returns a UserProfileFieldGroup's Property Groups as Dynamic Configuration XML

Velocity

#set($stringResponse = $core_v2_userProfileFieldGroup.DynamicFormXml($userProfileFieldGroupId))

JavaScript

var stringResponse = core_v2_userProfileFieldGroup.DynamicFormXml(userProfileFieldGroupId);

Parameters

Name	Type	Description	Required	Default	Options
userProfileFieldGroupId	`Int32`	User Profile Field Group Id	Required

DynamicFormXml Overload 2

Returns a UserProfileFieldGroup's Property Groups as Dynamic Configuration XML

Velocity

#set($stringResponse = $core_v2_userProfileFieldGroup.DynamicFormXml($userProfileFieldGroupId, "%{ ReadOnly = $readOnlyArg }"))

JavaScript

var stringResponse = core_v2_userProfileFieldGroup.DynamicFormXml(userProfileFieldGroupId, { ReadOnly: readOnlyArg });

Parameters

Name	Type	Description	Required	Default
userProfileFieldGroupId	`Int32`	User Profile Field Group Id	Required
options	Options	Set of optional parameters including:	Required
ReadOnly	`Boolean`	Read Only	Optional	False

Returns

String

Get

Get a UserProfileFieldGroup

Velocity

#set($userProfileFieldGroupResponse = $core_v2_userProfileFieldGroup.Get($userProfileFieldGroupId))

JavaScript

var userProfileFieldGroupResponse = core_v2_userProfileFieldGroup.Get(userProfileFieldGroupId);

Parameters

Name	Type	Description	Required	Default	Options
userProfileFieldGroupId	`Int32`	User Profile Field Group Id	Required

Returns

UserProfileFieldGroup

List

List UserProfileFieldGroups

Velocity

#set($pagedListResponse = $core_v2_userProfileFieldGroup.List())

JavaScript

var pagedListResponse = core_v2_userProfileFieldGroup.List();

Returns

PagedList of UserProfileFieldGroup

Update

Update a UserProfileFieldGroup

Velocity

#set($userProfileFieldGroupResponse = $core_v2_userProfileFieldGroup.Update($userProfileFieldGroupId, "%{ Title = $titleArg, UserProfileFieldNames = $userProfileFieldNamesArg }"))

JavaScript

var userProfileFieldGroupResponse = core_v2_userProfileFieldGroup.Update(userProfileFieldGroupId, { Title: titleArg, UserProfileFieldNames: userProfileFieldNamesArg });

Parameters

Name	Type	Description	Required
userProfileFieldGroupId	`Int32`	User Profile Field Group Id	Required
options	Options	Set of optional parameters including:	Required
Title	`String`	Profile field group title	Optional
UserProfileFieldNames	`String`	A comma-seperated list of user profile field keys	Optional

Returns

UserProfileFieldGroup

Recommended