Person

Person Filters

Rock is based on managing people, so it's not surprising that we have special Lava filters for the Person model.

 

Address

Show Details
Server: v2.0

Provides an address for the person you provide.

 

AddSegment

Show Details
Server: v14.1

Adds a person to one or more personalization segments.

 

Campus

Show Details
Server: v5.0

Campus returns the person's campus. Since a person can have more than one campus (if they are a part of more than one family) the first campus will be provided. If you would like an array of all their campuses you can provide the 'All' extension.

 

Children

Show Details
Server: v6.0

Returns a list of children for the person

 

DeleteUserPreference

Show Details
Server: v7.0

Rock has the concept of saved settings / preferences for each user. This filter allows you to clean up the setting based on its key.

 

FamilySalutation

Show Details
Server: v7.0

Returns the salutation of the family for a given person.

 

GeofencingGroupMembers

Show Details
Server: v4.0

Returns a collection of group members whose groups geofence the person's map location address.

 

GeofencingGroups

Show Details
Server: v4.0

Returns a collection of groups that geofence the person's map location address.

 

GetPersonAlternateId

Show Details
Server: v8.1

Returns the person's alternate id.

 

GetUserPreference

Show Details
Server: v7.0

Rock has the concept of saved settings / preferences for each user. This filter allows you to retrieve the setting based on its key. This is a great way of remembering something about the user (like settings from the last time they ran something) for use when they return.

 

Group

Show Details
Server: v5.0

Returns group member information if a person is in a specific group.

 

Groups

Show Details
Server: v4.0

Returns a list of group member models of a specified group type that an individual belongs to.

 

GroupsAttended

Show Details
Server: v4.0

Returns a list of groups that a person attended within a provided group type.

 

HasSignedDocument

Show Details
Server: v7.0

Allows you to determine if someone has already signed a document.

 

HeadOfHousehold

Show Details
Server: v7.0

Returns the head of household of the provided person.

 

IsInSecurityRole

Show Details
Server: v14.0

Takes the given person object and tests if they are the given security role. Returns a boolean value of either true or false.

 

LastAttendedGroupOfType

Show Details
Server: v4.0

Returns the latest attendance record for a group of the type given.

 

NearestCampus

Show Details
Server: v16.0

Gets the nearest campus or campuses for a person's mapped location address.

 

NearestGroup

Show Details
Server: v4.0

Returns the nearest group of a specified group type to the person's mapped location address.

 

Parents

Show Details
Server: v4.0

Returns a list of the adults in the family of a specified person.

 

PersonActionIdentifier

Show Details
Server: v8.7

Creates a non-security type token that identifies a person and a corresponding action. This action is intended for use by developers.

 

PersonalizationItems

Show Details
Server: v14.0

Returns an array of personalization items for the specified person and the current page context.

 

PersonByAliasGuid

Show Details
Server: v8.4

Returns a full person object from the Guid of a person alias.

 

PersonByAliasId

Show Details
Server: v4.0

Returns a full person object from the Id of a person alias.

 

PersonByGuid

Show Details
Server: v5.0

Returns a full person object from the Guid of the person.

 

PersonById

Show Details
Server: v4.0

Returns a full person object from the Id of the person.

 

PersonByPersonActionIdentifier

Show Details
Server: v17.0

Retrieves a person using a generated action identifier and the corresponding action. The action should be the same one used when the token was created.

 

PersonByPersonAlternateId

Show Details
Server: v8.1

Returns a person from the provided alternate id.

 

PersonImpersonationToken

Show Details
Mobile: v1.0

Appends an impersonation token (with rckipid key) to the end of a URL. It's smart enough to handle URLs with and without query string parameters. If the URL is blank, it will return just the token itself.

 

PersonTokenCreate

Show Details
Server: v7.0

Creates a person token for a provided person.

 

PersonTokenRead

Show Details
Server: v7.0

Converts a person token to a person object.

 

PhoneNumber

Show Details
Server: v4.0

Provides a phone number for the person you provide.

 

SetUserPreference

Show Details
Server: v7.0

Rock has the concept of saved settings / preferences for each user. This filter allows you to save the setting based on its key and provided value. This is a great way of remembering something about the user (like settings from the last time they ran something) for use when they return.

 

Spouse

Show Details
Server: v7.0

Returns the spouse of the provided person.

 

Steps

Show Details
Server: v13.0

Returns a filtered list of steps that the person has engaged with.

 

ZebraPhoto

Show Details
Server: v4.0

Returns a person's profile photo data in ZPL format for use in Zebra printer labels. If the person has no photo, the default silhouette photo (adult/child, male/female) is used.