CustomerSearchExamples Class Reference

More...

Detailed Description

Examples for Customer Search

Example 1 - Search for customers by phone number with pagination parameters

This example demonstrates the following:

• Search for customers based on the phone number of their contact point.
• Sorting on customer type, in descending order
• Explicitly specifying the pagination parameters.
• Representation of the summary attributes of the customer
• Representation of paginated response, with links to previous and next pages.
  

XML

Request

Method	URL
GET	ws/v12/interaction/customer?phone=10101010&$sort=type&$order=desc&$pagenum=3&$pagesize=2

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"?>
<ns7:customers   xmlns="http://bindings.egain.com/ws/model/v12/gen/kb/topic"
    xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/platform"
    xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/common"
    xmlns:ns4="http://bindings.egain.com/ws/model/v12/gen/interaction/folder"
    xmlns:ns5="http://bindings.egain.com/ws/model/v12/gen/interaction/case"
    xmlns:ns6="http://bindings.egain.com/ws/model/v12/gen/interaction/activity"
    xmlns:ns7="http://bindings.egain.com/ws/model/v12/gen/interaction/customer"
    xmlns:ns8="http://bindings.egain.com/ws/model/v12/gen/interaction/contactperson"
    xmlns:ns9="http://bindings.egain.com/ws/model/v12/gen/interaction/contactpoint"
    xmlns:ns10="http://bindings.egain.com/ws/model/v12/gen/interaction/alias"
    xmlns:ns11="http://bindings.egain.com/ws/model/v12/gen/interaction/entrypoint"
    xmlns:ns12="http://bindings.egain.com/ws/model/v12/gen/kb"
    xmlns:ns13="http://bindings.egain.com/ws/model/v15/gen/kb/edition"
    xmlns:ns14="http://bindings.egain.com/ws/model/v15/gen/kb/profile">
   <ns7:link rel="self" href="/system/ws/v12/interaction/customer?phone=10101010&amp;$sort=type&amp;$order=desc&amp;$pagenum=3&amp;$pagesize=2" />
   <ns7:customer id="1012">
      <ns7:link rel="self" href="/system/ws/v12/interaction/customer/1012" />
      <ns7:cases>
         <ns5:link rel="case" href="/system/ws/v12/interaction/case?customer=1012" />
      </ns7:cases>
      <ns7:customerName>Corp_Cust5</ns7:customerName>
      <ns7:department id="1000">
         <ns2:name>QA</ns2:name>
      </ns7:department>
      <ns7:type>
         <ns7:value>corporate</ns7:value>
         <ns7:displayValue>Corporate</ns7:displayValue>        
      </ns7:type>
      <ns7:contactPersons>
         <ns8:contactPerson id="1012">
            <ns8:isSystemCreated>true</ns8:isSystemCreated>
            <ns8:firstName>#*Default CP#1012*#</ns8:firstName>
            <ns8:contactPoints>
               <ns9:contactPoint id="1012">
                  <ns9:type>
                     <ns9:value>phone</ns9:value>
                     <ns9:displayValue>Telephone</ns9:displayValue>
                     <ns9:phone>
                        <ns9:type>
                           <ns3:value>office</ns3:value>
                           <ns3:displayValue>Office phone number</ns3:displayValue>
                        </ns9:type>
                        <ns9:phoneNo>45345435</ns9:phoneNo>
                     </ns9:phone>
                  </ns9:type>
               </ns9:contactPoint>
               <ns9:contactPoint id="1013">
                  <ns9:type>
                     <ns9:value>phone</ns9:value>
                     <ns9:displayValue>Telephone</ns9:displayValue>
                     <ns9:phone>
                        <ns9:type>
                           <ns3:value>pager</ns3:value>
                           <ns3:displayValue>Pager</ns3:displayValue>
                        </ns9:type>
                        <ns9:phoneNo>3456765</ns9:phoneNo>
                     </ns9:phone>
                  </ns9:type>
               </ns9:contactPoint>
               <ns9:contactPoint id="1014">
                  <ns9:type>
                     <ns9:value>phone</ns9:value>
                     <ns9:displayValue>Telephone</ns9:displayValue>
                     <ns9:phone>
                        <ns9:type>
                           <ns3:value>mobile</ns3:value>
                           <ns3:displayValue>Cell</ns3:displayValue>
                        </ns9:type>
                        <ns9:phoneNo>10101010</ns9:phoneNo>
                     </ns9:phone>
                  </ns9:type>
               </ns9:contactPoint>
            </ns8:contactPoints>
         </ns8:contactPerson>
      </ns7:contactPersons>
   </ns7:customer>
   <ns7:customer id="1011">
      <ns7:link rel="self" href="/system/ws/v12/interaction/customer/1011" />
      <ns7:cases>
         <ns5:link rel="case" href="/system/ws/v12/interaction/case?customer=1011" />
      </ns7:cases>
      <ns7:customerName>Corp_Cust4</ns7:customerName>
      <ns7:department id="1000">
         <ns2:name>QA</ns2:name>
      </ns7:department>
      <ns7:type>
         <ns7:value>corporate</ns7:value>
         <ns7:displayValue>Corporate</ns7:displayValue>
         <ns7:corporate />
      </ns7:type>
      <ns7:contactPersons>
         <ns8:contactPerson id="1011">
            <ns8:isSystemCreated>true</ns8:isSystemCreated>
            <ns8:firstName>#*Default CP#1011*#</ns8:firstName>
            <ns8:contactPoints>
               <ns9:contactPoint id="1010">
                  <ns9:type>
                     <ns9:value>email</ns9:value>
                     <ns9:displayValue>Email</ns9:displayValue>
                     <ns9:email>
                        <ns9:emailAddress>email2@xyz.com</ns9:emailAddress>
                     </ns9:email>
                  </ns9:type>
               </ns9:contactPoint>
               <ns9:contactPoint id="1011">
                  <ns9:type>
                     <ns9:value>phone</ns9:value>
                     <ns9:displayValue>Telephone</ns9:displayValue>
                     <ns9:phone>
                        <ns9:type>
                           <ns3:value>home</ns3:value>
                           <ns3:displayValue>Home phone number</ns3:displayValue>
                        </ns9:type>
                        <ns9:phoneNo>10101010</ns9:phoneNo>
                     </ns9:phone>
                  </ns9:type>
               </ns9:contactPoint>
            </ns8:contactPoints>
         </ns8:contactPerson>
      </ns7:contactPersons>
   </ns7:customer>
   <ns7:paginationInfo>
      <ns3:count>6</ns3:count>
      <ns3:pagenum>3</ns3:pagenum>
      <ns3:pagesize>2</ns3:pagesize>
      <ns3:link rel="prev" href="/system/ws/v12/interaction/customer?phone=10101010&amp;$sort=type&amp;$order=desc&amp;$pagenum=2&amp;$pagesize=2" />
   </ns7:paginationInfo>
