CustomerByIDsExamples Class Reference

More...

Detailed Description

Examples for GET Customers by IDs

Example 1 - Get summary attributes of a single customer

This example demonstrates the following:

• Retrieving the summary attributes of a single individual customer.
• This example assumes "Customer departmentalization" setting is enabled. Hence, the response has the department of the customer.

XML

Request

Method	URL
GET	/ws/v12/interaction/customer/1042

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/xml
Accept-Language	en-US

Response
HTTP/1.1 200 OK

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/xml

Response body

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<customers xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/customer"
xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/interaction/case"
xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/interaction/activity"
xmlns:ns4="http://bindings.egain.com/ws/model/v12/gen/platform"
xmlns:ns5="http://bindings.egain.com/ws/model/v12/gen/common"
xmlns:ns6="http://bindings.egain.com/ws/model/v12/gen/interaction/folder"
xmlns:ns7="http://bindings.egain.com/ws/model/v12/gen/kb"
xmlns:ns8="http://bindings.egain.com/ws/model/v15/gen/kb/edition"
xmlns:ns9="http://bindings.egain.com/ws/model/v15/gen/kb/profile"
xmlns:ns10="http://bindings.egain.com/ws/model/v12/gen/interaction/attachment"
xmlns:ns11="http://bindings.egain.com/ws/model/v12/gen/mail/alias"
xmlns:ns12="http://bindings.egain.com/ws/model/v12/gen/live/entrypoint"
xmlns:ns13="http://bindings.egain.com/ws/model/v12/gen/interaction/contactperson"
xmlns:ns14="http://bindings.egain.com/ws/model/v12/gen/interaction/contactpoint">
    <customer id="1042">
        <link rel="self" href="/system/ws/v12/interaction/customer/1042"/>
        <cases>
            <ns2:link rel="case" href="/system/ws/v12/interaction/case?customer=1042"/>
        </cases>
        <customerName>John Tierney</customerName>
        <department id="999">
            <ns4:name>Service</ns4:name>
        </department>
        <type>
            <value>individual</value>
            <displayValue>Individual</displayValue>
        </type>
        <lastModified date="2016-04-26T02:02:12.000Z"/>
        <contactPersons>
            <ns13:contactPerson id="1052">
                <ns13:isSystemCreated>false</ns13:isSystemCreated>
                <ns13:salutation>Mr.</ns13:salutation>
                <ns13:firstName>John</ns13:firstName>
                <ns13:middleName>Russel</ns13:middleName>
                <ns13:lastName>Tierney</ns13:lastName>
                <ns13:lastModified date="2016-04-26T01:22:06.000Z"/>
                <ns13:contactPoints>
                    <ns14:contactPoint id="1174">
                        <ns14:type>
                            <ns14:value>phone</ns14:value>
                            <ns14:displayValue>Telephone</ns14:displayValue>
                            <ns14:phone>
                                <ns14:type>
                                    <ns5:value>home</ns5:value>
                                    <ns5:displayValue>home</ns5:displayValue>
                                </ns14:type>
                                <ns14:phoneNo>234 3456</ns14:phoneNo>
                                <ns14:countryCode>1</ns14:countryCode>
                                <ns14:areaCode>408</ns14:areaCode>
                                <ns14:extension>102</ns14:extension>
                                <ns14:availability>
                                    <ns14:days>
                                        <ns5:value>any_day</ns5:value>
                                        <ns5:displayValue>Any day</ns5:displayValue>
                                    </ns14:days>
                                    <ns14:times>
                                        <ns5:value>mornings</ns5:value>
                                        <ns5:displayValue>Mornings</ns5:displayValue>
                                    </ns14:times>
                                </ns14:availability>
                            </ns14:phone>
                        </ns14:type>
                        <ns14:lastModified date="2016-04-26T01:22:06.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1175">
                        <ns14:type>
                            <ns14:value>postal</ns14:value>
                            <ns14:displayValue>Postal</ns14:displayValue>
                            <ns14:postal>
                                <ns14:type>
                                    <ns5:value>office</ns5:value>
                                    <ns5:displayValue>Office address</ns5:displayValue>
                                </ns14:type>
                                <ns14:address_1>345</ns14:address_1>
                                <ns14:address_2>E Midfield Rd</ns14:address_2>
                                <ns14:city>Mountain View</ns14:city>
                                <ns14:state>Ca</ns14:state>
                                <ns14:zip>98704</ns14:zip>
                                <ns14:country>USA</ns14:country>
                                <ns14:region>United States</ns14:region>
                            </ns14:postal>
                        </ns14:type>
                        <ns14:lastModified date="2016-04-26T01:22:06.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1176">
                        <ns14:type>
                            <ns14:value>email</ns14:value>
                            <ns14:displayValue>Email</ns14:displayValue>
                            <ns14:email>
                                <ns14:emailAddress>john.tierney@customer.com</ns14:emailAddress>
                            </ns14:email>
                        </ns14:type>
                        <ns14:lastModified date="2016-04-26T01:22:06.000Z"/>
                    </ns14:contactPoint>

                </ns13:contactPoints>
            </ns13:contactPerson>
        </contactPersons>
    </customer>
</customers>

TRY IT OUT Try it out - Retrieve customers by IDs      

---

JSON

Request

Method	URL
GET	/ws/v12/interaction/customer/1042

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/json
Accept-Language	en-US

Response
HTTP/1.1 200 OK

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/json

Response body

{
    "customer": [
        {
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1042"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1042"
                }
            },
            "customerName": "John Tierney",
            "department": {
                "name": "Service",
                "id": 999
            },
            "type": {
                "value": "individual",
                "displayValue": "Individual"
            },
            "lastModified": {
                "date": "2016-04-26T02:02:12.000Z"
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "John",
                        "middleName": "Russel",
                        "lastName": "Tierney",
                        "lastModified": {
                            "date": "2016-04-26T01:22:06.000Z"
                        },
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "home",
                                                "displayValue": "home"
                                            },
                                            "phoneNo": "234 3456",
                                            "countryCode": "1",
                                            "areaCode": "408",
                                            "extension": "102",
                                            "availability": {
                                                "days": {
                                                    "value": "any_day",
                                                    "displayValue": "Any day"
                                                },
                                                "times": {
                                                    "value": "mornings",
                                                    "displayValue": "Mornings"
                                                }
                                            }
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "id": 1174
                                },
                                {
                                    "type": {
                                        "value": "postal",
                                        "displayValue": "Postal",
                                        "postal": {
                                            "type": {
                                                "value": "office",
                                                "displayValue": "Office address"
                                            },
                                            "address_1": "345",
                                            "address_2": "E Midfield Rd",
                                            "city": "Mountain View",
                                            "state": "Ca",
                                            "zip": "98704",
                                            "country": "USA",
                                            "region": "United States"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "id": 1175
                                },
                                {
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "john.tierney@customer.com"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "id": 1176
                                },
                                {
                                    "type": {
                                        "value": "social",
                                        "displayValue": "Social",
                                        "social": {
                                            "type": {
                                                "value": "twitter",
                                                "displayValue": "Twitter"
                                            },
                                            "socialId": "1234"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "id": 1177
                                },
                                {
                                    "type": {
                                        "value": "web",
                                        "displayValue": "URL",
                                        "website": {
                                            "url": "www.customer.com"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "id": 1178
                                }
                            ]
                        },
                        "id": 1052
                    }
                ]
            },
            "id": 1042
        }
    ]
}

TRY IT OUT Try it out - Retrieve customers by IDs      

---

Example 2 - Get multiple customers sorted on customerName

This example demonstrates the following:

• Retrieving the details of multiple customers.
• Summary attributes of individual, group as well as corporate customer. This example also demonstrates the representation of summary attributes of contact person and all types of contact points.
• Sorting on customerName in ascending order.

XML

Request

Method	URL
GET	/ws/v12/interaction/customer/1027,1042,1043?$sort=customerName&$order=asc

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/xml
Accept-Language	en-US

Response
HTTP/1.1 200 OK

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/xml

