Overview of Configuration API Calls

Problem

This article provides an overview of the available Configuration API calls in the system, including what each call does and the information it returns. This is intended for users who need to understand the functionality and purpose of each method when interacting with the API.

Resolution

1. CalculateSpecialDate(obj request)

   • Returns a calculated date based on a user field of type 'Date' that is configured with a special date function.

2. ClearSettingsCache()

   • Clears the server settings cache, forcing it to refresh from the database on the next read.

3. GetAllSettings()

   • Returns a WebServiceConfiguration object with configuration values related to the application ID defined in the WSI config file. Contains properties such as PCID, Setting, BookableActivities, EventLog, MemberRecordAccess, and others.

4. GetAttendanceByProductsGroup(string[] SiteIDs, string[] ProductGroups, string[] ExcludedDepartmentIds, DateTime StartDate, DateTime EndDate, Boolean IncludeNonMember, String UserfieldDescription)

   • Returns sales details for the specified criteria, including when and where certain products were sold.

5. GetCorrespondenceCategories()

   • Returns a list of correspondence categories in the Plus2 database.

6. GetEntryPointList(obj request)

   • Returns details of entry points in the system. If a site ID is provided, returns site-specific details; if site ID is null, returns entry points for all sites.

7. GetLocalDateTimeForSite(string siteId)

   • Returns the current time on the database server, adjusted for the time difference between the database server's location and the site's location.

8. GetPriceLevelList()

   • Returns a list of PriceLevel objects in the Plus2 database.

9. GetPriceLevels()

   • Returns an array of all available price level IDs in the Plus2 database.

10. GetProductGroupsByProducts(obj request)

    • Returns product groups for a given array of products.

11. GetProductsByProductGroups(obj request)

    • Returns products for a given array of product groups.

12. GetProductDetails(obj request)

    • Returns details of the specified product ID.

13. GetResourcesBySiteGroup(obj SiteGroupIds)

    • Returns an array of resources (such as sports halls or courts) for the specified site groups.

14. GetSettings()

    • Returns an array of Setting objects related to the WSI from the Plus2 database, including name and value parameters (StringValue, LongValue, DateTimeValue, DecimalValue). Typically used for settings like FutureBookingDays and ClubDescription.

15. GetSiteDetails()

    • Returns an array of site details, including ID, description, latitude, and longitude.

16. GetSiteGroupsBySiteID(obj request)

    • Returns an array of site groups for a given site ID.

17. GetSiteIDs()

    • Returns an array of all site IDs in the Plus2 database.

18. GetStatusList()

    • Returns a list of Status objects present in the Plus2 database.

19. GetStatuses()

    • Returns an array of status IDs present in the Plus2 database.

20. GetSubscriptionTypeGroups()

    • Returns a list of all subscription type groups in the Plus2 database.

21. GetSubscriptionTypes(List subscriptionTypeGroupIDs)

    • Returns a list of all subscription types in the specified subscription type groups.

22. GetSystemConfigurationList(string siteId, string id)

    • Returns an array of System Configuration objects for a given site and system configuration ID.

23. GetTitleList()

    • Returns a list of TitleDetail objects, including the title description and associated gender.

24. GetTitles()

    • Returns an array of all available titles in the Plus2 database. Intended for use with CreateMember and EditMember web methods.

25. GetUserFields()

    • Returns an array of user fields in the Plus2 database.

26. SetAllSetting(WebServiceConfiguration configurationObject)

    • To use: First call GetAllSettings to retrieve the current WebServiceConfiguration object, edit values as needed, then call SetAllSettings to save changes.

27. SetSettings(List settings)

    • To use: First call GetSettings to retrieve the current list of Setting objects, edit as needed, then call SetSettings to save changes.

28. WriteEventLog(obj requestParameters)

    • Updates a member’s event log using the specified request parameters.

Notes

• The availability of certain settings and methods may depend on your product installation and configuration.
• When updating settings, always ensure you retrieve the current configuration or setting values before making amendments and resaving to avoid unintended data loss.
• For best results, use the specific 'Get' method before attempting to 'Set' or update values.

This page as markdown · All pages · llms.txt