Class mbo_ClientService
Defined in: mbo_ClientService.js.
Constructor Attributes | Constructor Name and Description |
---|---|
mbo_ClientService(username, password)
Represents the MINDOBDY Client Service.
|
Method Attributes | Method Name and Description |
---|---|
getAllClients(search, params)
Retrieves all clients, filtered by search text if given.
|
|
Retrieves Account Balances for Clients
|
|
getClientById(id)
Retrieves a single client by ID
|
|
getClientCount(search)
Retrieves the number of clients.
|
|
Gets the values of Client Indexes for a client.
|
|
getClientsById(ids, params)
Retireves the clients matching the given IDs
|
Class Detail
mbo_ClientService(username, password)
Represents the MINDOBDY Client Service.
- Parameters:
- {string} username
- Username of the MINDBODY client interacting with the service.
- {string} password
- Password of the MINDBODY client interacting with the service.
- Returns:
- {mbo_ClientService} Returns the Client Service.
Method Detail
{Promise}
getAllClients(search, params)
Retrieves all clients, filtered by search text if given.
- Parameters:
- {string} search Optional
- Search string to filter results.
- params
- Returns:
- {Promise} An A+ Promise passed an array of the found clients.
{Promise}
getClientAccountBalancesById(ids)
Retrieves Account Balances for Clients
- Parameters:
- {array} ids
- An array of Client Ids
- Returns:
- {Promise} An A+ Promise resolved to an object keyed by client Id and values of thier Account Balance
{Promise}
getClientById(id)
Retrieves a single client by ID
- Parameters:
- {number} id
- Teh ID of the requested client
- Returns:
- {Promise} An A+ Promise passed an object representing the client.
{Promise}
getClientCount(search)
Retrieves the number of clients.
- Parameters:
- {string} search Optional
- Search string to filter results.
- Returns:
- {Promise} An A+ Promise passed the total number of clients, matching the search string if given.
{Promise}
getClientIndexValues(id)
Gets the values of Client Indexes for a client.
- Parameters:
- {number|string} id
- The client's Id
- Returns:
- {Promise} Returns an A+ Promise resolved to an array of objects representing the client's assigned Client Index values. Each object has the form { index: { id, name }, value: { id, name } }. Client Indexes which do not have an assigned value are excluded.
{Promise}
getClientsById(ids, params)
Retireves the clients matching the given IDs
- Parameters:
- {number|number[]} ids
- An single or array of client IDs to retrieve.
- params
- Returns:
- {Promise} An A+ Promise passed an array of clients.