</ns7:customers>

TRY IT OUT Try it out - Customer search      

---

JSON

Request

Method	URL
GET	ws/v12/interaction/customer?phone=10101010&$sort=type&$order=desc&$pagenum=3&$pagesize=2

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

{
    "link": {
        "rel": "self",
        "href": "/system/ws/v12/interaction/customer?phone=10101010&$sort=type&$order=desc&$pagenum=3&$pagesize=2"
    },
    "customer": [
        {
            "id": 1012,
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1012"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1012"
                }
            },
            "customerName": "Corp_Cust5",
            "department": {
                "id": 1000,
                "name": "QA"
            },
            "type": {
                "value": "corporate",
                "displayValue": "Corporate"               
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "id": 1012,
                        "isSystemCreated": true,
                        "firstName": "#*Default CP#1012*#",
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "id": 1012,
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "office",
                                                "displayValue": "Office phone number"
                                            },
                                            "phoneNo": "45345435"
                                        }
                                    }
                                },
                                {
                                    "id": 1013,
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "pager",
                                                "displayValue": "Pager"
                                            },
                                            "phoneNo": "3456765"
                                        }
                                    }
                                },
                                {
                                    "id": 1014,
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "mobile",
                                                "displayValue": "Cell"
                                            },
                                            "phoneNo": "10101010"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        },
        {
            "id": 1011,
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1011"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1011"
                }
            },
            "customerName": "Corp_Cust4",
            "department": {
                "id": 1000,
                "name": "QA"
            },
            "type": {
                "value": "corporate",
                "displayValue": "Corporate",
                "corporate": {
                }
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "id": 1011,
                        "isSystemCreated": true,
                        "firstName": "#*Default CP#1011*#",
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "id": 1010,
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "email2@xyz.com"
                                        }
                                    }
                                },
                                {
                                    "id": 1011,
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "home",
                                                "displayValue": "Home phone number"
                                            },
                                            "phoneNo": "10101010"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ],
    "paginationInfo": {
        "count": 6,
        "pagenum": 3,
        "pagesize": 2,
        "link": [
            {
                "rel": "prev",
                "href": "/system/ws/v12/interaction/customer?phone=10101010&$sort=type&$order=desc&$pagenum=2&$pagesize=2"
            }
        ]
    }
}

TRY IT OUT Try it out - Customer search      

---

Example 2 - Search for customers by email address

This example demonstrates the following:

• Search for customers based on the email address of their contact point.
• Default sorting (on customerID, in ascending order)
• Specifying all attributes to be returned, and the representation of all the attributes in the response.
  

XML

Request

