/memberships

Returns the memberships held by a single user, ordered by Organization Name and then Position Name.

 

Optional Parameters:

Parameter

Description

Type

page

The specific page number in a paginated list of results

Including this parameter in your call will limit the response to a single page matching the page sequence order represented by the page number.

INT

pageSize

The number of items to include in the page of results 

Including this parameter in your call will adjust the response to only include no more than the number of items that you specify on each page.

Note: The value “100” will be used by default if the parameter is not explicitly set and the maximum value is “500”. 

INT

membershipId

The membership ID of a specific user for the membership details that will be returned in the response

INT

userId

The user ID of the specific user for which a list of all memberships will be returned in the response

INT

username

The username of the specific user for which a list of all memberships will be returned in the response

Note: If you do not supply a valid username value when making this call you will receive an empty response.

STRING

organizationId

The organization ID for which a list of all roster members will be returned in the response

Including this parameter in your call will adjust the response to only include members of a single organization.

INT

currentMembershipsOnly

The toggle for indicating whether only users who currently hold positions in the organization should be returned or not

Including this parameter with the value “true” in your call will adjust the response to only include current memberships held by the user. Including this parameter with the value “false” in your call will adjust the response to include both current and past memberships held by the user.

Note: The value “false” will be used by default if the parameter is not explicitly set.

 

BOOL

publicPrivacyFilter*

The toggle for indicating whether memberships shown or hidden from the PUBLIC will be returned in the response

Including this parameter in your call will adjust the response to only include memberships for the user that are either shown to or hidden from the PUBLIC (i.e., unauthenticated view), where the value “true” is used for limiting to those memberships that are shown and the value “false” is used for limiting to those memberships that are hidden.

Note: The value “false” will be used by default if the parameter is not explicitly set.

BOOL

campusPrivacyFilter*

The toggle for indicating whether memberships shown or hidden from the CAMPUS will be returned in the response

Including this parameter in your call will adjust the response to only include memberships for the user that are either shown to or hidden from the CAMPUS (i.e., authenticated view), where the value “true” is used for limiting to those memberships that are shown and the value “false” is used for limiting to those memberships that are hidden. 

Note: The value “false” will be used by default if the parameter is not explicitly set.

BOOL

includeReflections

The toggle for indicating whether user self-reflections should be returned in the response

Including this parameter in your call will adjust the response to either include or leave out self-reflections, where the value “true” is used to have self-reflections included and the value “false” is used for leaving them out.

Note: The value “false” will be used by default if the parameter is not explicitly set.

BOOL

positionTemplateId

The membership position template ID for which a list of all users holding a position of the specified template will be returned in the response

INT

positionTemplateName

A string that a membership must have for its position template name in order to be included in the response

Including this parameter in your call will limit the response ton only include memberships based on a position template with the name that matches the value specified.

Note: Template names are custom values set by each institution. Log in to your system and check the Organization Administration area to see your template name values. Membership positions may have one and only one template upon which they are based.

STRING

startDate

A date filter based on the start date of a roster membership

Including this parameter in your call will limit the response to only include roster members with positions held on or after the specified date.

Note: dates must be represented in milliseconds/UTC time (e.g., November 12, 2013 is 1384232400000 milliseconds since 1/1/1970 00:00:00 which is the start of Unix Epoch Time)

LONG

endDate

A date filter based on the end date of a roster membership

Including this parameter in your call will limit the response to only include roster members with positions held on or before the specified date.

Note: dates must be represented in milliseconds/UTC time (e.g., November 12, 2013 is 1384232400000 milliseconds since 1/1/1970 00:00:00 which is the start of Unix Epoch Time)

LONG

ModifiedOnStart

A date filter based on the last date that the membership record was modified

Including this parameter in your call will limit the response to only include roster memberships/positions that have been modified since the date included in your call.

LONG

ModifiedOnEnd

A date filter based on the last date that the membership record was modified

Including this parameter in your call will limit the response to only include roster memberships and positions that have been modified before the date included in your call.

LONG

IncludeDeletes

The toggle for indicating whether deleted records should be returned in the response

Including this parameter in your call will adjust the response to either include or leave out membership records where the value “true” is used to deleted records included and the value “false” is used for leaving them out.

Note: The value “false” will be used by default if the parameter is not explicitly set.

BOOL


*Privacy Filter Combinations:

There are a variety of privacy settings that can affect whether a user and the positions he or she holds are visible on an organization roster.  These settings allow for privacy to be controlled for the public (i.e., anyone in the world) and the campus (i.e., only those who can log into the system).  The table below shows the results of different privacy filter combinations:

Public
Filter

Campus
Filter

Result

<not set>

<not set>

Returns all memberships regardless of <UserShownOnPublicRoster> or <UserShownOnCampusRoster>

TRUE

<not set>

Returns only memberships where <UserShownOnPublicRoster> = TRUE, regardless of <UserShownOnCampusRoster>

FALSE

<not set>

Returns only memberships where <UserShownOnPublicRoster> = FALSE, regardless of <UserShownOnCampusRoster>

<not set>

TRUE

Returns only memberships where <UserShownOnCampusRoster> = TRUE regardless of <UserShownOnPublicRoster>

<not set>

FALSE

Returns only memberships where <UserShownOnCampusRoster> = FALSE regardless of <UserShownOnPublicRoster>

TRUE

TRUE

Returns only memberships where <UserShownOnPublicRoster> = TRUE and
<UserShownOnCampusRoster> = TRUE

TRUE

FALSE

Returns only memberships where <UserShownOnPublicRoster> = TRUE and
<UserShownOnCampusRoster> = FALSE

FALSE

TRUE

Returns only memberships where <UserShownOnPublicRoster> = FALSE and
<UserShownOnCampusRoster> = TRUE

FALSE

FALSE

Returns only memberships where <UserShownOnPublicRoster> = FALSE and
<UserShownOnCampusRoster> = FALSE


Example: Calling for a specific membership

Sample Call:

https://yoursite/api/memberships/123576 (response structure different from calls for multiple or all memberships) or https://yoursite/api/memberships?membershipId=123576 (shown below)

Sample Response:

Example: Calling for the memberships of a specific user

Sample Call:

https://yoursite/api/memberships?username=ppaulson

Sample Response:

 

Example: Calling for the memberships of a specific organization (i.e., the entire roster)

Sample Call:

https://yoursite/api/memberships?organizationId=72

Sample Response:

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Need More Help?

Additional Support

Powered by Zendesk