XWeb Membership Package

This page contains a case study of a more complex membership renewal. If you merely want to pay a membership invoice without any alterations to it, then see XWeb Membership Renewal.

Flow

Determine Membership to Renew

You can call WEBActivityGetPurchasedMembershipsByCustomer to get a list of all memberships (both active and terminated) for a customer. Allow the user to choose a membership to renew. Be aware that a customer in netFORUM can have one or more memberships for different member types.

Note that the user may choose a membership that already has an outstanding invoice; you can check this by calling WEBCentralizedShoppingCartMembershipOpenInvoiceGetList. You'll need to compare the value <mbt_code> in the first method with the value of <MbrType> in the second method. If the user has chosen a membership for which there is an outstanding invoice, then see XWeb Membership Renewal for next steps.

Load the Membership

Call WEBCentralizedShoppingCartMembershipGet and pass the <mbr_key> you got from the selected membership. This method will return a mb_membershipType object.

Get Dues Package List

Pass the mb_membershipType returned above to WEBCentralizedShoppingCartMembershipGetRenewalPackageList to get a list of dues package components.

There may be more than one Dues Package available for renewal. Select the Dues Package to renew and hang onto its <asp_pak_prd_key> for the next step.

Get Package Components

A Dues Package may contain multiple components. Call WEBCentralizedShoppingCartMembershipGetPackageComponentList to get the components for the package chosen above. Note that some package components are optional and others are required.

Add Package Components as Fees

For each package component, create a Fee and add it to a FeeCollection by setting the Fee's prc_key to the value of <pkg_prc_key> and the quantity as 1.

Update the <Membership.mbr_pak_prd_renewal_key> of the mb_membershipType to be that of the package chosen (asp_pak_prd_key).

Set Line Items

Pass the FeeCollection that you created previously to WEBCentralizedShoppingCartMembesrhipSetLineItems.

Add Membership to Cart

Add the mb_membershipType to the Shopping Cart Object by calling WEBCentralizedShoppingCartMembershipAddMembership.

Check out and Pay

At this point, the membership renewal is in the cart and you can do more shopping or check out and pay. See WEBCentralizedShoppingCartInsert for guidance on next steps.

Design Considerations

This case study does not  provide a way to alter an existing  membership invoice.