Method	URL
GET	ws/v12/interaction/customer?email=paul.dermick@customer.com&$attribute=all

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"?>
<ns7:customers   xmlns="http://bindings.egain.com/ws/model/v12/gen/kb/topic"
    xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/platform"
    xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/common"
    xmlns:ns4="http://bindings.egain.com/ws/model/v12/gen/interaction/folder"
    xmlns:ns5="http://bindings.egain.com/ws/model/v12/gen/interaction/case"
    xmlns:ns6="http://bindings.egain.com/ws/model/v12/gen/interaction/activity"
    xmlns:ns7="http://bindings.egain.com/ws/model/v12/gen/interaction/customer"
    xmlns:ns8="http://bindings.egain.com/ws/model/v12/gen/interaction/contactperson"
    xmlns:ns9="http://bindings.egain.com/ws/model/v12/gen/interaction/contactpoint"
    xmlns:ns10="http://bindings.egain.com/ws/model/v12/gen/interaction/alias"
    xmlns:ns11="http://bindings.egain.com/ws/model/v12/gen/interaction/entrypoint"
    xmlns:ns12="http://bindings.egain.com/ws/model/v12/gen/kb"
    xmlns:ns13="http://bindings.egain.com/ws/model/v15/gen/kb/edition"
    xmlns:ns14="http://bindings.egain.com/ws/model/v15/gen/kb/profile">
  <ns7:link rel="self" href="/system/ws/v12/interaction/customer?email=paul.dermick@customer.com&$attribute=all"/>
  <ns7:customer id="1036">
    <ns7:link rel="self" href="/system/ws/v12/interaction/customer/1036"/>
    <ns7:cases>
      <ns5:link rel="case" href="/system/ws/v12/interaction/case?customer=1036"/>
    </ns7:cases>
    <ns7:customerName>Paul Dermick</ns7:customerName>
    <ns7:department id="999">
      <ns2:name>Service</ns2:name>
    </ns7:department>
    <ns7:type>
      <ns7:value>individual</ns7:value>
      <ns7:displayValue>Individual</ns7:displayValue>
    </ns7:type>
    <ns7:level>
      <ns3:value>platinum</ns3:value>
      <ns3:displayValue>Platinum</ns3:displayValue>
    </ns7:level>
    <ns7:preferredAgent id="1015">
      <ns2:name>jenny</ns2:name>
      <ns2:firstName>Jenny</ns2:firstName>
      <ns2:lastName>Anthony</ns2:lastName>
    </ns7:preferredAgent>
    <ns7:created date="2014-12-24T08:39:14.000Z">
      <ns3:user id="12">
        <ns2:name>system</ns2:name>
        <ns2:firstName>System</ns2:firstName>
        <ns2:lastName>Services</ns2:lastName>
      </ns3:user>
    </ns7:created>
    <ns7:customAttributes>
      <ns3:customAttribute>
        <ns3:attribName>prefered_lang</ns3:attribName>
        <ns3:attribValues>
          <ns3:attribValue>
            <ns3:value>English</ns3:value>
          </ns3:attribValue>
        </ns3:attribValues>
      </ns3:customAttribute>
      <ns3:customAttribute>
        <ns3:attribName>credit_rating</ns3:attribName>
        <ns3:attribValues>
          <ns3:attribValue>
            <ns3:value>Good</ns3:value>
          </ns3:attribValue>
        </ns3:attribValues>
      </ns3:customAttribute>
      <ns3:customAttribute>
        <ns3:attribName>setup_in</ns3:attribName>
        <ns3:attribValues>
          <ns3:attribValue>
            <ns3:value>1234</ns3:value>
          </ns3:attribValue>
        </ns3:attribValues>
      </ns3:customAttribute>
      <ns3:customAttribute>
        <ns3:attribName>license_yrs</ns3:attribName>
        <ns3:attribValues>
          <ns3:attribValue>
            <ns3:value>12</ns3:value>
          </ns3:attribValue>
        </ns3:attribValues>
      </ns3:customAttribute>
    </ns7:customAttributes>
    <ns7:contactPersons>
      <ns8:contactPerson id="1038">
        <ns8:isSystemCreated>false</ns8:isSystemCreated>
        <ns8:salutation>Mr.</ns8:salutation>
        <ns8:firstName>Paul</ns8:firstName>
        <ns8:middleName>Dean</ns8:middleName>
        <ns8:lastName>Dermick</ns8:lastName>
        <ns8:loginId>      1038login</ns8:loginId>
        <ns8:jobTitle>Manager</ns8:jobTitle>
        <ns8:employmentStatus>
          <ns3:value>full-time</ns3:value>
          <ns3:displayValue>Full-time</ns3:displayValue>
        </ns8:employmentStatus>
        <ns8:dateOfBirth>1970-12-24T00:00:00.000Z</ns8:dateOfBirth>
        <ns8:gender>
          <ns3:value>male</ns3:value>
          <ns3:displayValue>Male</ns3:displayValue>
        </ns8:gender>
        <ns8:maritalStatus>
          <ns3:value>married</ns3:value>
          <ns3:displayValue>Married</ns3:displayValue>
        </ns8:maritalStatus>
        <ns8:identification>
          <ns8:type>License</ns8:type>
          <ns8:value>DL234123-9</ns8:value>
        </ns8:identification>
        <ns8:type>
          <ns3:value>shipping</ns3:value>
          <ns3:displayValue>Shipping</ns3:displayValue>
        </ns8:type>
        <ns8:firstNameFurigana>Paul</ns8:firstNameFurigana>
        <ns8:middleNameFurigana>Jean</ns8:middleNameFurigana>
        <ns8:lastNameFurigana>Dermick</ns8:lastNameFurigana>
        <ns8:suffix>
          <ns3:value>jr.</ns3:value>
          <ns3:displayValue>Jr.</ns3:displayValue>
        </ns8:suffix>
        <ns8:initials>DK</ns8:initials>
        <ns8:startGreeting>Hello</ns8:startGreeting>
        <ns8:endGreeting>Regards</ns8:endGreeting>
        <ns8:spouseName>Lisa</ns8:spouseName>
        <ns8:emergencyContact>4082321212</ns8:emergencyContact>
        <ns8:secretQuestion>Country of birth</ns8:secretQuestion>
        <ns8:secretAnswer>USA</ns8:secretAnswer>
        <ns8:occupation>Manufacturing</ns8:occupation>
        <ns8:incomeLevel>70000-100000</ns8:incomeLevel>
        <ns8:race>Asian</ns8:race>
        <ns8:dependents>2</ns8:dependents>
        <ns8:isSmoker>true</ns8:isSmoker>
        <ns8:hobbies>Hiking, Movies</ns8:hobbies>
        <ns8:interests>Gadgets</ns8:interests>
        <ns8:contactOrder>2314</ns8:contactOrder>
        <ns8:hasDirectMailingConsent>true</ns8:hasDirectMailingConsent>
        <ns8:hasDirectCallingConsent>true</ns8:hasDirectCallingConsent>
        <ns8:hasHoldingDataConsent>true</ns8:hasHoldingDataConsent>
        <ns8:contactPoints>
          <ns9:contactPoint id="1058">
            <ns9:type>
              <ns9:value>email</ns9:value>
              <ns9:displayValue>Email</ns9:displayValue>
              <ns9:email>
                <ns9:emailAddress>paul.dermick@customer.com</ns9:emailAddress>
              </ns9:email>
            </ns9:type>
            <ns9:lastModified date="2014-12-24T08:39:14.000Z"/>
          </ns9:contactPoint>
          <ns9:contactPoint id="1060">
            <ns9:type>
              <ns9:value>phone</ns9:value>
              <ns9:displayValue>Telephone</ns9:displayValue>
              <ns9:phone>
                <ns9:type>
                  <ns3:value>mobile</ns3:value>
                  <ns3:displayValue>Cell</ns3:displayValue>
                </ns9:type>
                <ns9:phoneNo>234 3456</ns9:phoneNo>
                <ns9:countryCode>1</ns9:countryCode>
                <ns9:areaCode>408</ns9:areaCode>
              </ns9:phone>
            </ns9:type>
            <ns9:lastModified date="2014-12-24T09:15:02.000Z"/>
          </ns9:contactPoint>
        </ns8:contactPoints>
      </ns8:contactPerson>
    </ns7:contactPersons>
    <ns7:notes rel="note" href="/system/ws/v12/interaction/customer/1011/note"/>
  </ns7:customer>
  <ns7:paginationInfo>
    <ns3:count>1</ns3:count>
    <ns3:pagenum>1</ns3:pagenum>
    <ns3:pagesize>25</ns3:pagesize>
  </ns7:paginationInfo>
</ns7:customers>

TRY IT OUT Try it out - Customer search      

---

JSON

Request

Method	URL
GET	ws/v12/interaction/customer?email=paul.dermick@customer.com&$attribute=all

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

