Person Service

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

Person Service Operations

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

Name	Description
createPerson	Creates a person record.
getPerson	Retrieves person records, based on a user query.
deletePerson	Deletes a person record.
updatePerson	Updates an existing person record.

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

Workflow Processes invoked by Person Service:

Name	Workflow Process Name
createPerson	UCM Person Customer Profile Integration SOAP Process
getPerson	UCM Person Customer Profile Integration SOAP Query Process
deletePerson	UCM Person Customer Profile Integration SOAP Process
updatePerson	UCM Person Customer Profile Integration SOAP Process

Sample Request - getPerson

HTTP POST Request URL:

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

Sample Request body in JSON format:

{
    "SwiPersonIO": {						//Person IO
        "IntObjectFormat": "Siebel Hierarchical",
        "MessageId": "",
        "IntObjectName": "SwiPersonIO",
        "MessageType": "Integration Object",
        "ListOfSwiPersonIO": {
            "ExternalSystemId": "Siebel01",
            "Contact": {
                "operation": "Query",				//Query operation
                "First Name": "JERRY",
                "Last Name": "RICE",
                "Work Phone #": "1111111111",
                "Home Phone #": "1111111111",
                "Email Address": "jerry.rice@gmail.com"
            }
        }
    }
}

Sample Request body in XML format:

<?xml version="1.0" ?>
<request>
    <SwiPersonIO							//Person IO
        IntObjectFormat="Siebel Hierarchical"
        MessageId=""
        IntObjectName="SwiPersonIO"
        MessageType="Integration Object">
        <ListOfSwiPersonIO ExternalSystemId="Siebel01">
            <Contact operation="Query">				//Query operation
                <First_spcName>JERRY</First_spcName>
                <Last_spcName>RICE</Last_spcName>
                <Work_spcPhone_spc_pnd>1111111111</Work_spcPhone_spc_pnd>
                <Email_spcAddress>jerry.rice@gmail.com</Email_spcAddress>
            </Contact>
        </ListOfSwiPersonIO>
    </SwiPersonIO>
</request>