Overview of Member API Calls

Problem

Users need an overview of the available Member API methods for managing member data in the Plus2 system, including creating, updating, retrieving, and searching for member records and related information.

Resolution

Below is a summary of Member API calls, including their purpose and usage.

1. AddAccountDetails(Account accountDetails)

   • Add, modify, or delete a member’s account.

2. AddCorrespondence(obj Request)

   • Add new correspondence for a specified member.

3. AddPicture(int MemberId, string base64EncodedImage)

   • Add a picture to the Plus2 database for a specific member ID.

4. AmendLoyalty(int memberID, int loyaltyAmountChange)

   • Change a member’s loyalty points (increase or decrease). You must know the member’s ID.

5. CheckMember(string firstname, string lastname, DateTime birthDate)

   • Check if a member with the given details exists in the Plus2 database. If multiple matches are found, an exception is thrown.

6. CheckMemberEmail(string email)

   • Return an array of members using the specified email as work or home email.

7. CheckMemberID(int memberId)

   • Check if a member record exists for a given member ID.

8. CheckMemberLogin(LoginIdentificationType LoginId, string idValue, LoginValidationType loginValidationType, string validationValue)

   • Validate member login details. Returns the member ID if matched or 0 if not.

9. CleanupMemberChanges(string systemName)

   • (Integration Manager use) Delete committed member change records for a specified system. Should be run infrequently.

10. CommitMemberChanges(string systemName, int runId)

    • (Integration Manager use) Mark member update records as committed for a given system and run ID.

11. CreateMember(Member newMember)

    • Insert a new member record. Checks for duplicates first; returns -1 if a duplicate exists or the new member’s ID if successful.

12. CreateOrUpdateMember(Member inputMember)

    • Create or update a member based on the input. If member ID is known, use EditMember for efficiency; if not, submit with ID 0.

13. CreateValidMember(Member newMember, bool isDuplicateAllowed)

    • Similar to CreateMember, but checks for duplicates across more fields. If isDuplicateAllowed is true, duplicates are allowed.

14. EditMember(Member updatedMember)

    • Update member details (e.g., address, cardID). If the member ID is unknown, use CheckMember or RetrieveMember first.

15. GetAttendanceHistory(int memberId, DateTime startDateTime, DateTime endDateTime, string siteId, int rowCount)

    • Return attendance records for a member within the specified period and site. Number of records returned is limited by rowCount.

16. GetCorrespondence(obj FilterDetails)

    • Retrieve correspondence records for members matching the filters.

17. GetMemberBookings(int memberId, bool futureOnly)

    • Return bookings made by a member. If futureOnly is true, only future bookings are returned.

18. GetBookingsWithProducts(int memberId, DateTime earliestStart)

    • Return member bookings, including activity product groups.

19. GetMemberChanges(string systemName, int lastRunId, ref int runId)

    • (Integration Manager use) Return members updated since the last run for a system and run ID. Used with CommitMemberChanges.

20. GetMemberChangesPaged(string systemName, int lastRunID, int pageSize)

    • Similar to GetMemberChanges but supports pagination.

21. GetMemberPicture(int memberId)

    • Retrieve the picture for a specified member ID.

22. GetMemberRelationList(string memberId, string sort, int rowIndex, int maxPageCount, out int totalCount)

    • Get the list of members linked to a given member.

23. GetMemberSearch(string firstName, string lastName, string emailAddress, string homeTelephone, string mobileTelephone, string workTelephone, string postcode, int memberId, DateTime birthDate, string sort, int rowIndex, int maxPageCount, out int totalCount)

    • Search for a member record in the Plus2 database by various fields.

24. GetMemberSubscriptions(int memberId)

    • Return the array of subscriptions for a member.

25. GetScreenProfileList(string profileId)

    • Return a list of required fields for a Screen Profile ID.

26. GetTemplateMember()

    • Get a template member object for use when creating new members.

27. MemberSearchByCardID(string cardID)

    • Search for a member by card ID. Returns 0 (no match), 1 (one match), or throws an exception if multiple.

28. MemberSearchByUserField(string userFieldName, string UserFieldValue)

    • Find a member using a user field and value.

29. RecordAttendance(obj request)

    • Record attendance for a member, either for a booking or entry point.

30. RegisterMemberForThirdPartySystem(obj request)

    • Register members with a third-party system. Affects which members are returned by GetMemberChanges.

31. RetrieveLoyalty(int memberID)

    • Get loyalty points for a member.

32. RetrieveMember(int memberID)

    • Retrieve a member record for editing or display.

33. UnHotlistCard(string cardID)

    • Remove a card from the hotlist of invalid cards.

34. UnRegisterMemberForThirdPartySystem(obj request)

    • Unregister a member from a third-party system; these members are no longer included in updates.

35. VerifyMember(MemberFilter filters)

    • Check if a member exists with the provided details and return matching records.

Notes

• For integration-related methods (e.g., GetMemberChanges, CommitMemberChanges), ensure use is coordinated with your third-party systems.
• For member creation, duplicate handling depends on the specific method and its parameters; review the descriptions carefully.
• If searching for members with common personal data (same name and birth date), manual resolution may be needed to identify correct records.

This page as markdown · All pages · llms.txt