{
    "link": {
        "rel": "self",
        "href": "/system/ws/v12/interaction/customer?email=paul.dermick@customer.com&$attribute=all"
    },
    "customer": [
        {
            "id": 1036,
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1036"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1036"
                }
            },
            "customerName": "Paul Dermick",
            "department": {
                "id": 999,
                "name": "Service"
            },
            "type": {
                "value": "individual",
                "displayValue": "Individual"
            },
            "level": {
                "value": "platinum",
                "displayValue": "Platinum"
            },
            "preferredAgent": {
                "id": 1015,
                "name": "jenny",
                "firstName": "Jenny",
                "lastName": "Anthony"
            },
            "created": {
                "date": "2014-12-24T08:39:14.000Z",
                "user": {
                    "id": 12,
                    "name": "system",
                    "firstName": "System",
                    "lastName": "Services"
                }
            },
            "customAttributes": {
                "customAttribute": [
                    {
                        "attribName": "prefered_lang",
                        "attribValues": {
                            "attribValue": [
                                {
                                    "value": "English"
                                }
                            ]
                        }
                    },
                    {
                        "attribName": "credit_rating",
                        "attribValues": {
                            "attribValue": [
                                {
                                    "value": "Good"
                                }
                            ]
                        }
                    },
                    {
                        "attribName": "setup_in",
                        "attribValues": {
                            "attribValue": [
                                {
                                    "value": "1234"
                                }
                            ]
                        }
                    },
                    {
                        "attribName": "license_yrs",
                        "attribValues": {
                            "attribValue": [
                                {
                                    "value": "12"
                                }
                            ]
                        }
                    }
                ]
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "id": 1038,
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "Paul",
                        "middleName": "Dean",
                        "lastName": "Dermick",
                        "loginId": "      1038login",
                        "jobTitle": "Manager",
                        "employmentStatus": {
                            "value": "full-time",
                            "displayValue": "Full-time"
                        },
                        "dateOfBirth": "1970-12-24T00:00:00.000Z",
                        "gender": {
                            "value": "male",
                            "displayValue": "Male"
                        },
                        "maritalStatus": {
                            "value": "married",
                            "displayValue": "Married"
                        },
                        "identification": {
                            "type": "License",
                            "value": "DL234123-9"
                        },
                        "type": {
                            "value": "shipping",
                            "displayValue": "Shipping"
                        },
                        "firstNameFurigana": "Paul",
                        "middleNameFurigana": "Jean",
                        "lastNameFurigana": "Dermick",
                        "suffix": {
                            "value": "jr.",
                            "displayValue": "Jr."
                        },
                        "initials": "DK",
                        "startGreeting": "Hello",
                        "endGreeting": "Regards",
                        "spouseName": "Lisa",
                        "emergencyContact": "4082321212",
                        "secretQuestion": "Country of birth",
                        "secretAnswer": "USA",
                        "occupation": "Manufacturing",
                        "incomeLevel": "70000-100000",
                        "race": "Asian",
                        "dependents": "2",
                        "isSmoker": true,
                        "hobbies": "Hiking, Movies",
                        "interests": "Gadgets",
                        "contactOrder": 2314,
                        "hasDirectMailingConsent": true,
                        "hasDirectCallingConsent": true,
                        "hasHoldingDataConsent": true,
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "id": 1058,
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "paul.dermick@customer.com"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2014-12-24T08:39:14.000Z"
                                    }
                                },
                                {
                                    "id": 1060,
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "mobile",
                                                "displayValue": "Cell"
                                            },
                                            "phoneNo": "234 3456",
                                            "countryCode": "1",
                                            "areaCode": "408"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2014-12-24T09:15:02.000Z"
                                    }
                                }
                            ]
                        }
                    }
                ]
            },         
            "notes": [
              {
                "rel": "note",
                "href": "/system/ws/v12/interaction/customer/1036/note"
              }
            ]
        }
    ],
    "paginationInfo": {
        "count": 1,
        "pagenum": 1,
        "pagesize": 25
    }
}

TRY IT OUT Try it out - Customer search      

---

Example 3 - Search for customers by custom attribute with range parameters

This example demonstrates the following:

• Search for customers on a custom attribute. In this example, we search on custom attribute credit_rating with the value of 'Good'.
• Specifying the range parameters. Since range parameters are specified, the response does not contain paginationInfo node.
• Sorting on a custom attribute, using default order (ascending order).
• Specifying additional attributes to be sent in the response. In this example, the additional attributes level and custom attribute credit_rating. This also shows the representation of the additional attributes in the response.
  

XML

Request

