ccrz.ccApiUser.getProfileData

Compatibility

This reference applies to:

Signature

global static Map<String, Object> getProfileData(Map<String, Object>)

Service Layer Classes

Logic Service Provider

ccrz.ccLogicUserGetProfileData

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.

If this key isn't specified, the method returns a ccrz.ccApi.NoApiVersionException.

Note

ccrz.ccApiUser.USER_ID

String of a specific user ID whose profile data you want to return.

If this key isn't specified, the method returns a ccrz.ccApi.MissingInputException.

Note

Inputs (Optional)

The input map can also include the following keys:

ccrz.ccApi.API_SIZING

Map<String, Object> that specifies the scope of data that this method returns, including which fields the method returns for each record that matches the 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.MESSAGES

List<ccrz.cc_bean_Message>, where each ccrz.cc_bean_Message contains error information sent from the server to the client. Typically, these messages are included only when ccrz.ccApi.SUCCESS is FALSE.

ccrz.ccApi.SUCCESS

Boolean

Value	Usage
true	The call completed.
false	The call encountered errors. B2B Commerce for Visualforce doesn't always return an exception for any errors that can occur. When this value is false, consider rolling back the API transaction to a previous savepoint. Tip

ccrz.ccApiUser.USER_DATA_MAP

Map<String, Object> of user record data.

ccrz.ccApiUser.USER_PROFILE_ACCOUNT

Map<String, Object> of account record data.

ccrz.ccApiUser.USER_PROFILE_CONTACT

Map<String, Object> of contact record data.