Response body

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<customers xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/customer"
xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/interaction/case"
xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/interaction/activity"
xmlns:ns4="http://bindings.egain.com/ws/model/v12/gen/platform"
xmlns:ns5="http://bindings.egain.com/ws/model/v12/gen/common"
xmlns:ns6="http://bindings.egain.com/ws/model/v12/gen/interaction/folder"
xmlns:ns7="http://bindings.egain.com/ws/model/v12/gen/kb"
xmlns:ns8="http://bindings.egain.com/ws/model/v15/gen/kb/edition"
xmlns:ns9="http://bindings.egain.com/ws/model/v15/gen/kb/profile"
xmlns:ns10="http://bindings.egain.com/ws/model/v12/gen/interaction/attachment"
xmlns:ns11="http://bindings.egain.com/ws/model/v12/gen/mail/alias"
xmlns:ns12="http://bindings.egain.com/ws/model/v12/gen/live/entrypoint"
xmlns:ns13="http://bindings.egain.com/ws/model/v12/gen/interaction/contactperson"
xmlns:ns14="http://bindings.egain.com/ws/model/v12/gen/interaction/contactpoint">
    <customer id="1043">
        <link rel="self" href="/system/ws/v12/interaction/customer/1043"/>
        <cases>
            <ns2:link rel="case" href="/system/ws/v12/interaction/case?customer=1043"/>
        </cases>
        <customerName>Cust Laboratories Limited</customerName>
        <type>
            <value>corporate</value>
            <displayValue>Corporate</displayValue>
            <corporate>
                <region>Europe</region>
                <numberOfEmployees>200</numberOfEmployees>
                <revenues>1000000</revenues>
                <currency>USD</currency>
                <registrationNumber>324-213</registrationNumber>
                <sector>Pharma</sector>
            </corporate>
        </type>
        <lastModified date="2016-04-26T01:33:16.000Z"/>
        <contactPersons>
            <ns13:contactPerson id="1053">
                <ns13:isSystemCreated>true</ns13:isSystemCreated>
                <ns13:firstName>#*Default CP#1043*#</ns13:firstName>
                <ns13:lastModified date="2016-04-26T01:33:16.000Z"/>
            </ns13:contactPerson>
            <ns13:contactPerson id="1054">
                <ns13:isSystemCreated>false</ns13:isSystemCreated>
                <ns13:salutation>Mr.</ns13:salutation>
                <ns13:firstName>David</ns13:firstName>
                <ns13:middleName>Osbon</ns13:middleName>
                <ns13:lastName>Stewart</ns13:lastName>
                <ns13:lastModified date="2016-04-26T01:33:16.000Z"/>
                <ns13:contactPoints>
                    <ns14:contactPoint id="1179">
                        <ns14:type>
                            <ns14:value>phone</ns14:value>
                            <ns14:displayValue>Telephone</ns14:displayValue>
                            <ns14:phone>
                                <ns14:type>
                                    <ns5:value>office</ns5:value>
                                    <ns5:displayValue>office</ns5:displayValue>
                                </ns14:type>
                                <ns14:phoneNo>234 3456</ns14:phoneNo>
                                <ns14:countryCode>1</ns14:countryCode>
                                <ns14:areaCode>408</ns14:areaCode>
                                <ns14:extension>102</ns14:extension>
                                <ns14:availability>
                                    <ns14:days>
                                        <ns5:value>any_day</ns5:value>
                                        <ns5:displayValue>Any day</ns5:displayValue>
                                    </ns14:days>
                                    <ns14:times>
                                        <ns5:value>mornings</ns5:value>
                                        <ns5:displayValue>Mornings</ns5:displayValue>
                                    </ns14:times>
                                </ns14:availability>
                            </ns14:phone>
                        </ns14:type>
                        <ns14:lastModified date="2016-04-26T01:33:16.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1180">
                        <ns14:type>
                            <ns14:value>postal</ns14:value>
                            <ns14:displayValue>Postal</ns14:displayValue>
                            <ns14:postal>
                                <ns14:type>
                                    <ns5:value>billto</ns5:value>
                                    <ns5:displayValue>Bill-to address</ns5:displayValue>
                                </ns14:type>
                                <ns14:address_1>345</ns14:address_1>
                                <ns14:address_2>E Midfield Rd</ns14:address_2>
                                <ns14:city>Mountain View</ns14:city>
                                <ns14:state>Ca</ns14:state>
                                <ns14:zip>98704</ns14:zip>
                                <ns14:country>USA</ns14:country>
                                <ns14:region>United States</ns14:region>
                            </ns14:postal>
                        </ns14:type>
                        <ns14:lastModified date="2016-04-26T01:33:16.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1181">
                        <ns14:type>
                            <ns14:value>email</ns14:value>
                            <ns14:displayValue>Email</ns14:displayValue>
                            <ns14:email>
                                <ns14:emailAddress>david.Stewart@customer.com</ns14:emailAddress>
                            </ns14:email>
                        </ns14:type>
                        <ns14:lastModified date="2016-04-26T01:33:17.000Z"/>
                    </ns14:contactPoint>
                </ns13:contactPoints>
            </ns13:contactPerson>
            <ns13:contactPerson id="1055">
                <ns13:isSystemCreated>false</ns13:isSystemCreated>
                <ns13:salutation>Mr.</ns13:salutation>
                <ns13:firstName>Jack</ns13:firstName>
                <ns13:middleName>Derick</ns13:middleName>
                <ns13:lastName>Hilton</ns13:lastName>
                <ns13:lastModified date="2016-04-26T01:33:17.000Z"/>
                <ns13:contactPoints>
                    <ns14:contactPoint id="1184">
                        <ns14:type>
                            <ns14:value>phone</ns14:value>
                            <ns14:displayValue>Telephone</ns14:displayValue>
                            <ns14:phone>
                                <ns14:type>
                                    <ns5:value>home</ns5:value>
                                    <ns5:displayValue>home</ns5:displayValue>
                                </ns14:type>
                                <ns14:phoneNo>294 3416</ns14:phoneNo>
                                <ns14:countryCode>1</ns14:countryCode>
                                <ns14:areaCode>408</ns14:areaCode>
                                <ns14:extension>102</ns14:extension>
                                <ns14:availability>
                                    <ns14:days>
                                        <ns5:value>any_day</ns5:value>
                                        <ns5:displayValue>Any day</ns5:displayValue>
                                    </ns14:days>
                                    <ns14:times>
                                        <ns5:value>mornings</ns5:value>
                                        <ns5:displayValue>Mornings</ns5:displayValue>
                                    </ns14:times>
                                </ns14:availability>
                            </ns14:phone>
                        </ns14:type>
                        <ns14:lastModified date="2016-04-26T01:33:17.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1185">
                        <ns14:type>
                            <ns14:value>postal</ns14:value>
                            <ns14:displayValue>Postal</ns14:displayValue>
                            <ns14:postal>
                                <ns14:type>
                                    <ns5:value>office</ns5:value>
                                    <ns5:displayValue>Office address</ns5:displayValue>
                                </ns14:type>
                                <ns14:address_1>345</ns14:address_1>
                                <ns14:address_2>E Midfield Rd</ns14:address_2>
                                <ns14:city>Mountain View</ns14:city>
                                <ns14:state>Ca</ns14:state>
                                <ns14:zip>98704</ns14:zip>
                                <ns14:country>USA</ns14:country>
                                <ns14:region>United States</ns14:region>
                            </ns14:postal>
                        </ns14:type>
                        <ns14:lastModified date="2016-04-26T01:33:17.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1186">
                        <ns14:type>
                            <ns14:value>email</ns14:value>
                            <ns14:displayValue>Email</ns14:displayValue>
                            <ns14:email>
                                <ns14:emailAddress>jHilton@customer.com</ns14:emailAddress>
                            </ns14:email>
                        </ns14:type>
                        <ns14:lastModified date="2016-04-26T01:33:17.000Z"/>
                    </ns14:contactPoint>
                </ns13:contactPoints>
            </ns13:contactPerson>
        </contactPersons>
    </customer>
    <customer id="1042">
        <link rel="self" href="/system/ws/v12/interaction/customer/1042"/>
        <cases>
            <ns2:link rel="case" href="/system/ws/v12/interaction/case?customer=1042"/>
        </cases>
        <customerName>John Tierney</customerName>
        <type>
            <value>individual</value>
            <displayValue>Individual</displayValue>
        </type>
        <lastModified date="2016-04-26T01:22:06.000Z"/>
        <contactPersons>
            <ns13:contactPerson id="1052">
                <ns13:isSystemCreated>false</ns13:isSystemCreated>
                <ns13:salutation>Mr.</ns13:salutation>
                <ns13:firstName>John</ns13:firstName>
                <ns13:middleName>Russel</ns13:middleName>
                <ns13:lastName>Tierney</ns13:lastName>
                <ns13:lastModified date="2016-04-26T01:22:06.000Z"/>
                <ns13:contactPoints>
                    <ns14:contactPoint id="1174">
                        <ns14:type>
                            <ns14:value>phone</ns14:value>
                            <ns14:displayValue>Telephone</ns14:displayValue>
                            <ns14:phone>
                                <ns14:type>
                                    <ns5:value>home</ns5:value>
                                    <ns5:displayValue>home</ns5:displayValue>
                                </ns14:type>
                                <ns14:phoneNo>234 3456</ns14:phoneNo>
                                <ns14:countryCode>1</ns14:countryCode>
                                <ns14:areaCode>408</ns14:areaCode>
                                <ns14:extension>102</ns14:extension>
                                <ns14:availability>
                                    <ns14:days>
                                        <ns5:value>any_day</ns5:value>
                                        <ns5:displayValue>Any day</ns5:displayValue>
                                    </ns14:days>
                                    <ns14:times>
                                        <ns5:value>mornings</ns5:value>
                                        <ns5:displayValue>Mornings</ns5:displayValue>
                                    </ns14:times>
                                </ns14:availability>
                            </ns14:phone>
                        </ns14:type>
                        <ns14:lastModified date="2016-04-26T01:22:06.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1175">
                        <ns14:type>
                            <ns14:value>postal</ns14:value>
                            <ns14:displayValue>Postal</ns14:displayValue>
                            <ns14:postal>
                                <ns14:type>
                                    <ns5:value>office</ns5:value>
                                    <ns5:displayValue>Office address</ns5:displayValue>
                                </ns14:type>
                                <ns14:address_1>345</ns14:address_1>
                                <ns14:address_2>E Midfield Rd</ns14:address_2>
                                <ns14:city>Mountain View</ns14:city>
                                <ns14:state>Ca</ns14:state>
                                <ns14:zip>98704</ns14:zip>
                                <ns14:country>USA</ns14:country>
                                <ns14:region>United States</ns14:region>
                            </ns14:postal>
                        </ns14:type>
                        <ns14:lastModified date="2016-04-26T01:22:06.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1176">
                        <ns14:type>
                            <ns14:value>email</ns14:value>
                            <ns14:displayValue>Email</ns14:displayValue>
                            <ns14:email>
                                <ns14:emailAddress>john.tierney@customer.com</ns14:emailAddress>
                            </ns14:email>
                        </ns14:type>
                        <ns14:lastModified date="2016-04-26T01:22:06.000Z"/>
                    </ns14:contactPoint>
                </ns13:contactPoints>
            </ns13:contactPerson>
        </contactPersons>
    </customer>
    <customer id="1027">
        <link rel="self" href="/system/ws/v12/interaction/customer/1027"/>
        <cases>
            <ns2:link rel="case" href="/system/ws/v12/interaction/case?customer=1027"/>
        </cases>
        <customerName>Unichem Laboratories Limited</customerName>
        <type>
            <value>group</value>
            <displayValue>Group</displayValue>
            <group>
                <type>
                    <ns5:value>membership</ns5:value>
                    <ns5:displayValue>Membership</ns5:displayValue>
                </type>
                <region>Europe</region>
                <numberOfMembers>12</numberOfMembers>
                <income>1000000</income>
                <currency>USD</currency>
                <registrationNumber>324</registrationNumber>
                <affiliation>FCMA</affiliation>
            </group>
        </type>
        <lastModified date="2016-04-26T00:49:41.000Z"/>
        <contactPersons>
            <ns13:contactPerson id="1030">
                <ns13:isSystemCreated>true</ns13:isSystemCreated>
                <ns13:firstName>#*Default CP#1027*#</ns13:firstName>
                <ns13:lastModified date="2015-12-31T00:25:19.000Z"/>
            </ns13:contactPerson>
            <ns13:contactPerson id="1031">
                <ns13:isSystemCreated>false</ns13:isSystemCreated>
                <ns13:salutation>Mr.</ns13:salutation>
                <ns13:firstName>Kriag</ns13:firstName>
                <ns13:middleName>Goldman</ns13:middleName>
                <ns13:lastName>Francis</ns13:lastName>
                <ns13:lastModified date="2015-12-31T00:25:19.000Z"/>
                <ns13:contactPoints>
                    <ns14:contactPoint id="1025">
                        <ns14:type>
                            <ns14:value>phone</ns14:value>
                            <ns14:displayValue>Telephone</ns14:displayValue>
                            <ns14:phone>
                                <ns14:type>
                                    <ns5:value>mobile</ns5:value>
                                    <ns5:displayValue>mobile</ns5:displayValue>
                                </ns14:type>
                                <ns14:phoneNo>234 3456</ns14:phoneNo>
                                <ns14:countryCode>1</ns14:countryCode>
                                <ns14:areaCode>408</ns14:areaCode>
                                <ns14:extension>102</ns14:extension>
                                <ns14:availability>
                                    <ns14:days>
                                        <ns5:value>weekends</ns5:value>
                                        <ns5:displayValue>Weekends</ns5:displayValue>
                                    </ns14:days>
                                    <ns14:times>
                                        <ns5:value>anytime</ns5:value>
                                        <ns5:displayValue>Anytime</ns5:displayValue>
                                    </ns14:times>
                                </ns14:availability>
                            </ns14:phone>
                        </ns14:type>
                        <ns14:lastModified date="2015-12-31T00:25:19.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1026">
                        <ns14:type>
                            <ns14:value>postal</ns14:value>
                            <ns14:displayValue>Postal</ns14:displayValue>
                            <ns14:postal>
                                <ns14:type>
                                    <ns5:value>billto</ns5:value>
                                    <ns5:displayValue>Bill-to address</ns5:displayValue>
                                </ns14:type>
                                <ns14:address_1>345</ns14:address_1>
                                <ns14:address_2>E Midfield Rd</ns14:address_2>
                                <ns14:city>Mountain View</ns14:city>
                                <ns14:state>Ca</ns14:state>
                                <ns14:zip>98704</ns14:zip>
                                <ns14:country>USA</ns14:country>
                                <ns14:region>United States</ns14:region>
                            </ns14:postal>
                        </ns14:type>
                        <ns14:lastModified date="2015-12-31T00:25:19.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1027">
                        <ns14:type>
                            <ns14:value>email</ns14:value>
                            <ns14:displayValue>Email</ns14:displayValue>
                            <ns14:email>
                                <ns14:emailAddress>kriag.goldman@customer.com</ns14:emailAddress>
                            </ns14:email>
                        </ns14:type>
                        <ns14:lastModified date="2015-12-31T00:25:19.000Z"/>
                    </ns14:contactPoint>
                </ns13:contactPoints>
            </ns13:contactPerson>
            <ns13:contactPerson id="1032">
                <ns13:isSystemCreated>false</ns13:isSystemCreated>
                <ns13:salutation>Mrs.</ns13:salutation>
                <ns13:firstName>Jeniffer</ns13:firstName>
                <ns13:middleName>Goldman</ns13:middleName>
                <ns13:lastName>Francis</ns13:lastName>
                <ns13:lastModified date="2015-12-31T00:25:19.000Z"/>
                <ns13:contactPoints>
                    <ns14:contactPoint id="1030">
                        <ns14:type>
                            <ns14:value>phone</ns14:value>
                            <ns14:displayValue>Telephone</ns14:displayValue>
                            <ns14:phone>
                                <ns14:type>
                                    <ns5:value>pager</ns5:value>
                                    <ns5:displayValue>pager</ns5:displayValue>
                                </ns14:type>
                                <ns14:phoneNo>234-3456</ns14:phoneNo>
                                <ns14:countryCode>1</ns14:countryCode>
                                <ns14:areaCode>408</ns14:areaCode>
                                <ns14:extension>102</ns14:extension>
                                <ns14:availability>
                                    <ns14:days>
                                        <ns5:value>weekends</ns5:value>
                                        <ns5:displayValue>Weekends</ns5:displayValue>
                                    </ns14:days>
                                    <ns14:times>
                                        <ns5:value>day</ns5:value>
                                        <ns5:displayValue>Day</ns5:displayValue>
                                    </ns14:times>
                                </ns14:availability>
                            </ns14:phone>
                        </ns14:type>
                        <ns14:lastModified date="2015-12-31T00:25:19.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1031">
                        <ns14:type>
                            <ns14:value>postal</ns14:value>
                            <ns14:displayValue>Postal</ns14:displayValue>
                            <ns14:postal>
                                <ns14:type>
                                    <ns5:value>shipto</ns5:value>
                                    <ns5:displayValue>Ship-to address</ns5:displayValue>
                                </ns14:type>
                                <ns14:address_1>345</ns14:address_1>
                                <ns14:address_2>E Midfield Rd</ns14:address_2>
                                <ns14:city>Mountain View</ns14:city>
                                <ns14:state>CO</ns14:state>
                                <ns14:zip>98704</ns14:zip>
                                <ns14:country>USA</ns14:country>
                                <ns14:region>United States</ns14:region>
                            </ns14:postal>
                        </ns14:type>
                        <ns14:lastModified date="2015-12-31T00:25:19.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1032">
                        <ns14:type>
                            <ns14:value>email</ns14:value>
                            <ns14:displayValue>Email</ns14:displayValue>
                            <ns14:email>
                                <ns14:emailAddress>jenniffer.goldman@customer.com</ns14:emailAddress>
                            </ns14:email>
                        </ns14:type>
                        <ns14:lastModified date="2015-12-31T00:25:19.000Z"/>
                    </ns14:contactPoint>
                </ns13:contactPoints>
            </ns13:contactPerson>
        </contactPersons>
    </customer>