Method	URL
GET	ws/v12/interaction/customer?custom.credit_rating=Good&$sort=custom.credit_rating&$attribute=level,custom.credit_rating&$rangestart=2&$rangesize=4

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"?>
<ns7:customers   xmlns="http://bindings.egain.com/ws/model/v12/gen/kb/topic"
    xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/platform"
    xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/common"
    xmlns:ns4="http://bindings.egain.com/ws/model/v12/gen/interaction/folder"
    xmlns:ns5="http://bindings.egain.com/ws/model/v12/gen/interaction/case"
    xmlns:ns6="http://bindings.egain.com/ws/model/v12/gen/interaction/activity"
    xmlns:ns7="http://bindings.egain.com/ws/model/v12/gen/interaction/customer"
    xmlns:ns8="http://bindings.egain.com/ws/model/v12/gen/interaction/contactperson"
    xmlns:ns9="http://bindings.egain.com/ws/model/v12/gen/interaction/contactpoint"
    xmlns:ns10="http://bindings.egain.com/ws/model/v12/gen/interaction/alias"
    xmlns:ns11="http://bindings.egain.com/ws/model/v12/gen/interaction/entrypoint"
    xmlns:ns12="http://bindings.egain.com/ws/model/v12/gen/kb"
    xmlns:ns13="http://bindings.egain.com/ws/model/v15/gen/kb/edition"
    xmlns:ns14="http://bindings.egain.com/ws/model/v15/gen/kb/profile">
  <ns7:link rel="self" href="/system/ws/v12/interaction/customer?custom.credit_rating=Good&$sort=custom.credit_rating&$attribute=level,custom.credit_rating&$rangestart=2&$rangesize=4"/>
  <ns7:customer id="1036">
    <ns7:link rel="self" href="/system/ws/v12/interaction/customer/1036"/>
    <ns7:cases>
      <ns5:link rel="case" href="/system/ws/v12/interaction/case?customer=1036"/>
    </ns7:cases>
    <ns7:customerName>Paul Dermick</ns7:customerName>
    <ns7:department id="999">
      <ns2:name>Service</ns2:name>
    </ns7:department>
    <ns7:type>
      <ns7:value>individual</ns7:value>
      <ns7:displayValue>Individual</ns7:displayValue>
    </ns7:type>
    <ns7:level>
      <ns3:value>platinum</ns3:value>
      <ns3:displayValue>Platinum</ns3:displayValue>
    </ns7:level>
    <ns7:customAttributes>
      <ns3:customAttribute>
        <ns3:attribName>credit_rating</ns3:attribName>
        <ns3:attribValues>
          <ns3:attribValue>
            <ns3:value>Good</ns3:value>
          </ns3:attribValue>
        </ns3:attribValues>
      </ns3:customAttribute>
    </ns7:customAttributes>
    <ns7:contactPersons>
      <ns8:contactPerson id="1038">
        <ns8:isSystemCreated>false</ns8:isSystemCreated>
        <ns8:salutation>Mr.</ns8:salutation>
        <ns8:firstName>Paul</ns8:firstName>
        <ns8:middleName>Dean</ns8:middleName>
        <ns8:lastName>Dermick</ns8:lastName>
        <ns8:contactPoints>
          <ns9:contactPoint id="1058">
            <ns9:type>
              <ns9:value>email</ns9:value>
              <ns9:displayValue>Email</ns9:displayValue>
              <ns9:email>
                <ns9:emailAddress>paul.dermick@customer.com</ns9:emailAddress>
              </ns9:email>
            </ns9:type>
          </ns9:contactPoint>
          <ns9:contactPoint id="1060">
            <ns9:type>
              <ns9:value>phone</ns9:value>
              <ns9:displayValue>Telephone</ns9:displayValue>
              <ns9:phone>
                <ns9:type>
                  <ns3:value>mobile</ns3:value>
                  <ns3:displayValue>Cell</ns3:displayValue>
                </ns9:type>
                <ns9:phoneNo>234 3456</ns9:phoneNo>
                <ns9:countryCode>1</ns9:countryCode>
                <ns9:areaCode>408</ns9:areaCode>
              </ns9:phone>
            </ns9:type>
          </ns9:contactPoint>
        </ns8:contactPoints>
      </ns8:contactPerson>
    </ns7:contactPersons>
  </ns7:customer>
  <ns7:customer id="1040">
    <ns7:link rel="self" href="/system/ws/v12/interaction/customer/1040"/>
    <ns7:cases>
      <ns5:link rel="case" href="/system/ws/v12/interaction/case?customer=1040"/>
    </ns7:cases>
    <ns7:customerName>Svara Bank</ns7:customerName>
    <ns7:department id="999">
      <ns2:name>Service</ns2:name>
    </ns7:department>
    <ns7:type>
      <ns7:value>corporate</ns7:value>
      <ns7:displayValue>Corporate</ns7:displayValue>
      <ns7:corporate>
        <ns7:region>United States</ns7:region>
        <ns7:numberOfEmployees>234</ns7:numberOfEmployees>
        <ns7:revenues>220000000</ns7:revenues>
        <ns7:currency>USD</ns7:currency>
        <ns7:registrationNumber>56809</ns7:registrationNumber>
        <ns7:sector>Banking</ns7:sector>
      </ns7:corporate>
    </ns7:type>
    <ns7:level>
      <ns3:value>gold</ns3:value>
      <ns3:displayValue>Gold</ns3:displayValue>
    </ns7:level>
    <ns7:customAttributes>
      <ns3:customAttribute>
        <ns3:attribName>credit_rating</ns3:attribName>
        <ns3:attribValues>
          <ns3:attribValue>
            <ns3:value>Good</ns3:value>
          </ns3:attribValue>
        </ns3:attribValues>
      </ns3:customAttribute>
    </ns7:customAttributes>
    <ns7:contactPersons>
      <ns8:contactPerson id="1040">
        <ns8:isSystemCreated>true</ns8:isSystemCreated>
        <ns8:firstName>#*Default CP#1040*#</ns8:firstName>
        <ns8:contactPoints>
          <ns9:contactPoint id="1067">
            <ns9:type>
              <ns9:value>phone</ns9:value>
              <ns9:displayValue>Telephone</ns9:displayValue>
              <ns9:phone>
                <ns9:type>
                  <ns3:value>office</ns3:value>
                  <ns3:displayValue>Office phone number</ns3:displayValue>
                </ns9:type>
                <ns9:phoneNo>10101010</ns9:phoneNo>
              </ns9:phone>
            </ns9:type>
          </ns9:contactPoint>
          <ns9:contactPoint id="1070">
            <ns9:type>
              <ns9:value>phone</ns9:value>
              <ns9:displayValue>Telephone</ns9:displayValue>
              <ns9:phone>
                <ns9:type>
                  <ns3:value>home</ns3:value>
                  <ns3:displayValue>Home phone number</ns3:displayValue>
                </ns9:type>
                <ns9:phoneNo>234 3456</ns9:phoneNo>
                <ns9:countryCode>1</ns9:countryCode>
              </ns9:phone>
            </ns9:type>
          </ns9:contactPoint>
        </ns8:contactPoints>
      </ns8:contactPerson>
      <ns8:contactPerson id="1041">
        <ns8:isSystemCreated>false</ns8:isSystemCreated>
        <ns8:salutation>Mr.</ns8:salutation>
        <ns8:firstName>Fan</ns8:firstName>
        <ns8:middleName>Derick</ns8:middleName>
        <ns8:lastName>Vanman</ns8:lastName>
        <ns8:contactPoints>

          <ns9:contactPoint id="1064">
            <ns9:type>
              <ns9:value>postal</ns9:value>
              <ns9:displayValue>Postal</ns9:displayValue>
              <ns9:postal>
                <ns9:type>
                  <ns3:value>office</ns3:value>
                  <ns3:displayValue>Office address</ns3:displayValue>
                </ns9:type>
                <ns9:address_1>345</ns9:address_1>
                <ns9:address_2>E Midfield Rd</ns9:address_2>
                <ns9:city>Mountain View</ns9:city>
                <ns9:state>Ca</ns9:state>
                <ns9:zip>98704</ns9:zip>
                <ns9:country>USA</ns9:country>
                <ns9:region>United States</ns9:region>
              </ns9:postal>

            </ns9:type>
          </ns9:contactPoint>
          <ns9:contactPoint id="1063">
            <ns9:type>
              <ns9:value>email</ns9:value>
              <ns9:displayValue>Email</ns9:displayValue>
              <ns9:email>
                <ns9:emailAddress>vaman@svara.com</ns9:emailAddress>
              </ns9:email>
            </ns9:type>
          </ns9:contactPoint>
        </ns8:contactPoints>
      </ns8:contactPerson>
    </ns7:contactPersons>
  </ns7:customer>
</ns7:customers>

TRY IT OUT Try it out - Customer search      

---

JSON

Request

Method	URL
GET	ws/v12/interaction/customer?custom.credit_rating=Good&$sort=custom.credit_rating&$attribute=level,custom.credit_rating&$rangestart=2&$rangesize=4

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

