ccrz.ccApiAddress.revise

Compatibility

This reference applies to:

Signature

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

Service Layer Classes

Data Service Provider

ccrz.ccServiceAddress

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

Inputs (Optional)

The input map can also include the following keys:

ccrz.ccApi.API_SIZING

Map<String, Object> that describes options for sizing and scoping the method's return data. This method supports ccrz.ccApi.SZ_REFETCH => TRUE, which specifies that this method invokes ccrz.ccApiAddress.fetch for returning the updated addresses.

ccrz.ccApi.SIZING => new Map<String, Object>{
    ccrz.ccApiAddress.ENTITYNAME => new Map<String, Object>{
        ccrz.ccApi.SZ_REFETCH => TRUE
    }
}

ccrz.ccApiAddress.ADDRESSLIST

List<Map<String, Object>>, where each Map<String, Object> contains the fields and values to update for a contact address record.

You can update any fields on a contact address record, but you must include the sfid for each record you're updating.

Important

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. 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.ccApiAddress.ADDRESSLIST

List<Map<String, Object>>, where each Map<String, Object> represents an updated contact address record.

This key is returned only when the input map includes ccrz.ccApi.SZ_REFETCH => true.

Note