</customers>

TRY IT OUT Try it out - Retrieve customers by IDs      

---

JSON

Request

Method	URL
GET	/ws/v12/interaction/customer/1027,1042,1043?$sort=customerName&$order=asc

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/json
Accept-Language	en-US

Response
HTTP/1.1 200 OK

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/json

Response body

{
    "customer": [
        {
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1043"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1043"
                }
            },
            "customerName": "Cust Laboratories Limited",
            "type": {
                "value": "corporate",
                "displayValue": "Corporate",
                "corporate": {
                    "region": "Europe",
                    "numberOfEmployees": "200",
                    "revenues": "1000000",
                    "currency": "USD",
                    "registrationNumber": "324-213",
                    "sector": "Pharma"
                }
            },
            "lastModified": {
                "date": "2016-04-26T01:33:16.000Z"
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "isSystemCreated": true,
                        "firstName": "#*Default CP#1043*#",
                        "lastModified": {
                            "date": "2016-04-26T01:33:16.000Z"
                        },
                        "id": 1053
                    },
                    {
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "David",
                        "middleName": "Osbon",
                        "lastName": "Stewart",
                        "lastModified": {
                            "date": "2016-04-26T01:33:16.000Z"
                        },
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "office",
                                                "displayValue": "office"
                                            },
                                            "phoneNo": "234 3456",
                                            "countryCode": "1",
                                            "areaCode": "408",
                                            "extension": "102",
                                            "availability": {
                                                "days": {
                                                    "value": "any_day",
                                                    "displayValue": "Any day"
                                                },
                                                "times": {
                                                    "value": "mornings",
                                                    "displayValue": "Mornings"
                                                }
                                            }
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:33:16.000Z"
                                    },
                                    "id": 1179
                                },
                                {
                                    "type": {
                                        "value": "postal",
                                        "displayValue": "Postal",
                                        "postal": {
                                            "type": {
                                                "value": "billto",
                                                "displayValue": "Bill-to address"
                                            },
                                            "address_1": "345",
                                            "address_2": "E Midfield Rd",
                                            "city": "Mountain View",
                                            "state": "Ca",
                                            "zip": "98704",
                                            "country": "USA",
                                            "region": "United States"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:33:16.000Z"
                                    },
                                    "id": 1180
                                },
                                {
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "david.Stewart@customer.com"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:33:17.000Z"
                                    },
                                    "id": 1181
                                }
                            ]
                        },
                        "id": 1054
                    },
                    {
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "Jack",
                        "middleName": "Derick",
                        "lastName": "Hilton",
                        "lastModified": {
                            "date": "2016-04-26T01:33:17.000Z"
                        },
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "home",
                                                "displayValue": "home"
                                            },
                                            "phoneNo": "294 3416",
                                            "countryCode": "1",
                                            "areaCode": "408",
                                            "extension": "102",
                                            "availability": {
                                                "days": {
                                                    "value": "any_day",
                                                    "displayValue": "Any day"
                                                },
                                                "times": {
                                                    "value": "mornings",
                                                    "displayValue": "Mornings"
                                                }
                                            }
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:33:17.000Z"
                                    },
                                    "id": 1184
                                },
                                {
                                    "type": {
                                        "value": "postal",
                                        "displayValue": "Postal",
                                        "postal": {
                                            "type": {
                                                "value": "office",
                                                "displayValue": "Office address"
                                            },
                                            "address_1": "345",
                                            "address_2": "E Midfield Rd",
                                            "city": "Mountain View",
                                            "state": "Ca",
                                            "zip": "98704",
                                            "country": "USA",
                                            "region": "United States"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:33:17.000Z"
                                    },
                                    "id": 1185
                                },
                                {
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "jHilton@customer.com"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:33:17.000Z"
                                    },
                                    "id": 1186
                                }
                            ]
                        },
                        "id": 1055
                    }
                ]
            },
            "id": 1043
        },
        {
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1042"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1042"
                }
            },
            "customerName": "John Tierney",
            "type": {
                "value": "individual",
                "displayValue": "Individual"
            },
            "lastModified": {
                "date": "2016-04-26T01:22:06.000Z"
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "John",
                        "middleName": "Russel",
                        "lastName": "Tierney",
                        "lastModified": {
                            "date": "2016-04-26T01:22:06.000Z"
                        },
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "home",
                                                "displayValue": "home"
                                            },
                                            "phoneNo": "234 3456",
                                            "countryCode": "1",
                                            "areaCode": "408",
                                            "extension": "102",
                                            "availability": {
                                                "days": {
                                                    "value": "any_day",
                                                    "displayValue": "Any day"
                                                },
                                                "times": {
                                                    "value": "mornings",
                                                    "displayValue": "Mornings"
                                                }
                                            }
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "id": 1174
                                },
                                {
                                    "type": {
                                        "value": "postal",
                                        "displayValue": "Postal",
                                        "postal": {
                                            "type": {
                                                "value": "office",
                                                "displayValue": "Office address"
                                            },
                                            "address_1": "345",
                                            "address_2": "E Midfield Rd",
                                            "city": "Mountain View",
                                            "state": "Ca",
                                            "zip": "98704",
                                            "country": "USA",
                                            "region": "United States"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "id": 1175
                                },
                                {
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "john.tierney@customer.com"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "id": 1176
                                }
                            ]
                        },
                        "id": 1052
                    }
                ]
            },
            "id": 1042
        },
        {
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1027"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1027"
                }
            },
            "customerName": "Unichem Laboratories Limited",
            "type": {
                "value": "group",
                "displayValue": "Group",
                "group": {
                    "type": {
                        "value": "membership",
                        "displayValue": "Membership"
                    },
                    "region": "Europe",
                    "numberOfMembers": "12",
                    "income": "1000000",
                    "currency": "USD",
                    "registrationNumber": "324",
                    "affiliation": "FCMA"
                }
            },
            "lastModified": {
                "date": "2016-04-26T00:49:41.000Z"
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "isSystemCreated": true,
                        "firstName": "#*Default CP#1027*#",
                        "lastModified": {
                            "date": "2015-12-31T00:25:19.000Z"
                        },
                        "id": 1030
                    },
                    {
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "Kriag",
                        "middleName": "Goldman",
                        "lastName": "Francis",
                        "lastModified": {
                            "date": "2015-12-31T00:25:19.000Z"
                        },
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "mobile",
                                                "displayValue": "mobile"
                                            },
                                            "phoneNo": "234 3456",
                                            "countryCode": "1",
                                            "areaCode": "408",
                                            "extension": "102",
                                            "availability": {
                                                "days": {
                                                    "value": "weekends",
                                                    "displayValue": "Weekends"
                                                },
                                                "times": {
                                                    "value": "anytime",
                                                    "displayValue": "Anytime"
                                                }
                                            }
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2015-12-31T00:25:19.000Z"
                                    },
                                    "id": 1025
                                },
                                {
                                    "type": {
                                        "value": "postal",
                                        "displayValue": "Postal",
                                        "postal": {
                                            "type": {
                                                "value": "billto",
                                                "displayValue": "Bill-to address"
                                            },
                                            "address_1": "345",
                                            "address_2": "E Midfield Rd",
                                            "city": "Mountain View",
                                            "state": "Ca",
                                            "zip": "98704",
                                            "country": "USA",
                                            "region": "United States"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2015-12-31T00:25:19.000Z"
                                    },
                                    "id": 1026
                                },
                                {
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "kriag.goldman@customer.com"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2015-12-31T00:25:19.000Z"
                                    },
                                    "id": 1027
                                }
                            ]
                        },
                        "id": 1031
                    },
                    {
                        "isSystemCreated": false,
                        "salutation": "Mrs.",
                        "firstName": "Jeniffer",
                        "middleName": "Goldman",
                        "lastName": "Francis",
                        "lastModified": {
                            "date": "2015-12-31T00:25:19.000Z"
                        },
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "pager",
                                                "displayValue": "pager"
                                            },
                                            "phoneNo": "234-3456",
                                            "countryCode": "1",
                                            "areaCode": "408",
                                            "extension": "102",
                                            "availability": {
                                                "days": {
                                                    "value": "weekends",
                                                    "displayValue": "Weekends"
                                                },
                                                "times": {
                                                    "value": "day",
                                                    "displayValue": "Day"
                                                }
                                            }
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2015-12-31T00:25:19.000Z"
                                    },
                                    "id": 1030
                                },
                                {
                                    "type": {
                                        "value": "postal",
                                        "displayValue": "Postal",
                                        "postal": {
                                            "type": {
                                                "value": "shipto",
                                                "displayValue": "Ship-to address"
                                            },
                                            "address_1": "345",
                                            "address_2": "E Midfield Rd",
                                            "city": "Mountain View",
                                            "state": "CO",
                                            "zip": "98704",
                                            "country": "USA",
                                            "region": "United States"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2015-12-31T00:25:19.000Z"
                                    },
                                    "id": 1031
                                },
                                {
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "jenniffer.goldman@customer.com"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2015-12-31T00:25:19.000Z"
                                    },
                                    "id": 1032
                                }
                            ]
                        },
                        "id": 1032
                    }
                ]
            },
            "id": 1027
        }
    ]
}