{
    "link": {
        "rel": "self",
        "href": "/system/ws/v12/interaction/customer?custom.credit_rating=Good&$sort=custom.credit_rating&$attribute=level,custom.credit_rating&$rangestart=2&$rangesize=4"
    },
    "customer": [
        {
            "id": 1036,
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1036"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1036"
                }
            },
            "customerName": "Paul Dermick",
            "department": {
                "id": 999,
                "name": "Service"
            },
            "type": {
                "value": "individual",
                "displayValue": "Individual"
            },
            "level": {
                "value": "platinum",
                "displayValue": "Platinum"
            },
            "customAttributes": {
                "customAttribute": [
                    {
                        "attribName": "credit_rating",
                        "attribValues": {
                            "attribValue": [
                                {
                                    "value": "Good"
                                }
                            ]
                        }
                    }
                ]
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "id": 1038,
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "Paul",
                        "middleName": "Dean",
                        "lastName": "Dermick",
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "id": 1058,
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "paul.dermick@customer.com"
                                        }
                                    }
                                },
                                {
                                    "id": 1060,
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "mobile",
                                                "displayValue": "Cell"
                                            },
                                            "phoneNo": "234 3456",
                                            "countryCode": "1",
                                            "areaCode": "408"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        },
        {
            "id": 1040,
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1040"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1040"
                }
            },
            "customerName": "Svara Bank",
            "department": {
                "id": 999,
                "name": "Service"
            },
            "type": {
                "value": "corporate",
                "displayValue": "Corporate",
                "corporate": {
                    "region": "United States",
                    "numberOfEmployees": 234,
                    "revenues": "220000000",
                    "currency": "USD",
                    "registrationNumber": "56809",
                    "sector": "Banking"
                }
            },
            "level": {
                "value": "gold",
                "displayValue": "Gold"
            },
            "customAttributes": {
                "customAttribute": [
                    {
                        "attribName": "credit_rating",
                        "attribValues": {
                            "attribValue": [
                                {
                                    "value": "Good"
                                }
                            ]
                        }
                    }
                ]
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "id": 1040,
                        "isSystemCreated": true,
                        "firstName": "#*Default CP#1040*#",
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "id": 1067,
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "office",
                                                "displayValue": "Office phone number"
                                            },
                                            "phoneNo": "10101010"
                                        }
                                    }
                                },
                                {
                                    "id": 1070,
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "home",
                                                "displayValue": "Home phone number"
                                            },
                                            "phoneNo": "234 3456",
                                            "countryCode": "1"
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "id": 1041,
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "Fan",
                        "middleName": "Derick",
                        "lastName": "Vanman",
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "id": 1064,
                                    "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"
                                        }
                                    }
                                },
                                {
                                    "id": 1063,
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "vaman@svara.com"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ]
}

TRY IT OUT Try it out - Customer search      

---

Example 4 - Search for customers by phone number and custom attribute

This example demonstrates the following:

• Search for customers based on the phone number of their contact point and custom attribute credit_rating.
• Default sorting (sorting on customer ID in ascending order).
• Specifying an additional custom attribute to be returned, along with the summary attributes. In this example, the additionally requested custom attribute is credit_rating.
  

XML

Request

Method	URL
GET	ws/v12/interaction/customer?phone=1010101010&custom.credit_rating=Good&$attribute=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"?>
<ns7:customers   xmlns="http://bindings.egain.com/ws/model/v12/gen/kb/topic"
    xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/platform"
    xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/common"
    xmlns:ns4="http://bindings.egain.com/ws/model/v12/gen/interaction/folder"
    xmlns:ns5="http://bindings.egain.com/ws/model/v12/gen/interaction/case"
    xmlns:ns6="http://bindings.egain.com/ws/model/v12/gen/interaction/activity"
    xmlns:ns7="http://bindings.egain.com/ws/model/v12/gen/interaction/customer"
    xmlns:ns8="http://bindings.egain.com/ws/model/v12/gen/interaction/contactperson"
    xmlns:ns9="http://bindings.egain.com/ws/model/v12/gen/interaction/contactpoint"
    xmlns:ns10="http://bindings.egain.com/ws/model/v12/gen/interaction/alias"
    xmlns:ns11="http://bindings.egain.com/ws/model/v12/gen/interaction/entrypoint"
    xmlns:ns12="http://bindings.egain.com/ws/model/v12/gen/kb"
    xmlns:ns13="http://bindings.egain.com/ws/model/v15/gen/kb/edition"
    xmlns:ns14="http://bindings.egain.com/ws/model/v15/gen/kb/profile">
  <ns7:link rel="self" href="/system/ws/v12/interaction/customer?custom.credit_rating=Good&$sort=custom.credit_rating&$attribute=level,custom.credit_rating&$rangestart=2&$rangesize=4"/>
  <ns7:customer id="1036">
    <ns7:link rel="self" href="/system/ws/v12/interaction/customer/1036"/>
    <ns7:cases>
      <ns5:link rel="case" href="/system/ws/v12/interaction/case?customer=1036"/>
    </ns7:cases>
    <ns7:customerName>Paul Dermick</ns7:customerName>
    <ns7:department id="999">
      <ns2:name>Service</ns2:name>
    </ns7:department>
    <ns7:type>
      <ns7:value>individual</ns7:value>
      <ns7:displayValue>Individual</ns7:displayValue>
    </ns7:type>   
    <ns7:customAttributes>
      <ns3:customAttribute>
        <ns3:attribName>credit_rating</ns3:attribName>
        <ns3:attribValues>
          <ns3:attribValue>
            <ns3:value>Good</ns3:value>
          </ns3:attribValue>
        </ns3:attribValues>
      </ns3:customAttribute>
    </ns7:customAttributes>
    <ns7:contactPersons>
      <ns8:contactPerson id="1038">
        <ns8:isSystemCreated>false</ns8:isSystemCreated>
        <ns8:salutation>Mr.</ns8:salutation>
        <ns8:firstName>Paul</ns8:firstName>
        <ns8:middleName>Dean</ns8:middleName>
        <ns8:lastName>Dermick</ns8:lastName>
        <ns8:contactPoints>
          <ns9:contactPoint id="1058">
            <ns9:type>
              <ns9:value>email</ns9:value>
              <ns9:displayValue>Email</ns9:displayValue>
              <ns9:email>
                <ns9:emailAddress>paul.dermick@customer.com</ns9:emailAddress>
              </ns9:email>
            </ns9:type>
          </ns9:contactPoint>
          <ns9:contactPoint id="1060">
            <ns9:type>
              <ns9:value>phone</ns9:value>
              <ns9:displayValue>Telephone</ns9:displayValue>
              <ns9:phone>
                <ns9:type>
                  <ns3:value>mobile</ns3:value>
                  <ns3:displayValue>Cell</ns3:displayValue>
                </ns9:type>
                <ns9:phoneNo>1010101010</ns9:phoneNo>
              </ns9:phone>
            </ns9:type>
          </ns9:contactPoint>
        </ns8:contactPoints>
      </ns8:contactPerson>
    </ns7:contactPersons>
  </ns7:customer>
  <ns7:customer id="1040">
    <ns7:link rel="self" href="/system/ws/v12/interaction/customer/1040"/>
    <ns7:cases>
      <ns5:link rel="case" href="/system/ws/v12/interaction/case?customer=1040"/>
    </ns7:cases>
    <ns7:customerName>Svara Bank</ns7:customerName>
    <ns7:department id="999">
      <ns2:name>Service</ns2:name>
    </ns7:department>
    <ns7:type>
      <ns7:value>corporate</ns7:value>
      <ns7:displayValue>Corporate</ns7:displayValue>
      <ns7:corporate>
        <ns7:region>United States</ns7:region>
        <ns7:numberOfEmployees>234</ns7:numberOfEmployees>
        <ns7:revenues>220000000</ns7:revenues>
        <ns7:currency>USD</ns7:currency>
        <ns7:registrationNumber>56809</ns7:registrationNumber>
        <ns7:sector>Banking</ns7:sector>
      </ns7:corporate>
    </ns7:type>
    <ns7:customAttributes>
      <ns3:customAttribute>
        <ns3:attribName>credit_rating</ns3:attribName>
        <ns3:attribValues>
          <ns3:attribValue>
            <ns3:value>Good</ns3:value>
          </ns3:attribValue>
        </ns3:attribValues>
      </ns3:customAttribute>
    </ns7:customAttributes>
    <ns7:contactPersons>
      <ns8:contactPerson id="1040">
        <ns8:isSystemCreated>true</ns8:isSystemCreated>
        <ns8:firstName>#*Default CP#1040*#</ns8:firstName>
        <ns8:contactPoints>
          <ns9:contactPoint id="1067">
            <ns9:type>
              <ns9:value>phone</ns9:value>
              <ns9:displayValue>Telephone</ns9:displayValue>
              <ns9:phone>
                <ns9:type>
                  <ns3:value>office</ns3:value>
                  <ns3:displayValue>Office phone number</ns3:displayValue>
                </ns9:type>
                <ns9:phoneNo>1010101010</ns9:phoneNo>
              </ns9:phone>
            </ns9:type>
          </ns9:contactPoint>         
        </ns8:contactPoints>
      </ns8:contactPerson>
      <ns8:contactPerson id="1041">
        <ns8:isSystemCreated>false</ns8:isSystemCreated>
        <ns8:salutation>Mr.</ns8:salutation>
        <ns8:firstName>Fan</ns8:firstName>
        <ns8:middleName>Derick</ns8:middleName>
        <ns8:lastName>Vanman</ns8:lastName>
        <ns8:contactPoints>

          <ns9:contactPoint id="1064">
            <ns9:type>
              <ns9:value>postal</ns9:value>
              <ns9:displayValue>Postal</ns9:displayValue>
              <ns9:postal>
                <ns9:type>
                  <ns3:value>office</ns3:value>
                  <ns3:displayValue>Office address</ns3:displayValue>
                </ns9:type>
                <ns9:address_1>345</ns9:address_1>
                <ns9:address_2>E Midfield Rd</ns9:address_2>
                <ns9:city>Mountain View</ns9:city>
                <ns9:state>Ca</ns9:state>
                <ns9:zip>98704</ns9:zip>
                <ns9:country>USA</ns9:country>
                <ns9:region>United States</ns9:region>
              </ns9:postal>

            </ns9:type>
          </ns9:contactPoint>
          <ns9:contactPoint id="1063">
            <ns9:type>
              <ns9:value>email</ns9:value>
              <ns9:displayValue>Email</ns9:displayValue>
              <ns9:email>
                <ns9:emailAddress>vaman@svara.com</ns9:emailAddress>
              </ns9:email>
            </ns9:type>
          </ns9:contactPoint>
        </ns8:contactPoints>
      </ns8:contactPerson>
    </ns7:contactPersons>
  </ns7:customer>
