Client Service
Provides methods and attributes relating to client records.
The following operations are supported. For a formal definition, please review the Service Description.
-
ValidateUserLogin
Accepts a User's Login and Password and returns a Client_Result containing a client record on success and an error message on failure. -
addArrivalEntry
Adds an arrival record for the specified client at the specified location. Arrival records are viewable in the Entry Logs report. -
addClient
Adds a client to the database and returns the client ID on success. Country and State can be left blank-- they will be replaced by default as set in MindBody Online. Card_ID maps to the RSSID field in the MindBody Online database. If Constant Contact integration is enabled, will add to the appropriate Constant Contact list. -
getCardIDHistory
Retrieve the current Card_ID along with the history of Card_IDs based on the supplied Card_ID. Current Card_ID is first element. -
getClient
Accepts a Card_ID (i.e. RSSID) and returns a Client_Result containing a client record on success and an error message on failure. -
getClientActiveMembership
Accepts a CardID (also known as an RSSID) and checks if the associated client has a valid and current membership. Returns the active membership result (nothing if they have none) on success OR an error message on failure. -
getClientFitRewards
For fitRewards! only. Accepts a Card_ID (i.e. MembershipID) and returns a Client_Result containing a client record on success and an error message on failure. Card_ID is in the format of StudioIdentifier_MembershipID (example: SampleYoga_01234567). -
getClientHasContract
Accepts a CardID (also known as an RSSID) and checks if the associated client has a valid and current, non-suspended contract. Returns a boolean result on success or a false and error message on failure. -
getClientHasMembership
Accepts a CardID (also known as an RSSID) and checks if the associated client has a valid and current membership. Returns a boolean result on success or a false and error message on failure. -
getClientIndexes
Returns a list of all active client indexes and their values. -
getClientIndexesOnClient
Returns a list of all active client indexes and their associated values assigned to the specified client. -
getClientReferralTypes
Accepts a User's Login and Password and returns a Client_Result containing a client record on success and an error message on failure. -
getClientTypeList
Retrieves the list of client types (also known as student types) that can be assigned to a client. -
getCurrentClientPayment
Accepts a CardID (also known as an RSSID) and returns a current client payment given the input parameters. This methods returns the payment result (nothing if they have none) on success OR an error message on failure. TypeGroupID, StartDate, EndDate are required fields. VisitTypeID, LocationID are optional and a value of 0 will not filter results. -
getMembershipStatuses
Returns a list of available membership statuses. -
updateClient
Updates a client record with the given profile information. Unspecified fields will be set to null. Boolean fields must have a value. The 'ClientNotFoundAction' parameter specifies the action to be taken if a match for the specified Card_ID is not found: a value of 'Add_New' will insert a new client record, a value of 'Fail' will return a failure message. -
updateClientIndexOnClient
Assign or remove a client index on a specific client. If assign is set to true, assigns a client index value to a client-- otherwise remove. Use getClientIndexes to retrieve valid client index values. -
updateClientMembershipStatus
assigns the given membership status to the given client. -
updateClientTypeOnClient
Assign (or remove) a client type to a client record. Retrieve valid client types by using getClientTypeList. -
updateClientWithLoginInformation
Updates a client record with the given profile information and returns the Card_ID of the client record that was successfully added or updated. Unspecified fields will be set to null. Boolean fields must have a value. The 'ClientNotFoundAction' parameter specifies the action to be taken if a match for the specified Card_ID is not found: a value of 'Add_New' will insert a new client record, a value of 'Fail' will return a failure message.The UserName will be checked for uniqueness and UserPassword will be validated for complexity requirements. If they are both valid (and the rest of the client information is valid), the client record will be added or updated. -
updateLoginNameAndPassword
Updates a client record with the specified loginname and password to be used for logging into MindBodyOnline. Will not update if loginname is already in use by this or any other client and / or password complexity requirement not met. -
updatePassword
Updates a client record with the specified password. Will not update if password does not meet complexity requirement. -
updatePaymentActivation
Accepts a CardID (also known as an RSSID), the PaymentID of a Payment on their account, and updates it with the given date information. Returns a boolean result on success or a false and error message on failure.