TRY IT OUT Try it out - Retrieve customers by IDs      

---

Example 3 - Get all attributes for multiple customers sorted on custom attribute

This example demonstrates the following:

• Retrieving all attributes for multiple customers.
• Representation of all attributes of individual, group and corporate customer. This example also demonstrates the representation of all the attributes of contact person and all types of contact points.
• Sorting on a custom attribute in descending order

XML

Request

Method	URL
GET	/ws/v12/interaction/customer/1027,1042,1043?$attribute=all&$sort=custom.credit_rating&$order=desc

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/xml
Accept-Language	en-US

Response
HTTP/1.1 200 OK

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/xml

Response body

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<customers xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/customer"
xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/interaction/case"
xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/interaction/activity"
xmlns:ns4="http://bindings.egain.com/ws/model/v12/gen/platform"
xmlns:ns5="http://bindings.egain.com/ws/model/v12/gen/common"
xmlns:ns6="http://bindings.egain.com/ws/model/v12/gen/interaction/folder"
xmlns:ns7="http://bindings.egain.com/ws/model/v12/gen/kb"
xmlns:ns8="http://bindings.egain.com/ws/model/v15/gen/kb/edition"
xmlns:ns9="http://bindings.egain.com/ws/model/v15/gen/kb/profile"
xmlns:ns10="http://bindings.egain.com/ws/model/v12/gen/interaction/attachment"
xmlns:ns11="http://bindings.egain.com/ws/model/v12/gen/mail/alias"
xmlns:ns12="http://bindings.egain.com/ws/model/v12/gen/live/entrypoint"
xmlns:ns13="http://bindings.egain.com/ws/model/v12/gen/interaction/contactperson"
xmlns:ns14="http://bindings.egain.com/ws/model/v12/gen/interaction/contactpoint">
    <customer id="1042">
        <link rel="self" href="/system/ws/v12/interaction/customer/1042"/>
        <cases>
            <ns2:link rel="case" href="/system/ws/v12/interaction/case?customer=1042"/>
        </cases>
        <customerName>John Tierney</customerName>
        <type>
            <value>individual</value>
            <displayValue>Individual</displayValue>
        </type>
        <level>
            <ns5:value>premium</ns5:value>
            <ns5:displayValue>Premium</ns5:displayValue>
        </level>
        <preferredAgent id="1002">
            <ns4:name>Frank</ns4:name>
            <ns4:firstName>Frank</ns4:firstName>
            <ns4:lastName>Robert</ns4:lastName>
        </preferredAgent>
        <role>
            <ns5:value>partner</ns5:value>
            <ns5:displayValue>Partner</ns5:displayValue>
        </role>
        <pin>0121</pin>
        <howReferred>
            <ns5:value>customer</ns5:value>
            <ns5:displayValue>Customer</ns5:displayValue>
        </howReferred>
        <created date="2016-04-26T01:22:06.000Z">
            <ns5:user id="1002">
                <ns4:name>Frank</ns4:name>
                <ns4:firstName>Frank</ns4:firstName>
                <ns4:lastName>Robert</ns4:lastName>
            </ns5:user>
        </created>
        <lastModified date="2016-04-26T18:23:02.000Z"/>
        <industry>
            <ns5:value>telecom</ns5:value>
            <ns5:displayValue>Telecom</ns5:displayValue>
        </industry>
        <marketSegment>Medical Products</marketSegment>
        <entitlements>Free service</entitlements>
        <customAttributes>
            <ns5:customAttribute>
                <ns5:attribName>credit_rating</ns5:attribName>
                <ns5:attribValues>
                    <ns5:attribValue>
                        <ns5:value>Good</ns5:value>
                        <ns5:displayValue>Good</ns5:displayValue>
                    </ns5:attribValue>
                </ns5:attribValues>
            </ns5:customAttribute>
            <ns5:customAttribute>
                <ns5:attribName>preferred_lang</ns5:attribName>
                <ns5:attribValues>
                    <ns5:attribValue>
                        <ns5:value>English</ns5:value>
                    </ns5:attribValue>
                </ns5:attribValues>
            </ns5:customAttribute>
        </customAttributes>
        <contactPersons>
            <ns13:contactPerson id="1052">
                <ns13:isSystemCreated>false</ns13:isSystemCreated>
                <ns13:salutation>Mr.</ns13:salutation>
                <ns13:firstName>John</ns13:firstName>
                <ns13:middleName>Russel</ns13:middleName>
                <ns13:lastName>Tierney</ns13:lastName>
                <ns13:loginId>johnt</ns13:loginId>
                <ns13:lastModified date="2016-04-26T01:22:06.000Z"/>
                <ns13:jobTitle>Manager</ns13:jobTitle>
                <ns13:employmentStatus>
                    <ns5:value>intern</ns5:value>
                    <ns5:displayValue>Intern</ns5:displayValue>
                </ns13:employmentStatus>
                <ns13:dateOfBirth>1965-12-09T00:00:00.000Z</ns13:dateOfBirth>
                <ns13:gender>
                    <ns5:value>male</ns5:value>
                    <ns5:displayValue>Male</ns5:displayValue>
                </ns13:gender>
                <ns13:maritalStatus>
                    <ns5:value>married</ns5:value>
                    <ns5:displayValue>Married</ns5:displayValue>
                </ns13:maritalStatus>
                <ns13:identification>
                    <ns13:type>Passport</ns13:type>
                    <ns13:value>AE0000005</ns13:value>
                </ns13:identification>
                <ns13:type>
                    <ns5:value>billing</ns5:value>
                    <ns5:displayValue>Billing</ns5:displayValue>
                </ns13:type>
                <ns13:firstNameFurigana>John</ns13:firstNameFurigana>
                <ns13:middleNameFurigana>Russel</ns13:middleNameFurigana>
                <ns13:lastNameFurigana>Tierney</ns13:lastNameFurigana>
                <ns13:suffix>
                    <ns5:value>jr.</ns5:value>
                    <ns5:displayValue>Jr.</ns5:displayValue>
                </ns13:suffix>
                <ns13:initials>A.</ns13:initials>
                <ns13:startGreeting>Welcome</ns13:startGreeting>
                <ns13:endGreeting>Thanks, Byee</ns13:endGreeting>
                <ns13:spouseName>Jenifer</ns13:spouseName>
                <ns13:emergencyContact>0987654321</ns13:emergencyContact>
                <ns13:secretQuestion>Place of Birth</ns13:secretQuestion>
                <ns13:secretAnswer>Texas</ns13:secretAnswer>
                <ns13:occupation>Branch Manager</ns13:occupation>
                <ns13:incomeLevel>60000-70000</ns13:incomeLevel>
                <ns13:educationLevel>
                    <ns5:value>post graduate</ns5:value>
                    <ns5:displayValue>Post graduate</ns5:displayValue>
                </ns13:educationLevel>
                <ns13:race>Asian</ns13:race>
                <ns13:dependents>4</ns13:dependents>
                <ns13:isSmoker>true</ns13:isSmoker>
                <ns13:hobbies>Fishing</ns13:hobbies>
                <ns13:interests>Reading</ns13:interests>
                <ns13:contactOrder>1984</ns13:contactOrder>
                <ns13:hasDirectMailingConsent>true</ns13:hasDirectMailingConsent>
                <ns13:hasDirectCallingConsent>true</ns13:hasDirectCallingConsent>
                <ns13:hasHoldingDataConsent>true</ns13:hasHoldingDataConsent>
                <ns13:customAttributes>
                    <ns5:customAttribute>
                        <ns5:attribName>ext_id</ns5:attribName>
                        <ns5:attribValues>
                            <ns5:attribValue>
                                <ns5:value>TWER-345</ns5:value>
                            </ns5:attribValue>
                        </ns5:attribValues>
                    </ns5:customAttribute>
                </ns13:customAttributes>
                <ns13:contactPoints>
                    <ns14:contactPoint id="1174">
                        <ns14:type>
                            <ns14:value>phone</ns14:value>
                            <ns14:displayValue>Telephone</ns14:displayValue>
                            <ns14:phone>
                                <ns14:type>
                                    <ns5:value>home</ns5:value>
                                    <ns5:displayValue>home</ns5:displayValue>
                                </ns14:type>
                                <ns14:phoneNo>234 3456</ns14:phoneNo>
                                <ns14:countryCode>1</ns14:countryCode>
                                <ns14:areaCode>408</ns14:areaCode>
                                <ns14:extension>102</ns14:extension>
                                <ns14:availability>
                                    <ns14:days>
                                        <ns5:value>any_day</ns5:value>
                                        <ns5:displayValue>Any day</ns5:displayValue>
                                    </ns14:days>
                                    <ns14:times>
                                        <ns5:value>mornings</ns5:value>
                                        <ns5:displayValue>Mornings</ns5:displayValue>
                                    </ns14:times>
                                </ns14:availability>
                            </ns14:phone>
                        </ns14:type>
                        <ns14:priority>
                            <ns5:value>low</ns5:value>
                            <ns5:displayValue>Low</ns5:displayValue>
                        </ns14:priority>
                        <ns14:lastModified date="2016-04-26T01:22:06.000Z"/>
                        <ns14:customAttributes>
                            <ns5:customAttribute>
                                <ns5:attribName>priority_sequence</ns5:attribName>
                                <ns5:attribValues>
                                    <ns5:attribValue>
                                        <ns5:value>1</ns5:value>
                                    </ns5:attribValue>
                                </ns5:attribValues>
                            </ns5:customAttribute>
                        </ns14:customAttributes>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1175">
                        <ns14:type>
                            <ns14:value>postal</ns14:value>
                            <ns14:displayValue>Postal</ns14:displayValue>
                            <ns14:postal>
                                <ns14:type>
                                    <ns5:value>office</ns5:value>
                                    <ns5:displayValue>Office address</ns5:displayValue>
                                </ns14:type>
                                <ns14:address_1>345</ns14:address_1>
                                <ns14:address_2>E Midfield Rd</ns14:address_2>
                                <ns14:city>Mountain View</ns14:city>
                                <ns14:state>Ca</ns14:state>
                                <ns14:zip>98704</ns14:zip>
                                <ns14:country>USA</ns14:country>
                                <ns14:region>United States</ns14:region>
                            </ns14:postal>
                        </ns14:type>
                        <ns14:priority>
                            <ns5:value>low</ns5:value>
                            <ns5:displayValue>Low</ns5:displayValue>
                        </ns14:priority>
                        <ns14:lastModified date="2016-04-26T01:22:06.000Z"/>
                        <ns14:customAttributes>
                            <ns5:customAttribute>
                                <ns5:attribName>priority_sequence</ns5:attribName>
                                <ns5:attribValues>
                                    <ns5:attribValue>
                                        <ns5:value>2</ns5:value>
                                    </ns5:attribValue>
                                </ns5:attribValues>
                            </ns5:customAttribute>
                        </ns14:customAttributes>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1176">
                        <ns14:type>
                            <ns14:value>email</ns14:value>
                            <ns14:displayValue>Email</ns14:displayValue>
                            <ns14:email>
                                <ns14:emailAddress>john.tierney@customer.com</ns14:emailAddress>
                            </ns14:email>
                        </ns14:type>
                        <ns14:priority>
                            <ns5:value>low</ns5:value>
                            <ns5:displayValue>Low</ns5:displayValue>
                        </ns14:priority>
                        <ns14:lastModified date="2016-04-26T01:22:06.000Z"/>
                        <ns14:customAttributes>
                            <ns5:customAttribute>
                                <ns5:attribName>priority_sequence</ns5:attribName>
                                <ns5:attribValues>
                                    <ns5:attribValue>
                                        <ns5:value>3</ns5:value>
                                    </ns5:attribValue>
                                </ns5:attribValues>
                            </ns5:customAttribute>
                        </ns14:customAttributes>
                    </ns14:contactPoint>
                </ns13:contactPoints>
            </ns13:contactPerson>
        </contactPersons>
        <notes rel="note" href="/system/ws/v12/interaction/customer/1042/note"/>
    </customer>
    <customer id="1027">
        <link rel="self" href="/system/ws/v12/interaction/customer/1027"/>
        <cases>
            <ns2:link rel="case" href="/system/ws/v12/interaction/case?customer=1027"/>
        </cases>
        <customerName>Unichem Laboratories Limited</customerName>
        <type>
            <value>group</value>
            <displayValue>Group</displayValue>
            <group>
                <type>
                    <ns5:value>membership</ns5:value>
                    <ns5:displayValue>Membership</ns5:displayValue>
                </type>
                <region>Europe</region>
                <numberOfMembers>12</numberOfMembers>
                <income>1000000</income>
                <currency>USD</currency>
                <registrationNumber>324</registrationNumber>
                <affiliation>FCMA</affiliation>
            </group>
        </type>
        <level>
            <ns5:value>platinum</ns5:value>
            <ns5:displayValue>Platinum</ns5:displayValue>
        </level>
        <preferredAgent id="1002">
            <ns4:name>Frank</ns4:name>
            <ns4:firstName>Frank</ns4:firstName>
            <ns4:lastName>Robert</ns4:lastName>
        </preferredAgent>
        <role>
            <ns5:value>partner</ns5:value>
            <ns5:displayValue>Partner</ns5:displayValue>
        </role>
        <pin>0121</pin>
        <howReferred>
            <ns5:value>reseller</ns5:value>
            <ns5:displayValue>Reseller</ns5:displayValue>
        </howReferred>
        <created date="2015-12-31T00:25:19.000Z">
            <ns5:user id="1002">
                <ns4:name>Frank</ns4:name>
                <ns4:firstName>Frank</ns4:firstName>
                <ns4:lastName>Robert</ns4:lastName>
            </ns5:user>
        </created>
        <lastModified date="2016-04-26T18:23:02.000Z"/>
        <industry>
            <ns5:value>health care</ns5:value>
            <ns5:displayValue>Health care</ns5:displayValue>
        </industry>
        <marketSegment>Medical Products</marketSegment>
        <entitlements>Free service</entitlements>
        <customAttributes>
            <ns5:customAttribute>
                <ns5:attribName>credit_rating</ns5:attribName>
                <ns5:attribValues>
                    <ns5:attribValue>
                        <ns5:value>Excellent</ns5:value>
                        <ns5:displayValue>Excellent</ns5:displayValue>
                    </ns5:attribValue>
                </ns5:attribValues>
            </ns5:customAttribute>
        </customAttributes>
        <contactPersons>
            <ns13:contactPerson id="1030">
                <ns13:isSystemCreated>true</ns13:isSystemCreated>
                <ns13:firstName>#*Default CP#1027*#</ns13:firstName>
                <ns13:loginId>##login_default_cp#1027***</ns13:loginId>
                <ns13:lastModified date="2015-12-31T00:25:19.000Z"/>
                <ns13:isSmoker>true</ns13:isSmoker>
                <ns13:hasDirectMailingConsent>true</ns13:hasDirectMailingConsent>
                <ns13:hasDirectCallingConsent>true</ns13:hasDirectCallingConsent>
                <ns13:hasHoldingDataConsent>true</ns13:hasHoldingDataConsent>
                <ns13:customAttributes>
                    <ns5:customAttribute>
                        <ns5:attribName>ext_id</ns5:attribName>
                        <ns5:attribValues>
                            <ns5:attribValue>
                                <ns5:value>NOT_SET</ns5:value>
                            </ns5:attribValue>
                        </ns5:attribValues>
                    </ns5:customAttribute>
                </ns13:customAttributes>
            </ns13:contactPerson>
            <ns13:contactPerson id="1031">
                <ns13:isSystemCreated>false</ns13:isSystemCreated>
                <ns13:salutation>Mr.</ns13:salutation>
                <ns13:firstName>Kriag</ns13:firstName>
                <ns13:middleName>Goldman</ns13:middleName>
                <ns13:lastName>Francis</ns13:lastName>
                <ns13:loginId>kriag</ns13:loginId>
                <ns13:lastModified date="2015-12-31T00:25:19.000Z"/>
                <ns13:jobTitle>Assistant</ns13:jobTitle>
                <ns13:employmentStatus>
                    <ns5:value>full-time</ns5:value>
                    <ns5:displayValue>Full-time</ns5:displayValue>
                </ns13:employmentStatus>
                <ns13:dateOfBirth>1965-12-09T00:00:00.000Z</ns13:dateOfBirth>
                <ns13:gender>
                    <ns5:value>male</ns5:value>
                    <ns5:displayValue>Male</ns5:displayValue>
                </ns13:gender>
                <ns13:maritalStatus>
                    <ns5:value>divorced</ns5:value>
                    <ns5:displayValue>Divorced</ns5:displayValue>
                </ns13:maritalStatus>
                <ns13:identification>
                    <ns13:type>SSN</ns13:type>
                    <ns13:value>111-22-8765</ns13:value>
                </ns13:identification>
                <ns13:type>
                    <ns5:value>legal</ns5:value>
                    <ns5:displayValue>Legal</ns5:displayValue>
                </ns13:type>
                <ns13:firstNameFurigana>Kriag</ns13:firstNameFurigana>
                <ns13:middleNameFurigana>Goldman</ns13:middleNameFurigana>
                <ns13:lastNameFurigana>Francis</ns13:lastNameFurigana>
                <ns13:suffix>
                    <ns5:value>i</ns5:value>
                    <ns5:displayValue>I</ns5:displayValue>
                </ns13:suffix>
                <ns13:initials>A.</ns13:initials>
                <ns13:startGreeting>Hey, Welcome</ns13:startGreeting>
                <ns13:endGreeting>Have a Nice Day!</ns13:endGreeting>
                <ns13:spouseName>Kethel</ns13:spouseName>
                <ns13:emergencyContact>998-765-4321</ns13:emergencyContact>
                <ns13:priority>High</ns13:priority>
                <ns13:secretQuestion>Place of Birth</ns13:secretQuestion>
                <ns13:secretAnswer>Sunnyvale</ns13:secretAnswer>
                <ns13:occupation>Branch Manager</ns13:occupation>
                <ns13:incomeLevel>40000-50000</ns13:incomeLevel>
                <ns13:educationLevel>
                    <ns5:value>graduate</ns5:value>
                    <ns5:displayValue>Graduate</ns5:displayValue>
                </ns13:educationLevel>
                <ns13:race>African</ns13:race>
                <ns13:dependents>4</ns13:dependents>
                <ns13:isSmoker>true</ns13:isSmoker>
                <ns13:hobbies>Farming</ns13:hobbies>
                <ns13:interests>Painting</ns13:interests>
                <ns13:contactOrder>1985</ns13:contactOrder>
                <ns13:hasDirectMailingConsent>true</ns13:hasDirectMailingConsent>
                <ns13:hasDirectCallingConsent>true</ns13:hasDirectCallingConsent>
                <ns13:hasHoldingDataConsent>true</ns13:hasHoldingDataConsent>
                <ns13:customAttributes>
                    <ns5:customAttribute>
                        <ns5:attribName>ext_id</ns5:attribName>
                        <ns5:attribValues>
                            <ns5:attribValue>
                                <ns5:value>NOT_SET</ns5:value>
                            </ns5:attribValue>
                        </ns5:attribValues>
                    </ns5:customAttribute>
                </ns13:customAttributes>
                <ns13:contactPoints>
                    <ns14:contactPoint id="1025">
                        <ns14:type>
                            <ns14:value>phone</ns14:value>
                            <ns14:displayValue>Telephone</ns14:displayValue>
                            <ns14:phone>
                                <ns14:type>
                                    <ns5:value>mobile</ns5:value>
                                    <ns5:displayValue>mobile</ns5:displayValue>
                                </ns14:type>
                                <ns14:phoneNo>234 3456</ns14:phoneNo>
                                <ns14:countryCode>1</ns14:countryCode>
                                <ns14:areaCode>408</ns14:areaCode>
                                <ns14:extension>102</ns14:extension>
                                <ns14:availability>
                                    <ns14:days>
                                        <ns5:value>weekends</ns5:value>
                                        <ns5:displayValue>Weekends</ns5:displayValue>
                                    </ns14:days>
                                    <ns14:times>
                                        <ns5:value>anytime</ns5:value>
                                        <ns5:displayValue>Anytime</ns5:displayValue>
                                    </ns14:times>
                                </ns14:availability>
                            </ns14:phone>
                        </ns14:type>
                        <ns14:priority>
                            <ns5:value>high</ns5:value>
                            <ns5:displayValue>High</ns5:displayValue>
                        </ns14:priority>
                        <ns14:lastModified date="2015-12-31T00:25:19.000Z"/>
                        <ns14:customAttributes>
                            <ns5:customAttribute>
                                <ns5:attribName>priority_sequence</ns5:attribName>
                                <ns5:attribValues>
                                    <ns5:attribValue>
                                        <ns5:value>1</ns5:value>
                                    </ns5:attribValue>
                                </ns5:attribValues>
                            </ns5:customAttribute>
                        </ns14:customAttributes>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1026">
                        <ns14:type>
                            <ns14:value>postal</ns14:value>
                            <ns14:displayValue>Postal</ns14:displayValue>
                            <ns14:postal>
                                <ns14:type>
                                    <ns5:value>billto</ns5:value>
                                    <ns5:displayValue>Bill-to address</ns5:displayValue>
                                </ns14:type>
                                <ns14:address_1>345</ns14:address_1>
                                <ns14:address_2>E Midfield Rd</ns14:address_2>
                                <ns14:city>Mountain View</ns14:city>
                                <ns14:state>Ca</ns14:state>
                                <ns14:zip>98704</ns14:zip>
                                <ns14:country>USA</ns14:country>
                                <ns14:region>United States</ns14:region>
                            </ns14:postal>
                        </ns14:type>
                        <ns14:priority>
                            <ns5:value>low</ns5:value>
                            <ns5:displayValue>Low</ns5:displayValue>
                        </ns14:priority>
                        <ns14:lastModified date="2015-12-31T00:25:19.000Z"/>
                        <ns14:customAttributes>
                            <ns5:customAttribute>
                                <ns5:attribName>priority_sequence</ns5:attribName>
                                <ns5:attribValues>
                                    <ns5:attribValue>
                                        <ns5:value>2</ns5:value>
                                    </ns5:attribValue>
                                </ns5:attribValues>
                            </ns5:customAttribute>
                        </ns14:customAttributes>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1027">
                        <ns14:type>
                            <ns14:value>email</ns14:value>
                            <ns14:displayValue>Email</ns14:displayValue>
                            <ns14:email>
                                <ns14:emailAddress>kriag.goldman@customer.com</ns14:emailAddress>
                            </ns14:email>
                        </ns14:type>
                        <ns14:priority>
                            <ns5:value>high</ns5:value>
                            <ns5:displayValue>High</ns5:displayValue>
                        </ns14:priority>
                        <ns14:lastModified date="2015-12-31T00:25:19.000Z"/>
                        <ns14:customAttributes>
                            <ns5:customAttribute>
                                <ns5:attribName>priority_sequence</ns5:attribName>
                                <ns5:attribValues>
                                    <ns5:attribValue>
                                        <ns5:value>3</ns5:value>
                                    </ns5:attribValue>
                                </ns5:attribValues>
                            </ns5:customAttribute>
                        </ns14:customAttributes>
                    </ns14:contactPoint>
                </ns13:contactPoints>
            </ns13:contactPerson>
            <ns13:contactPerson id="1032">
                <ns13:isSystemCreated>false</ns13:isSystemCreated>
                <ns13:salutation>Mrs.</ns13:salutation>
                <ns13:firstName>Jeniffer</ns13:firstName>
                <ns13:middleName>Goldman</ns13:middleName>
                <ns13:lastName>Francis</ns13:lastName>
                <ns13:loginId>Jfrancis</ns13:loginId>
                <ns13:lastModified date="2015-12-31T00:25:19.000Z"/>
                <ns13:jobTitle>Manager</ns13:jobTitle>
                <ns13:employmentStatus>
                    <ns5:value>contract</ns5:value>
                    <ns5:displayValue>Contract</ns5:displayValue>
                </ns13:employmentStatus>
                <ns13:dateOfBirth>1965-12-09T00:00:00.000Z</ns13:dateOfBirth>
                <ns13:gender>
                    <ns5:value>female</ns5:value>
                    <ns5:displayValue>Female</ns5:displayValue>
                </ns13:gender>
                <ns13:maritalStatus>
                    <ns5:value>single</ns5:value>
                    <ns5:displayValue>Single</ns5:displayValue>
                </ns13:maritalStatus>
                <ns13:identification>
                    <ns13:type>SSN</ns13:type>
                    <ns13:value>111-22-8766</ns13:value>
                </ns13:identification>
                <ns13:type>
                    <ns5:value>billing</ns5:value>
                    <ns5:displayValue>Billing</ns5:displayValue>
                </ns13:type>
                <ns13:firstNameFurigana>Jeniffer</ns13:firstNameFurigana>
                <ns13:middleNameFurigana>Goldman</ns13:middleNameFurigana>
                <ns13:lastNameFurigana>Francis</ns13:lastNameFurigana>
                <ns13:suffix>
                    <ns5:value>sr.</ns5:value>
                    <ns5:displayValue>Sr.</ns5:displayValue>
                </ns13:suffix>
                <ns13:initials>J.</ns13:initials>
                <ns13:startGreeting>Hello</ns13:startGreeting>
                <ns13:endGreeting>Byee</ns13:endGreeting>
                <ns13:spouseName>Sara</ns13:spouseName>
                <ns13:emergencyContact>998-765-4321</ns13:emergencyContact>
                <ns13:priority>High</ns13:priority>
                <ns13:secretQuestion>Place of Birth</ns13:secretQuestion>
                <ns13:secretAnswer>Texas</ns13:secretAnswer>
                <ns13:occupation>Branch Manager</ns13:occupation>
                <ns13:incomeLevel>80000-90000</ns13:incomeLevel>
                <ns13:educationLevel>
                    <ns5:value>doctorate</ns5:value>
                    <ns5:displayValue>Doctorate</ns5:displayValue>
                </ns13:educationLevel>
                <ns13:race>African</ns13:race>
                <ns13:dependents>4</ns13:dependents>
                <ns13:isSmoker>true</ns13:isSmoker>
                <ns13:hobbies>Farming</ns13:hobbies>
                <ns13:interests>Painting</ns13:interests>
                <ns13:contactOrder>1980</ns13:contactOrder>
                <ns13:hasDirectMailingConsent>false</ns13:hasDirectMailingConsent>
                <ns13:hasDirectCallingConsent>false</ns13:hasDirectCallingConsent>
                <ns13:hasHoldingDataConsent>true</ns13:hasHoldingDataConsent>
                <ns13:customAttributes>
                    <ns5:customAttribute>
                        <ns5:attribName>ext_id</ns5:attribName>
                        <ns5:attribValues>
                            <ns5:attribValue>
                                <ns5:value>NOT_SET</ns5:value>
                            </ns5:attribValue>
                        </ns5:attribValues>
                    </ns5:customAttribute>
                </ns13:customAttributes>
                <ns13:contactPoints>
                    <ns14:contactPoint id="1030">
                        <ns14:type>
                            <ns14:value>phone</ns14:value>
                            <ns14:displayValue>Telephone</ns14:displayValue>
                            <ns14:phone>
                                <ns14:type>
                                    <ns5:value>pager</ns5:value>
                                    <ns5:displayValue>pager</ns5:displayValue>
                                </ns14:type>
                                <ns14:phoneNo>234-3456</ns14:phoneNo>
                                <ns14:countryCode>1</ns14:countryCode>
                                <ns14:areaCode>408</ns14:areaCode>
                                <ns14:extension>102</ns14:extension>
                                <ns14:availability>
                                    <ns14:days>
                                        <ns5:value>weekends</ns5:value>
                                        <ns5:displayValue>Weekends</ns5:displayValue>
                                    </ns14:days>
                                    <ns14:times>
                                        <ns5:value>day</ns5:value>
                                        <ns5:displayValue>Day</ns5:displayValue>
                                    </ns14:times>
                                </ns14:availability>
                            </ns14:phone>
                        </ns14:type>
                        <ns14:priority>
                            <ns5:value>high</ns5:value>
                            <ns5:displayValue>High</ns5:displayValue>
                        </ns14:priority>
                        <ns14:lastModified date="2015-12-31T00:25:19.000Z"/>
                        <ns14:customAttributes>
                            <ns5:customAttribute>
                                <ns5:attribName>priority_sequence</ns5:attribName>
                                <ns5:attribValues>
                                    <ns5:attribValue>
                                        <ns5:value>1</ns5:value>
                                    </ns5:attribValue>
                                </ns5:attribValues>
                            </ns5:customAttribute>
                        </ns14:customAttributes>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1031">
                        <ns14:type>
                            <ns14:value>postal</ns14:value>
                            <ns14:displayValue>Postal</ns14:displayValue>
                            <ns14:postal>
                                <ns14:type>
                                    <ns5:value>shipto</ns5:value>
                                    <ns5:di