</ns7:customers>

TRY IT OUT Try it out - Customer search      

---

JSON

Request

Method	URL
GET	ws/v12/interaction/customer?phone=1010101010&custom.credit_rating=Good&$attribute=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

{
    "link": {
        "rel": "self",
        "href": "/system/ws/v12/interaction/customer?custom.credit_rating=Good&$sort=custom.credit_rating&$attribute=level,custom.credit_rating&$rangestart=2&$rangesize=4"
    },
    "customer": [
        {
            "id": 1036,
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1036"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1036"
                }
            },
            "customerName": "Paul Dermick",
            "department": {
                "id": 999,
                "name": "Service"
            },
            "type": {
                "value": "individual",
                "displayValue": "Individual"
            },
            "customAttributes": {
                "customAttribute": [
                    {
                        "attribName": "credit_rating",
                        "attribValues": {
                            "attribValue": [
                                {
                                    "value": "Good"
                                }
                            ]
                        }
                    }
                ]
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "id": 1038,
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "Paul",
                        "middleName": "Dean",
                        "lastName": "Dermick",
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "id": 1058,
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "paul.dermick@customer.com"
                                        }
                                    }
                                },
                                {
                                    "id": 1060,
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "mobile",
                                                "displayValue": "Cell"
                                            },
                                            "phoneNo": "1010101010"                                           
                                        }
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        },
        {
            "id": 1040,
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1040"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1040"
                }
            },
            "customerName": "Svara Bank",
            "department": {
                "id": 999,
                "name": "Service"
            },
            "type": {
                "value": "corporate",
                "displayValue": "Corporate",
                "corporate": {
                    "region": "United States",
                    "numberOfEmployees": 234,
                    "revenues": "220000000",
                    "currency": "USD",
                    "registrationNumber": "56809",
                    "sector": "Banking"
                }
            },
            "customAttributes": {
                "customAttribute": [
                    {
                        "attribName": "credit_rating",
                        "attribValues": {
                            "attribValue": [
                                {
                                    "value": "Good"
                                }
                            ]
                        }
                    }
                ]
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "id": 1040,
                        "isSystemCreated": true,
                        "firstName": "#*Default CP#1040*#",
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "id": 1067,
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "office",
                                                "displayValue": "Office phone number"
                                            },
                                            "phoneNo": "1010101010"
                                        }
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "id": 1041,
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "Fan",
                        "middleName": "Derick",
                        "lastName": "Vanman",
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "id": 1064,
                                    "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"
                                        }
                                    }
                                },
                                {
                                    "id": 1063,
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "vaman@svara.com"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ]
}

TRY IT OUT Try it out - Customer search      

---

Example 5 - Search for customers by unread secure emails sent in provided range

This example demonstrates the following:

• Search for customers based on the unread secure email activities sent in provided range
• Default sorting (sorting on customer ID in ascending order).
  

XML

Request

Method	URL
GET	ws/v12/interaction/customer?activity={"type":"email","isRead":"false","isSecure":"true","mode":"outbound","sentDate":"[2021-02-13T21:00:42.000Z,2021-02-19T22:33:37.000Z]"}

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

TRY IT OUT Try it out - Customer search      

---

JSON

Request

Method	URL
GET	ws/v12/interaction/customer?activity={"type":"email","isRead":"false","isSecure":"true","mode":"outbound","sentDate":"[2021-02-13T21:00:42.000Z,2021-02-19T22:33:37.000Z]"}

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

