B2B Commerce for Visualforce Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
ccrz.ccApiUser.fetch
Executes a SOQL query of user records and returns a list of users that match your
query.
Compatibility
This reference applies to:
| Release | Managed Package Version | API Version |
|---|---|---|
| B2B Commerce for Visualforce Winter ’21 | 4.13 | 12 |
| B2B Commerce for Visualforce Spring ’20 | 4.12 | 11 |
| B2B Commerce for Visualforce Summer ’19 | 4.11 | 10 |
| B2B Commerce for Visualforce Spring ’19 | 4.10 | 9 |
| B2B Commerce for Visualforce Summer ’18 | 4.9 | 8 |
Signature
global static Map<String, Object> fetch(Map<String, Object>)Service Layer Classes
- Data Service Provider
- ccrz.ccServiceUser
Inputs (Required)
Map<String, Object> that must include the following required keys:
- ccrz.ccApi.API_VERSION
- The version of the B2B Commerce for Visualforce API to reference for the method call. We recommend that you use the ccrz.ccApi.CURRENT_VERSION constant whenever possible, and only reference a specific version for compatibility if necessary.
Inputs (Optional)
The input map can also include the following keys:
- ccrz.ccApi.API_SIZING
- Map<String, Object> that specifies options for how the method returns data.
- ccrz.ccApiUser.ID_LIST
- Set<String> of specific user IDs to query.
-
new Set<String>{'User_ID_1', 'User_ID_2'} - ccrz.ccApiUser.ID
- String of a specific user ID to query.
- ccrz.ccApiUser.USER_EMAIL
- String that specifies an email address whose user record you want to query.
- ccrz.ccApiUser.USER_NAME
- String that specifies a username whose user record you want to query.
Outputs
Map<String, Object> that can include the following keys:
- ccrz.ccApi.API_VERSION
- Integer that indicates which API version was used for the query.
- ccrz.ccApi.SUCCESS
- Boolean
Value Usage true The call completed. false The call encountered errors. - ccrz.ccApiUser.USERLIST
- List<Map<String, Object>>, where each Map<String, Object> represents a user record.
Example
Fetch the user record for a specified user ID.
Map<String, Object> userFetchQuery = new Map<String, Object> {
ccrz.ccApi.API_VERSION => ccrz.ccApi.CURRENT_VERSION,
ccrz.ccApiUser.ID => 'User_ID'
};
Map<String, Object> userFetchData = ccrz.ccApiUser.fetch(userFetchQuery);
System.debug('userFetchData KEYS=' + JSON.serializePretty(userFetchData.keySet()));
Boolean success = (Boolean)userFetchData.get(ccrz.ccApi.SUCCESS);
if(success) {
List<Map<String, Object>> users = (List<Map<String, Object>>)userFetchData.get(ccrz.ccApiUser.USERLIST);
System.debug('users=' + JSON.serializePretty(users));
} else {
List<ccrz.cc_bean_Message> messages = (List<ccrz.cc_bean_Message>)userFetchData.get(ccrz.ccApi.MESSAGES);
System.debug('messages=' + messages);
}