TRY IT OUT Try it out - Retrieve customers by IDs      

---

JSON

Request

Method	URL
GET	/ws/v12/interaction/customer/1027,1042,1043?$attribute=all&$sort=custom.credit_rating&$order=desc

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/json
Accept-Language	en-US

Response
HTTP/1.1 200 OK

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/json

Response body

{
    "customer": [
        {
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1042"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1042"
                }
            },
            "customerName": "John Tierney",
            "type": {
                "value": "individual",
                "displayValue": "Individual"
            },
            "level": {
                "value": "premium",
                "displayValue": "Premium"
            },
            "preferredAgent": {
                "name": "Frank",
                "firstName": "Frank",
                "lastName": "Robert",
                "id": 1002
            },
            "role": {
                "value": "partner",
                "displayValue": "Partner"
            },
            "pin": "0121",
            "howReferred": {
                "value": "customer",
                "displayValue": "Customer"
            },
            "created": {
                "user": {
                    "name": "Frank",
                    "firstName": "Frank",
                    "lastName": "Robert",
                    "id": 1002
                },
                "date": "2016-04-26T01:22:06.000Z"
            },
            "lastModified": {
                "date": "2016-04-26T18:23:02.000Z"
            },
            "industry": {
                "value": "telecom",
                "displayValue": "Telecom"
            },
            "marketSegment": "Medical Products",
            "entitlements": "Free service",
            "customAttributes": {
                "customAttribute": [
                    {
                        "attribName": "credit_rating",
                        "attribValues": {
                            "attribValue": [
                                {
                                    "value": "Good",
                                    "displayValue": "Good"
                                }
                            ]
                        }
                    },
                    {
                        "attribName": "preferred_lang",
                        "attribValues": {
                            "attribValue": [
                                {
                                    "value": "English"
                                }
                            ]
                        }
                    }
                ]
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "John",
                        "middleName": "Russel",
                        "lastName": "Tierney",
                        "loginId": "johnt",
                        "lastModified": {
                            "date": "2016-04-26T01:22:06.000Z"
                        },
                        "jobTitle": "Manager",
                        "employmentStatus": {
                            "value": "intern",
                            "displayValue": "Intern"
                        },
                        "dateOfBirth": "1965-12-09T00:00:00.000Z",
                        "gender": {
                            "value": "male",
                            "displayValue": "Male"
                        },
                        "maritalStatus": {
                            "value": "married",
                            "displayValue": "Married"
                        },
                        "identification": {
                            "type": "Passport",
                            "value": "AE0000005"
                        },
                        "type": {
                            "value": "billing",
                            "displayValue": "Billing"
                        },
                        "firstNameFurigana": "John",
                        "middleNameFurigana": "Russel",
                        "lastNameFurigana": "Tierney",
                        "suffix": {
                            "value": "jr.",
                            "displayValue": "Jr."
                        },
                        "initials": "A.",
                        "startGreeting": "Welcome",
                        "endGreeting": "Thanks, Byee",
                        "spouseName": "Jenifer",
                        "emergencyContact": "0987654321",
                        "secretQuestion": "Place of Birth",
                        "secretAnswer": "Texas",
                        "occupation": "Branch Manager",
                        "incomeLevel": "60000-70000",
                        "educationLevel": {
                            "value": "post graduate",
                            "displayValue": "Post graduate"
                        },
                        "race": "Asian",
                        "dependents": "4",
                        "isSmoker": "true",
                        "hobbies": "Fishing",
                        "interests": "Reading",
                        "contactOrder": 1984,
                        "hasDirectMailingConsent": "true",
                        "hasDirectCallingConsent": "true",
                        "hasHoldingDataConsent": "true",
                        "customAttributes": {
                            "customAttribute": [
                                {
                                    "attribName": "ext_id",
                                    "attribValues": {
                                        "attribValue": [
                                            {
                                                "value": "TWER-345"
                                            }
                                        ]
                                    }
                                }
                            ]
                        },
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "home",
                                                "displayValue": "home"
                                            },
                                            "phoneNo": "234 3456",
                                            "countryCode": "1",
                                            "areaCode": "408",
                                            "extension": "102",
                                            "availability": {
                                                "days": {
                                                    "value": "any_day",
                                                    "displayValue": "Any day"
                                                },
                                                "times": {
                                                    "value": "mornings",
                                                    "displayValue": "Mornings"
                                                }
                                            }
                                        }
                                    },
                                    "priority": {
                                        "value": "low",
                                        "displayValue": "Low"
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "customAttributes": {
                                        "customAttribute": [
                                            {
                                                "attribName": "priority_sequence",
                                                "attribValues": {
                                                    "attribValue": [
                                                        {
                                                            "value": "1"
                                                        }
                                                    ]
                                                }
                                            }
                                        ]
                                    },
                                    "id": 1174
                                },
                                {
                                    "type": {
                                        "value": "postal",
                                        "displayValue": "Postal",
                                        "postal": {
                                            "type": {
                                                "value": "office",
                                                "displayValue": "Office address"
                                            },
                                            "address_1": "345",
                                            "address_2": "E Midfield Rd",
                                            "city": "Mountain View",
                                            "state": "Ca",
                                            "zip": "98704",
                                            "country": "USA",
                                            "region": "United States"
                                        }
                                    },
                                    "priority": {
                                        "value": "low",
                                        "displayValue": "Low"
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "customAttributes": {
                                        "customAttribute": [
                                            {
                                                "attribName": "priority_sequence",
                                                "attribValues": {
                                                    "attribValue": [
                                                        {
                                                            "value": "2"
                                                        }
                                                    ]
                                                }
                                            }
                                        ]
                                    },
                                    "id": 1175
                                },
                                {
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "john.tierney@customer.com"
                                        }
                                    },
                                    "priority": {
                                        "value": "low",
                                        "displayValue": "Low"
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "customAttributes": {
                                        "customAttribute": [
                                            {
                                                "attribName": "priority_sequence",
                                                "attribValues": {
                                                    "attribValue": [
                                                        {
                                                            "value": "3"
                                                        }
                                                    ]
                                                }
                                            }
                                        ]
                                    },
                                    "id": 1176
                                }
                            ]
                        },
                        "id": 1052
                    }
                ]
            },
            "notes": [
              {
                "rel": "note",
                "href": "/system/ws/v12/interaction/customer/1042/note"
              }
            ],
            "id": 1042
        },
        {
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1027"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1027"
                }
            },
            "customerName": "Unichem Laboratories Limited",
            "type": {
                "value": "group",
                "displayValue": "Group",
                "group": {
                    "type": {
                        "value": "membership",
                        "displayValue": "Membership"
                    },
                    "region": "Europe",
                    "numberOfMembers": "12",
                    "income": "1000000",
                    "currency": "USD",
                    "registrationNumber": "324",
                    "affiliation": "FCMA"
                }
            },
            "level": {
                "value": "platinum",
                "displayValue": "Platinum"
            },
            "preferredAgent": {
                "name": "Frank",
                "firstName": "Frank",
                "lastName": "Robert",
                "id": 1002
            },
            "role": {
                "value": "partner",
                "displayValue": "Partner"
            },
            "pin": "0121",
            "howReferred": {
                "value": "reseller",
                "displayValue": "Reseller"
            },
            "created": {
                "user": {
                    "name": "Frank",
                    "firstName": "Frank",
                    "lastName": "Robert",
                    "id": 1002
                },
                "date": "2015-12-31T00:25:19.000Z"
            },
            "lastModified": {
                "date": "2016-04-26T18:23:02.000Z"
            },
            "industry": {
                "value": "health care",
                "displayValue": "Health care"
            },
            "marketSegment": "Medical Products",
            "entitlements": "Free service",
            "customAttributes": {
                "customAttribute": [
                    {
                        "attribName": "credit_rating",
                        "attribValues": {
                            "attribValue": [
                                {
                                    "value": "Excellent",
                                    "displayValue": "Excellent"
                                }
                            ]
                        }
                    }
                ]
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "isSystemCreated": true,
                        "firstName": "#*Default CP#1027*#",
                        "loginId": "##login_default_cp#1027***",
                        "lastModified": {
                            "date": "2015-12-31T00:25:19.000Z"
                        },
                        "isSmoker": "true",
                        "hasDirectMailingConsent": "true",
                        "hasDirectCallingConsent": "true",
                        "hasHoldingDataConsent": "true",
                        "customAttributes": {
                            "customAttribute": [
                                {
                                    "attribName": "ext_id",
                                    "attribValues": {
                                        "attribValue": [
                                            {
                                                "value": "NOT_SET"
                                            }
                                        ]
                                    }
                                }
                            ]
                        },
                        "id": 1030
                    },
                    {
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "Kriag",
                        "middleName": "Goldman",
                        "lastName": "Francis",
                        "loginId": "kriag",
                        "lastModified": {
                            "date": "2015-12-31T00:25:19.000Z"
                        },
                        "jobTitle": "Assistant",
                        "employmentStatus": {
                            "value": "full-time",
                            "displayValue": "Full-time"
                        },
                        "dateOfBirth": "1965-12-09T00:00:00.000Z",
                        "gender": {
                            "value": "male",
                            "displayValue": "Male"
                        },
                        "maritalStatus": {
                            "value": "divorced",
                            "displayValue": "Divorced"
                        },
                        "identification": {
                            "type": "SSN",
                            "value": "111-22-8765"
                        },
                        "type": {
                            "value": "legal",
                            "displayValue": "Legal"
                        },
                        "firstNameFurigana": "Kriag",
                        "middleNameFurigana": "Goldman",
                        "lastNameFurigana": "Francis",
                        "suffix": {
                            "value": "i",
                            "displayValue": "I"
                        },
                        "initials": "A.",
                        "startGreeting": "Hey, Welcome",
                        "endGreeting": "Have a Nice Day!",
                        "spouseName": "Kethel",
                        "emergencyContact": "998-765-4321",
                        "priority": "High",
                        "secretQuestion": "Place of Birth",
                        "secretAnswer": "Sunnyvale",
                        "occupation": "Branch Manager",
                        "incomeLevel": "40000-50000",
                        "educationLevel": {
                            "value": "graduate",
                            "displayValue": "Graduate"
                        },
                        "race": "African",
                        "dependents": "4",
                        "isSmoker": "true",
                        "hobbies": "Farming",
                        "interests": "Painting",
                        "contactOrder": 1985,
                        "hasDirectMailingConsent": "true",
                        "hasDirectCallingConsent": "true",
                        "hasHoldingDataConsent": "true",
                        "customAttributes": {
                            "customAttribute": [
                                {
                                    "attribName": "ext_id",
                                    "attribValues": {
                                        "attribValue": [
                                            {
                                                "value": "NOT_SET"
                                            }
                                        ]
                                    }
                                }
                            ]
                        },
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "mobile",
                                                "displayValue": "mobile"
                                            },
                                            "phoneNo": "234 3456",
                                            "countryCode": "1",
                                            "areaCode": "408",
                                            "extension": "102",
                                            "availability": {
                                                "days": {
                                                    "value": "weekends",
                                                    "displayValue": "Weekends"
                                                },
                                                "times": {
                                                    "value": "anytime",
                                                    "displayValue": "Anytime"
                                                }
                                            }
                                        }
                                    },
                                    "priority": {
                                        "value": "high",
                                        "displayValue": "High"
                                    },
                                    "lastModified": {
                                        "date": "2015-12-31T00:25:19.000Z"
                                    },
                                    "customAttributes": {
                                        "customAttribute": [
                                            {
                                                "attribName": "priority_sequence",
                                                "attribValues": {
                                                    "attribValue": [
                                                        {
                                                            "value": "1"
                                                        }
                                                    ]
                                                }
                                            }
                                        ]
                                    },
                                    "id": 1025
                                },
                                {
                                    "type": {
                                        "value": "postal",
                                        "displayValue": "Postal",
                                        "postal": {
                                            "type": {
                                                "value": "billto",
                                                "displayValue": "Bill-to address"
                                            },
                                            "address_1": "345",
                                            "address_2": "E Midfield Rd",
                                            "city": "Mountain View",
                                            "state": "Ca",
                                            "zip": "98704",
                                            "country": "USA",
                                            "region": "United States"
                                        }
                                    },
                                    "priority": {
                                        "value": "low",
                                        "displayValue": "Low"
                                    },
                                    "lastModified": {
                                        "date": "2015-12-31T00:25:19.000Z"
                                    },
                                    "customAttributes": {
                                        "customAttribute": [
                                            {
                                                "attribName": "priority_sequence",
                                                "attribValues": {
                                                    "attribValue": [
                                                        {
                                                            "value": "2"
                                                        }
                                                    ]
                                                }
                                            }
                                        ]
                                    },
                                    "id": 1026
                                },
                                {
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "kriag.goldman@customer.com"
                                        }
                                    },
                                    "priority": {
                                        "value": "high",
                                        "displayValue": "High"
                                    },
                                    "lastModified": {
                                        "date": "2015-12-31T00:25:19.000Z"
                                    },
                                    "customAttributes": {
                                        "customAttribute": [
                                            {
                                                "attribName": "priority_sequence",
                                                "attribValues": {
                                                    "attribValue": [
                                                        {
                                                            "value": "3"
                                                        }
                                                    ]
                                                }
                                            }
                                        ]
                                    },
                                    "id": 1027
                                }
                            ]
                        },
                        "id": 1031
                    },
                    {
                        "isSystemCreated": false,
                        "salutation": "Mrs.",
                        "firstName": "Jeniffer",
                        "middleName": "Goldman",
                        "lastName": "Francis",
                        "loginId": "Jfrancis",
                        "lastModified": {
                            "date": "2015-12-31T00:25:19.000Z"
                        },
                        "jobTitle": "Manager",
                        "employmentStatus": {
                            "value": "contract",
                            "displayValue": "Contract"
                        },
                        "dateOfBirth": "1965-12-09T00:00:00.000Z",
                        "gender": {
                            "value": "female",
                            "displayValue": "Female"
                        },
                        "maritalStatus": {
                            "value": "single",
                            "displayValue": "Single"
                        },
                        "identification": {
                            "type": "SSN",
                            "value": "111-22-8766"
                        },
                        "type": {
                            "value": "billing",
                            "displayValue": "Billing"
                        },
                        "firstNameFurigana": "Jeniffer",
                        "middleNameFurigana": "Goldman",
                        "lastNameFurigana": "Francis",
                        "suffix": {
                            "value": "sr.",
                            "displayValue": "Sr."
                        },
                        "initials": "J.",
                        "startGreeting": "Hello",
                        "endGreeting": "Byee",
                        "spouseName": "Sara",
                        "emergencyContact": "998-765-4321",
                        "priority": "High",
                        "secretQuestion": "Place of Birth",
                        "secretAnswer": "Texas",
                        "occupation": "Branch Manager",
                        "incomeLevel": "80000-90000",
                        "educationLevel": {
                            "value": "doctorate",
                            "displayValue": "Doctorate"
                        },
                        "race": "African",
                        "dependents": "4",
                        "isSmoker": "true",
                        "hobbies": "Farming",
                        "interests": "Painting",
                        "contactOrder": 1980,
                        "hasDirectMailingConsent": "false",
                        "hasDirectCallingConsent": "false",
                        "hasHoldingDataConsent": "true",
                        "customAttributes": {
                            "customAttribute": [
                                {
                                    "attribName": "ext_id",
                                    "attribValues": {
                                        "attribValue": [
                                            {
                                                "value": "NOT_SET"
                                            }
                                        ]
                                    }
                                }
                            ]
                        },
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "pager",
                                                "displayValue": "pager"
                                            },
                                            "phoneNo": "234-3456",
                                            "countryCode": "1",
                                            "areaCode": "408",
                                            "extension": "102",
                                            "availability": {
                                                "days": {
                                                    "value": "weekends",
                                                    "displayValue": "Weekends"
                                                },
                                                "times": {
                                                    "value": "day",
                                                    "displayValue": "Day"
                                                }
                                            }
                                        }
                                    },
                                    "priority": {
                                        "value": "high",
             

TRY IT OUT Try it out - Retrieve customers by IDs      

---

Example 4 - Get additional attributes for a single customer

This example demonstrates the following:

• Retrieving additional attributes (including custom attribute) along with summary attributes for an individual customer.

XML

Request

Method	URL
GET	/ws/v12/interaction/customer/1003?$attribute=level,custom.credit_rating

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/xml
Accept-Language	en-US

Response
HTTP/1.1 200 OK

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/xml

Response body

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<customers
    xmlns="http://bindings.egain.com/ws/model/v12/gen/interaction/customer"
    xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/interaction/case"
    xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/interaction/activity"
    xmlns:ns4="http://bindings.egain.com/ws/model/v12/gen/platform"
    xmlns:ns5="http://bindings.egain.com/ws/model/v12/gen/common"
    xmlns:ns6="http://bindings.egain.com/ws/model/v12/gen/interaction/folder"
    xmlns:ns7="http://bindings.egain.com/ws/model/v12/gen/kb"
    xmlns:ns8="http://bindings.egain.com/ws/model/v15/gen/kb/edition"
    xmlns:ns9="http://bindings.egain.com/ws/model/v15/gen/kb/profile"
    xmlns:ns10="http://bindings.egain.com/ws/model/v12/gen/interaction/attachment"
    xmlns:ns11="http://bindings.egain.com/ws/model/v12/gen/mail/alias"
    xmlns:ns12="http://bindings.egain.com/ws/model/v12/gen/live/entrypoint"
    xmlns:ns13="http://bindings.egain.com/ws/model/v12/gen/interaction/contactperson"
    xmlns:ns14="http://bindings.egain.com/ws/model/v12/gen/interaction/contactpoint">
    <customer id="1003">
        <link rel="self" href="/system/ws/v12/interaction/customer/1003"/>
        <cases>
            <ns2:link rel="case" href="/system/ws/v12/interaction/case?customer=1003"/>
        </cases>
        <customerName>John Tierney</customerName>
        <type>
            <value>individual</value>
            <displayValue>Individual</displayValue>
        </type>
        <level>
            <ns5:value>premium</ns5:value>
            <ns5:displayValue>Premium</ns5:displayValue>
        </level>
        <lastModified date="2021-02-10T18:55:08.000Z"/>
        <customAttributes>
            <ns5:customAttribute>
                <ns5:attribName>credit_rating</ns5:attribName>
                <ns5:attribValues>
                    <ns5:attribValue>
                        <ns5:value>Good</ns5:value>
                        <ns5:displayValue>Good</ns5:displayValue>
                    </ns5:attribValue>
                </ns5:attribValues>
            </ns5:customAttribute>
        </customAttributes>
        <contactPersons>
            <ns13:contactPerson id="1003">
                <ns13:isSystemCreated>false</ns13:isSystemCreated>
                <ns13:salutation>Mr.</ns13:salutation>
                <ns13:firstName>John</ns13:firstName>
                <ns13:middleName>Russel</ns13:middleName>
                <ns13:lastName>Tierney</ns13:lastName>
                <ns13:loginId>jtierney</ns13:loginId>
                <ns13:lastModified date="2021-02-10T18:55:08.000Z"/>
                <ns13:contactPoints>
                    <ns14:contactPoint id="1060">
                        <ns14:type>
                            <ns14:value>phone</ns14:value>
                            <ns14:displayValue>Telephone</ns14:displayValue>
                            <ns14:phone>
                                <ns14:type>
                                    <ns5:value>home</ns5:value>
                                    <ns5:displayValue>Home phone number</ns5:displayValue>
                                </ns14:type>
                                <ns14:phoneNo>234 3456</ns14:phoneNo>
                                <ns14:countryCode>1</ns14:countryCode>
                                <ns14:areaCode>408</ns14:areaCode>
                                <ns14:extension>102</ns14:extension>
                                <ns14:availability>
                                    <ns14:days>
                                        <ns5:value>any_day</ns5:value>
                                        <ns5:displayValue>Any day</ns5:displayValue>
                                    </ns14:days>
                                    <ns14:times>
                                        <ns5:value>mornings</ns5:value>
                                        <ns5:displayValue>Mornings</ns5:displayValue>
                                    </ns14:times>
                                </ns14:availability>
                            </ns14:phone>
                        </ns14:type>
                        <ns14:lastModified date="2021-02-10T17:56:58.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1061">
                        <ns14:type>
                            <ns14:value>postal</ns14:value>
                            <ns14:displayValue>Postal</ns14:displayValue>
                            <ns14:postal>
                                <ns14:type>
                                    <ns5:value>office</ns5:value>
                                    <ns5:displayValue>Office address</ns5:displayValue>
                                </ns14:type>
                                <ns14:address_1>345</ns14:address_1>
                                <ns14:address_2>E Midfield Rd</ns14:address_2>
                                <ns14:city>Mountain View</ns14:city>
                                <ns14:state>Ca</ns14:state>
                                <ns14:zip>98704</ns14:zip>
                                <ns14:country>USA</ns14:country>
                                <ns14:region>United States</ns14:region>
                            </ns14:postal>
                        </ns14:type>
                        <ns14:lastModified date="2021-02-10T18:44:08.000Z"/>
                    </ns14:contactPoint>
                    <ns14:contactPoint id="1005">
                        <ns14:type>
                            <ns14:value>email</ns14:value>
                            <ns14:displayValue>Email</ns14:displayValue>
                            <ns14:email>
                                <ns14:emailAddress>john.tierney@customer.com</ns14:emailAddress>
                            </ns14:email>
                        </ns14:type>
                        <ns14:lastModified date="2021-02-10T17:56:58.000Z"/>
                    </ns14:contactPoint>
                </ns13:contactPoints>
            </ns13:contactPerson>
        </contactPersons>
    </customer>
</customers>

TRY IT OUT Try it out - Retrieve customers by IDs      

---

JSON

Request

Method	URL
GET	/ws/v12/interaction/customer/1003?$attribute=level,custom.credit_rating

Request headers

Name	Value
X-egain-session	Valid session ID
Accept	application/json
Accept-Language	en-US

Response
HTTP/1.1 200 OK

Response headers

Name	Value
X-egain-session	current session ID
Content-Type	application/json

Response body

{
    "customer": [
        {
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1042"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1042"
                }
            },
            "customerName": "John Tierney",
            "type": {
                "value": "individual",
                "displayValue": "Individual"
            },
            "level": {
                "value": "premium",
                "displayValue": "Premium"
            },
            "lastModified": {
                "date": "2016-04-26T02:02:12.000Z"
            },
            "customAttributes": {
                "customAttribute": [
                    {
                        "attribName": "credit_rating",
                        "attribValues": {
                            "attribValue": [
                                {
                                    "value": "Good",
                                    "displayValue": "Good"
                                }
                            ]
                        }
                    }
                ]
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "John",
                        "middleName": "Russel",
                        "lastName": "Tierney",
                        "lastModified": {
                            "date": "2016-04-26T01:22:06.000Z"
                        },
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "home",
                                                "displayValue": "home"
                                            },
                                            "phoneNo": "234 3456",
                                            "countryCode": "1",
                                            "areaCode": "408",
                                            "extension": "102",
                                            "availability": {
                                                "days": {
                                                    "value": "any_day",
                                                    "displayValue": "Any day"
                                                },
                                                "times": {
                                                    "value": "mornings",
                                                    "displayValue": "Mornings"
                                                }
                                            }
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "id": 1174
                                },
                                {
                                    "type": {
                                        "value": "postal",
                                        "displayValue": "Postal",
                                        "postal": {
                                            "type": {
                                                "value": "office",
                                                "displayValue": "Office address"
                                            },
                                            "address_1": "345",
                                            "address_2": "E Midfield Rd",
                                            "city": "Mountain View",
                                            "state": "Ca",
                                            "zip": "98704",
                                            "country": "USA",
                                            "region": "United States"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "id": 1175
                                },
                                {
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "john.tierney@customer.com"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2016-04-26T01:22:06.000Z"
                                    },
                                    "id": 1176
                                }
                            ]
                        },
                        "id": 1052
                    }
                ]
            },
            "id": 1042
        }
    ]
}

TRY IT OUT Try it out - Retrieve customers by IDs      

---