TRY IT OUT Try it out - Customer search      

Example 6 - Search for customers by contact person object's custom attribute

This example demonstrates the following:

• Search for customers based on the contact person object's custom attribute
• Default sorting (on customerID, in ascending order)
  

XML

Request

Method	URL
GET	ws/v12/interaction/customer?contactPerson={"custom.cpn":"cpn_1001"}

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"?>
<ns7:customers
	xmlns="http://bindings.egain.com/ws/model/v12/gen/kb/topic"
	xmlns:ns2="http://bindings.egain.com/ws/model/v12/gen/platform"
	xmlns:ns3="http://bindings.egain.com/ws/model/v12/gen/common"
	xmlns:ns4="http://bindings.egain.com/ws/model/v12/gen/interaction/folder"
	xmlns:ns5="http://bindings.egain.com/ws/model/v12/gen/interaction/case"
	xmlns:ns6="http://bindings.egain.com/ws/model/v12/gen/interaction/activity"
	xmlns:ns7="http://bindings.egain.com/ws/model/v12/gen/interaction/customer"
	xmlns:ns8="http://bindings.egain.com/ws/model/v12/gen/interaction/contactperson"
	xmlns:ns9="http://bindings.egain.com/ws/model/v12/gen/interaction/contactpoint"
	xmlns:ns10="http://bindings.egain.com/ws/model/v12/gen/interaction/alias"
	xmlns:ns11="http://bindings.egain.com/ws/model/v12/gen/interaction/entrypoint"
	xmlns:ns12="http://bindings.egain.com/ws/model/v12/gen/kb"
	xmlns:ns13="http://bindings.egain.com/ws/model/v15/gen/kb/edition"
	xmlns:ns14="http://bindings.egain.com/ws/model/v15/gen/kb/profile">
	<ns7:link rel="self" href="/system/ws/v12/interaction/customer?contactPerson=%7B%22custom.cpn%22:%22cpn_1001%22%7D"/>
	<ns7:customer id="1036">
		<ns7:link rel="self" href="/system/ws/v12/interaction/customer/1036"/>
		<ns7:cases>
			<ns5:link rel="case" href="/system/ws/v12/interaction/case?customer=1036"/>
		</ns7:cases>
		<ns7:customerName>Paul Dermick</ns7:customerName>
		<ns7:department id="999">
			<ns2:name>Service</ns2:name>
		</ns7:department>
		<ns7:type>
			<ns7:value>individual</ns7:value>
			<ns7:displayValue>Individual</ns7:displayValue>
		</ns7:type>
		<ns7:contactPersons>
			<ns8:contactPerson id="1038">
				<ns8:isSystemCreated>false</ns8:isSystemCreated>
				<ns8:salutation>Mr.</ns8:salutation>
				<ns8:firstName>Paul</ns8:firstName>
				<ns8:middleName>Dean</ns8:middleName>
				<ns8:lastName>Dermick</ns8:lastName>
				<ns8:loginId>1038login</ns8:loginId>
				<ns8:contactPoints>
					<ns9:contactPoint id="1058">
						<ns9:type>
							<ns9:value>email</ns9:value>
							<ns9:displayValue>Email</ns9:displayValue>
							<ns9:email>
								<ns9:emailAddress>paul.dermick@customer.com</ns9:emailAddress>
							</ns9:email>
						</ns9:type>
						<ns9:lastModified date="2014-12-24T08:39:14.000Z"/>
					</ns9:contactPoint>
					<ns9:contactPoint id="1060">
						<ns9:type>
							<ns9:value>phone</ns9:value>
							<ns9:displayValue>Telephone</ns9:displayValue>
							<ns9:phone>
								<ns9:type>
									<ns3:value>mobile</ns3:value>
									<ns3:displayValue>Cell</ns3:displayValue>
								</ns9:type>
								<ns9:phoneNo>234 3456</ns9:phoneNo>
								<ns9:countryCode>1</ns9:countryCode>
								<ns9:areaCode>408</ns9:areaCode>
							</ns9:phone>
						</ns9:type>
						<ns9:lastModified date="2014-12-24T09:15:02.000Z"/>
					</ns9:contactPoint>
				</ns8:contactPoints>
			</ns8:contactPerson>
		</ns7:contactPersons>
	</ns7:customer>
	<ns7:paginationInfo>
		<ns3:count>1</ns3:count>
		<ns3:pagenum>1</ns3:pagenum>
		<ns3:pagesize>25</ns3:pagesize>
	</ns7:paginationInfo>
</ns7:customers>

TRY IT OUT Try it out - Customer search      

---

JSON

Request

Method	URL
GET	ws/v12/interaction/customer?contactPerson={"custom.cpn":"cpn_1001"}

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

{
    "link": {
        "rel": "self",
        "href": "/system/ws/v12/interaction/customer?contactPerson=%7B%22custom.cpn%22:%22cpn_1001%22%7D"
    },
    "customer": [
        {
            "id": 1036,
            "link": {
                "rel": "self",
                "href": "/system/ws/v12/interaction/customer/1036"
            },
            "cases": {
                "link": {
                    "rel": "case",
                    "href": "/system/ws/v12/interaction/case?customer=1036"
                }
            },
            "customerName": "Paul Dermick",
            "department": {
                "id": 999,
                "name": "Service"
            },
            "type": {
                "value": "individual",
                "displayValue": "Individual"
            },
            "contactPersons": {
                "contactPerson": [
                    {
                        "id": 1038,
                        "isSystemCreated": false,
                        "salutation": "Mr.",
                        "firstName": "Paul",
                        "middleName": "Dean",
                        "lastName": "Dermick",
                        "loginId": "1038login",
                        "contactPoints": {
                            "contactPoint": [
                                {
                                    "id": 1058,
                                    "type": {
                                        "value": "email",
                                        "displayValue": "Email",
                                        "email": {
                                            "emailAddress": "paul.dermick@customer.com"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2014-12-24T08:39:14.000Z"
                                    }
                                },
                                {
                                    "id": 1060,
                                    "type": {
                                        "value": "phone",
                                        "displayValue": "Telephone",
                                        "phone": {
                                            "type": {
                                                "value": "mobile",
                                                "displayValue": "Cell"
                                            },
                                            "phoneNo": "234 3456",
                                            "countryCode": "1",
                                            "areaCode": "408"
                                        }
                                    },
                                    "lastModified": {
                                        "date": "2014-12-24T09:15:02.000Z"
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ],
    "paginationInfo": {
        "count": 1,
        "pagenum": 1,
        "pagesize": 25
    }
}

TRY IT OUT Try it out - Customer search