MWS
      Back to home
      1. Knowledge Base 2024
      2. Signature Products
      3. MWS

      MWS: Overview of Configuration API calls

      Overview of Configuration API calls

      General.asmx

      CalculateSpecialDate(obj request)

      This method returns a calculated date. It calculates the date value for the given Userfield of type ‘Date’ configured with special date function.

      ClearSettingsCache()

      Clears the server settings cache, forcing it to be fetched from DB next read.

      GetAllSettings()

      This method returns a WebServiceConfiguration object that is populated with the configuration values related to the applicationId defined in the WSI config file. These values are populated by default during install.

      The WebServiceConfiguration object contains different objects to hold values for configuration related properties. These objects include PCID, Setting, BookableActivies, EventLog, MemberRecordAccess, MemberEditRecordAccess, MemberRecordCreateRequiredParts, MaxLength, LengthException, BookingConfiguration and AllowedLoginAttempts.

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

      Returns Sales details, for the given criteria, of when and where certain products were sold in order to provide analysis of attendance.

      GetCorrespondenceCategories()

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

      GetEntryPointList(obj request)

      This method returns details of Entry Points configured in the system. If the siteId is provided then it will return site specific Entry Point details whereas siteId as null will return Entry Point details for all sites.

      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.

      GetPriceLevelList()

      Call this method to return a list of the PriceLevel objects present in the Plus2 database.

      GetPriceLevels()

      Call this method to return an array of all the available price level ids in the Plus2 database

      GetProductGroupsByProducts(obj request)

      This method returns the product groups for a given array of products.

      GetProductsByProductGroups(obj request)

      This method returns the products for a given array of product groups.

      GetProductDetails(obj request)

      Call this method to return details of a given product ID.

      GetResourcesBySiteGroup(obj SiteGroupIds)

      Returns an array of resources for given site groups. Resources usually define physical areas configured in the system e.g. a sports hall or a badminton court.

      GetSettings()

      This returns an array of Setting objects relating to the WSI from the Plus2 database. Each Setting object has a Name and a set of value parameters – StringValue, LongValue, DateTimeValue, DecimalValue. Each Setting will have only one of these values populated. The initial release of this method supports two settings – FutureBookingDays (LongValue), ClubDescription (StringValue). The results are dependent on the value of applicationId tag.This value is inserted into the database using SetSetting() and is populated with default values at the time of installation.

      GetSiteDetails()

      Call this method to return an array of details of the sites in the Plus2 database. These include site ID, Description, Latitude and Longitude.

      GetSiteGroupsBySiteID(obj request)

      This method returns an array of SiteGroups based on a given SiteId.

      GetSiteIDs()

      Call this method to return an array of the Site ids in the Plus2 database.

      GetStatusList()

      Call this method to return a list of the Status objects present in the Plus2 database.

      GetStatuses()

      Call this method to return an array of the Status ids present in the Plus2 database.

      GetSubscriptionTypeGroups()

      Call this method to return a list of all Subscription Type Groups in the Plus2 database.

      GetSubscriptionTypes(List<string> subscriptionTypeGroupIDs)

      Call this method to return a list of all Subscription Types in a given set of Subscription Type Groups in the Plus2 database.

      GetSystemConfigurationList(string siteId, string id)

      Call this method to return an array of the System Configuration objects present in the Plus2 database for a given site and system configuration id.

      GetTitleList()

      Call this method to return a list of the TitleDetail objects present in the Plus2 database. This includes the title description and gender of the title.

      GetTitles()

      Call this method to return an array of all the available titles in the Plus2 database. This should be used in conjunction with the CreateMember and Edit Member web methods to ensure a valid title is selected.

      GetUserFields()

      Call this method to return an array of the user fields in the Plus2 databaseSetAllSettings

      SetAllSetting(WebServiceConfiguration configurationObject)

      Before calling this method, call GetAllSettings to retrieve the current WebServiceConfiguration object from the Plus2 database. Edit values as required, then call SetAllSettings to save the changes back to the Plus2 database.

      SetSettings(List<Setting> settings)

      Before calling this method, call GetSettings to retrieve the current list of Setting objects from the Plus2 database. Edit values as required, then call SetSettings to save the changes back to the Plus2 database.

      WriteEventLog(obj requestParameters) Use this method to update a member’s event log.