getGroupMembers Method

Returns a set of paginated member-records within a group.

<!-- Section title is the name of the method followed by "Method". If appropriate, precede the method name with the class name and a colon.-->

Class

<!-- broken link--> <!-- Link(s) to the class(es) to which this method belongs. If more than one class implements the same interface, use an itemized list. Don't use a link if the class itself isn't documented for users, but do list the class name.-->

Input Parameters

<!-- If this method has separate input and output parameters, split this section into two sections titled "Input Parameters" and "Output Parameters". Some methods of classes that implement VlocityOpenInterface2 might require an "Options Parameters" section as well.-->
Parameter Required Description
parentId Required Opportunity ID.
contextId Required Parent cart Id (Master/Enterprise Quote/Order Id)
groupId Required Group Id
pageSize Optional: Defaults to 20 Page size for pagination.
offset Optional: Defaults to 0 Offset for pagination
cartType Optional: Defaults to Quote Quote or Order
filters Optional Consists of Field to search on and the sub-string value to search against, separated by colon(:). Supports multiple such sets, separated by comma(,). Example: "vlocity_cmtLoadProfilec:SMB%20Low,vlocity_cmtIsKeyAtPremisesc:true"
sortBy Optional Field to sort on along with the sort order. Example: “vlocity_cmtPremisesIdr.vlocity_cmtStreetAddressc ASC”

Output Parameters

Parameter Description
result JSONResult containing member records.

Example Input Data

<!-- This is usually JSON, but it could be XML or a single value. For methods of classes implementing VlocityOpenInterface2 that have options parameters, include those here.-->
{"offset":0,"pageSize":20,"contextId":"0Q00b000000znTYCAY","parentId":"0060b00000vGbYbAAK","groupId":"a4M0b000002CWMaEAO","cartType":"Quote"}

Example Output Data

<!-- This is usually JSON, but it could be XML or a single value. Salesforce uses Return Type, but this takes care of that.-->
{"totalSize":1,"records":[{"displaySequence":-1,"h_cpq_ecomm__ServicePointId__r":{"Name":"May06_Acc01-Premise - ServicePoint - 4","h_cpq_ecomm__PremisesId__r":{"h_cpq_ecomm__PostalCode__c":"30080","h_cpq_ecomm__City__c":"San Francisco","h_cpq_ecomm__StreetAddress__c":"lone Street","Name":"May06_Acc01-Premise"},"h_cpq_ecomm__IsKeyAtPremises__c":false,"h_cpq_ecomm__LoadProfile__c":"SMB Low","h_cpq_ecomm__MarketIdentifier__c":"Identifier - 38.79059592238243 - 4","h_cpq_ecomm__ActivationDate__c":"2020-05-09","h_cpq_ecomm__UtilityProvider__c":"Other","h_cpq_ecomm__VoltageLevel__c":"Low","h_cpq_ecomm__AverageMonthlyUsage__c":6364,"h_cpq_ecomm__OperationArea__c":null,"Id":"a3h0b00000CwSUFAA3"},"Id":{"value":"a4o0b000000VN98AAG","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__MemberType__c":{"value":"ServicePoint","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__LockedBy__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__LockedFor__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__AsyncOperation__c":{"value":null,"previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__QuoteGroupId__c":{"value":"a4M0b000002CWMaEAO","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}},"h_cpq_ecomm__ServicePointId__c":{"value":"a3h0b00000CwSUFAA3","previousValue":null,"originalValue":null,"messages":[],"label":null,"hidden":null,"fieldName":null,"editable":null,"dataType":null,"alternateValues":null,"actions":{}}}]}