Group Service

Use this REST Interface to perform all operations related to the group or the household object. This REST Interface is used for all group operations, including insert, query, update, and delete operations to maintain group information.

Group Service Operations

For a list of the operations associated with this REST Interface, see the following table.

Name	Description
createGroup	Creates a group record.
getGroup	Retrieves group records, based on a user query.
deleteGroup	Deletes a group record.
updateGroup	Updates an existing group record.

The UCM REST Interface for Group Service invokes the same workflow process used by UCM Group Web Service, so it requires as input the same instance of SwiGroupIO integration object. Refer to the Group Web Services section of this guide for detail description of this integration object.

Workflow Processes invoked by Group Service:

Name	Workflow Process Name
createGroup	UCM Group Customer Profile Integration SOAP Process
getGroup	UCM Group Customer Profile Integration SOAP Query Process
deleteGroup	UCM Group Customer Profile Integration SOAP Process
updateGroup	UCM Group Customer Profile Integration SOAP Process

Sample Request - deleteGroup

HTTP POST Request URL:

http://<Server Name>:<port>/Siebel/v1.0/workflow/UCM Group Customer Profile Integration SOAP Process

Sample Request body in JSON format:

{
    "SwiGroupIO": {							//Group IO
        "IntObjectFormat": "Siebel Hierarchical",
        "MessageId": "",
        "IntObjectName": "SwiGroupIO",
        "MessageType": "Integration Object",
        "ListOfSwiGroupIO": {
            "ExternalSystemId": "Siebel01",
            "Household": {
                "operation": "Delete",				//Delete operation
                "Household Name": "ABC HOUSEHOLD",
                "Household Number": "ABC-0002",
                "Phone Number": "2222222222",
                "Fax Number": "2222222222"
            }
        }
    }
}

Sample Request body in XML format:

<?xml version="1.0" ?>
<request>
    <SwiGroupIO							//Group IO
        IntObjectFormat="Siebel Hierarchical"
        MessageId=""
        IntObjectName="SwiGroupIO"
        MessageType="Integration Object">
        <ListOfSwiGroupIO ExternalSystemId="Siebel01">
            <Household operation="Delete">			//Delete operation
                <Household_spcName>ABC HOUSEHOLD</Household_spcName>
                <Household_spcNumber>ABC-0002</Household_spcNumber>
                <Phone_spcNumber>2222222222</Phone_spcNumber>
                <Fax_spcNumber>2222222222</Fax_spcNumber>
            </Household>
        </ListOfSwiGroupIO>
    </SwiGroupIO>
</request>