GetCustomerAttributesExamples Class Reference

Detailed Description

Examples for Retrieve Customer Attribute Metadata

Example 1 - Get metadata for an attribute

This example demonstrates the following:

• Getting metadata for a single attribute. This example retrieves the details of the "type" attribute of the customer resource.

XML

Request

Method	URL
GET	/ws/v12/interaction/customer/attributes?$attribute=type

Request headers

Name	Values
X-egain-session	valid session ID
Accept	application/xml
Accept-Language	en-US

Response:
HTTP/1.1 200 OK

Response headers

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

Response body

<?xml version="1.0" encoding="UTF-8"?>
<attributes xmlns="http://bindings.egain.com/ws/model/v12/gen/common/attribute" resource="customer">
    <attribute name="type">
        <attribute name="group">
            <attribute name="type">
                <dataSize>255</dataSize>
                <dataType>stringList</dataType>
                <options>
                    <option>
                        <value>association</value>
                        <displayValue>Association</displayValue>
                    </option>
                    <option>
                        <value>club</value>
                        <displayValue>Club</displayValue>
                    </option>
                    <option>
                        <value>household</value>
                        <displayValue>Household</displayValue>
                    </option>
                    <option>
                        <value>joint_account</value>
                        <displayValue>Joint Account</displayValue>
                    </option>
                    <option>
                        <value>membership</value>
                        <displayValue>Membership</displayValue>
                    </option>
                    <option>
                        <value>other</value>
                        <displayValue>Other</displayValue>
                    </option>
                    <option>
                        <value>test121</value>
                        <displayValue>Test121</displayValue>
                    </option>
                </options>
            </attribute>
            <attribute name="region">
                <dataSize>255</dataSize>
                <dataType>stringList</dataType>
                <options>
                    <option>
                        <value>Asia Pacific</value>
                    </option>
                    <option>
                        <value>Austrlasia</value>
                    </option>
                    <option>
                        <value>Europe</value>
                    </option>
                    <option>
                        <value>United States</value>
                    </option>
                </options>
            </attribute>
        </attribute>
        <attribute name="corporate">
            <attribute name="region">
                <dataSize>255</dataSize>
                <dataType>stringList</dataType>
                <options>
                    <option>
                        <value>Asia Pacific</value>
                    </option>
                    <option>
                        <value>Austrlasia</value>
                    </option>
                    <option>
                        <value>Europe</value>
                    </option>
                    <option>
                        <value>United States</value>
                    </option>
                </options>
            </attribute>
        </attribute>
    </attribute>
</attributes>

TRY IT OUT Try it out - Retrieve customer attributes      

---

JSON

Request

Method	URL
GET	/ws/v12/interaction/customer/attributes?$attribute=type

Request headers

Name	Values
X-egain-session	valid session ID
Accept	application/json
Accept-Language	en-US

Response:
HTTP/1.1 200 OK

Response headers

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

Response body

{
    "attribute": [
        {
            "attribute": [
                {
                    "attribute": [
                        {
                            "dataSize": 255,
                            "dataType": "stringList",
                            "options": {
                                "option": [
                                    {
                                        "value": "association",
                                        "displayValue": "Association"
                                    },
                                    {
                                        "value": "club",
                                        "displayValue": "Club"
                                    },
                                    {
                                        "value": "household",
                                        "displayValue": "Household"
                                    },
                                    {
                                        "value": "joint_account",
                                        "displayValue": "Joint Account"
                                    },
                                    {
                                        "value": "membership",
                                        "displayValue": "Membership"
                                    },
                                    {
                                        "value": "other",
                                        "displayValue": "Other"
                                    },
                                    {
                                        "value": "test121",
                                        "displayValue": "Test121"
                                    }
                                ]
                            },
                            "name": "type"
                        },
                        {
                            "dataSize": 255,
                            "dataType": "stringList",
                            "options": {
                                "option": [
                                    {
                                        "value": "Asia Pacific"
                                    },
                                    {
                                        "value": "Austrlasia"
                                    },
                                    {
                                        "value": "Europe"
                                    },
                                    {
                                        "value": "United States"
                                    }
                                ]
                            },
                            "name": "region"
                        }
                    ],
                    "name": "group"
                },
                {
                    "attribute": [
                        {
                            "dataSize": 255,
                            "dataType": "stringList",
                            "options": {
                                "option": [
                                    {
                                        "value": "Asia Pacific"
                                    },
                                    {
                                        "value": "Austrlasia"
                                    },
                                    {
                                        "value": "Europe"
                                    },
                                    {
                                        "value": "United States"
                                    }
                                ]
                            },
                            "name": "region"
                        }
                    ],
                    "name": "corporate"
                }
            ],
            "name": "type"
        }
    ],
    "resource": "customer"
}

TRY IT OUT Try it out - Retrieve customer attributes      

Example 2 - Get metadata for multiple attributes

This example demonstrates the following:

• Getting the metadata for multiple attributes. This example gets the metadata for the following attributes: country, industry, level and contactPersons.

XML

Request

Method	URL
GET	/ws/v12/interaction/customer/attributes?$attribute=country,industry,level,contactPersons

Request headers

Name	Values
X-egain-session	valid session ID
Accept	application/xml
Accept-Language	en-US

Response:
HTTP/1.1 200 OK

Response headers

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

Response body

<?xml version="1.0" encoding="UTF-8"?>
<attributes xmlns="http://bindings.egain.com/ws/model/v12/gen/common/attribute" resource="customer">
    <attribute name="country">
        <dataSize>255</dataSize>
        <dataType>stringList</dataType>
        <options>
            <option>
                <value>Afghanistan</value>
            </option>
            <option>
                <value>Albania</value>
            </option>
             <!-- .... more countries -->
        </options>
    </attribute>
    <attribute name="industry">
        <dataSize>255</dataSize>
        <dataType>stringList</dataType>
        <options>
            <option>
                <value>finance</value>
                <displayValue>Finance</displayValue>
            </option>
            <option>
                <value>health_care</value>
                <displayValue>Health care</displayValue>
            </option>
            <option>
                <value>telecom</value>
                <displayValue>Telecom</displayValue>
            </option>
        </options>
    </attribute>
    <attribute name="level">
        <dataSize>255</dataSize>
        <dataType>stringList</dataType>
        <options>
            <option>
                <value>gold</value>
                <displayValue>Gold</displayValue>
            </option>
            <option>
                <value>platinum</value>
                <displayValue>Platinum</displayValue>
            </option>
            <option>
                <value>premium</value>
                <displayValue>Premium</displayValue>
            </option>
            <option>
                <value>silver</value>
                <displayValue>Silver</displayValue>
            </option>
            <option>
                <value>standard</value>
                <displayValue>Standard</displayValue>
            </option>
        </options>
    </attribute>
    <attribute name="contactPersons">
        <attribute name="contactPerson">
            <attribute name="type">
                <dataSize>255</dataSize>
                <dataType>stringList</dataType>
                <options>
                    <option>
                        <value>billing</value>
                        <displayValue>Billing</displayValue>
                    </option>
                    <option>
                        <value>legal</value>
                        <displayValue>Legal</displayValue>
                    </option>
                    <option>
                        <value>shipping</value>
                        <displayValue>Shipping</displayValue>
                    </option>
                    <option>
                        <value>technical</value>
                        <displayValue>Technical</displayValue>
                    </option>
                </options>
            </attribute>
            <attribute name="identification">
                <attribute name="type">
                    <dataSize>255</dataSize>
                    <dataType>stringList</dataType>
                    <options>
                        <option>
                            <value>License</value>
                        </option>
                        <option>
                            <value>Passport</value>
                        </option>
                        <option>
                            <value>SSN</value>
                        </option>
                    </options>
                </attribute>
            </attribute>
            <attribute name="second_id" custom="true">
                <dataSize>8</dataSize>
                <dataType>stringList</dataType>
                <options isMultiSelect="false">
                    <option>
                        <value>1</value>
                        <displayValue>Passport</displayValue>
                    </option>
                    <option>
                        <value>2</value>
                        <displayValue>Driving License</displayValue>
                    </option>
                    <option>
                        <value>3</value>
                        <displayValue>SSN</displayValue>
                    </option>
                    <option>
                        <value>4</value>
                        <displayValue>DMV ID</displayValue>
                    </option>
                </options>
            </attribute>
            <attribute name="second_id_value" custom="true">
                <dataSize>100</dataSize>
                <dataType>string</dataType>
            </attribute>
            <attribute name="contactPoints">
                <attribute name="contactPoint">
                    <attribute name="activeness" custom="true">
                        <dataSize>9</dataSize>
                        <dataType>integer</dataType>
                    </attribute>
                </attribute>
            </attribute>
        </attribute>
    </attribute>
</attributes>

TRY IT OUT Try it out - Retrieve customer attributes      

---

JSON

Request

Method	URL
GET	/ws/v12/interaction/customer/attributes?$attribute=country,industry,level,contactPersons

Request headers

Name	Values
X-egain-session	valid session ID
Accept	application/json
Accept-Language	en-US

Response:
HTTP/1.1 200 OK

Response headers

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

Response body

{
    "attribute": [
        {
            "dataSize": 255,
            "dataType": "stringList",
            "options": {
                "option": [
                    {
                        "value": "Afghanistan"
                    },
                    {
                        "value": "Albania"
                    }
                    <!-- .... more countries -->
                ]
            },
            "name": "country"
        },
        {
            "dataSize": 255,
            "dataType": "stringList",
            "options": {
                "option": [
                    {
                        "value": "finance",
                        "displayValue": "Finance"
                    },
                    {
                        "value": "health_care",
                        "displayValue": "Health care"
                    },
                    {
                        "value": "telecom",
                        "displayValue": "Telecom"
                    }
                ]
            },
            "name": "industry"
        },
        {
            "dataSize": 255,
            "dataType": "stringList",
            "options": {
                "option": [
                    {
                        "value": "gold",
                        "displayValue": "Gold"
                    },
                    {
                        "value": "platinum",
                        "displayValue": "Platinum"
                    },
                    {
                        "value": "premium",
                        "displayValue": "Premium"
                    },
                    {
                        "value": "silver",
                        "displayValue": "Silver"
                    },
                    {
                        "value": "standard",
                        "displayValue": "Standard"
                    }
                ]
            },
            "name": "level"
        },
        {
            "attribute": [
                {
                    "attribute": [
                        {
                            "dataSize": 255,
                            "dataType": "stringList",
                            "options": {
                                "option": [
                                    {
                                        "value": "billing",
                                        "displayValue": "Billing"
                                    },
                                    {
                                        "value": "legal",
                                        "displayValue": "Legal"
                                    },
                                    {
                                        "value": "shipping",
                                        "displayValue": "Shipping"
                                    },
                                    {
                                        "value": "technical",
                                        "displayValue": "Technical"
                                    }
                                ]
                            },
                            "name": "type"
                        },
                        {
                            "attribute": [
                                {
                                    "dataSize": 255,
                                    "dataType": "stringList",
                                    "options": {
                                        "option": [
                                            {
                                                "value": "License"
                                            },
                                            {
                                                "value": "Passport"
                                            },
                                            {
                                                "value": "SSN"
                                            }
                                        ]
                                    },
                                    "name": "type"
                                }
                            ],
                            "name": "identification"
                        },
                        {
                            "dataSize": 8,
                            "dataType": "stringList",
                            "options": {
                                "option": [
                                    {
                                        "value": "1",
                                        "displayValue": "Passport"
                                    },
                                    {
                                        "value": "2",
                                        "displayValue": "Driving License"
                                    },
                                    {
                                        "value": "3",
                                        "displayValue": "SSN"
                                    },
                                    {
                                        "value": "4",
                                        "displayValue": "DMV ID"
                                    }
                                ],
                                "isMultiSelect": false
                            },
                            "name": "second_id",
                            "custom": true
                        },
                        {
                            "dataSize": 100,
                            "dataType": "string",
                            "name": "second_id_value",
                            "custom": true
                        },
                        {
                            "attribute": [
                                {
                                    "attribute": [
                                        {
                                            "dataSize": 9,
                                            "dataType": "integer",
                                            "name": "activeness",
                                            "custom": true
                                        }
                                    ],
                                    "name": "contactPoint"
                                }
                            ],
                            "name": "contactPoints"
                        }
                    ],
                    "name": "contactPerson"
                }
            ],
            "name": "contactPersons"
        }
    ],
    "resource": "customer"
}

TRY IT OUT Try it out - Retrieve customer attributes      

Example 3 - Get metadata for all attributes

This example demonstrates the following:

• Getting the metadata for all the attributes of the customer resource.

XML

Request

Method	URL
GET	/ws/v12/interaction/customer/attributes?$attribute=all

Request headers

Name	Values
X-egain-session	valid session ID
Accept	application/xml
Accept-Language	en-US

Response:
HTTP/1.1 200 OK

Response headers

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

Response body

<?xml version="1.0" encoding="UTF-8"?>
<attributes xmlns="http://bindings.egain.com/ws/model/v12/gen/common/attribute" resource="customer">
    <attribute name="type">
        <attribute name="group">
            <attribute name="type">
                <dataSize>255</dataSize>
                <dataType>stringList</dataType>
                <options>
                    <option>
                        <value>association</value>
                        <displayValue>Association</displayValue>
                    </option>
                    <option>
                        <value>club</value>
                        <displayValue>Club</displayValue>
                    </option>
                    <option>
                        <value>household</value>
                        <displayValue>Household</displayValue>
                    </option>
                    <option>
                        <value>joint_account</value>
                        <displayValue>Joint Account</displayValue>
                    </option>
                    <option>
                        <value>membership</value>
                        <displayValue>Membership</displayValue>
                    </option>
                    <option>
                        <value>other</value>
                        <displayValue>Other</displayValue>
                    </option>
                    <option>
                        <value>test121</value>
                        <displayValue>Test121</displayValue>
                    </option>
                </options>
            </attribute>
            <attribute name="region">
                <dataSize>255</dataSize>
                <dataType>stringList</dataType>
                <options>
                    <option>
                        <value>Asia Pacific</value>
                    </option>
                    <option>
                        <value>Austrlasia</value>
                    </option>
                    <option>
                        <value>Europe</value>
                    </option>
                    <option>
                        <value>United States</value>
                    </option>
                </options>
            </attribute>
        </attribute>
        <attribute name="corporate">
            <attribute name="region">
                <dataSize>255</dataSize>
                <dataType>stringList</dataType>
                <options>
                    <option>
                        <value>Asia Pacific</value>
                    </option>
                    <option>
                        <value>Austrlasia</value>
                    </option>
                    <option>
                        <value>Europe</value>
                    </option>
                    <option>
                        <value>United States</value>
                    </option>
                </options>
            </attribute>
        </attribute>
    </attribute>
    <attribute name="country">
        <dataSize>255</dataSize>
        <dataType>stringList</dataType>
        <options>
            <option>
                <value>Afghanistan</value>
            </option>
            <option>
                <value>Albania</value>
            </option>
            <!-- .... more countries -->
        </options>
    </attribute>
    <attribute name="industry">
        <dataSize>255</dataSize>
        <dataType>stringList</dataType>
        <options>
            <option>
                <value>finance</value>
                <displayValue>Finance</displayValue>
            </option>
            <option>
                <value>health_care</value>
                <displayValue>Health care</displayValue>
            </option>
            <option>
                <value>telecom</value>
                <displayValue>Telecom</displayValue>
            </option>
        </options>
    </attribute>
    <attribute name="level">
        <dataSize>255</dataSize>
        <dataType>stringList</dataType>
        <options>
            <option>
                <value>gold</value>
                <displayValue>Gold</displayValue>
            </option>
            <option>
                <value>platinum</value>
                <displayValue>Platinum</displayValue>
            </option>
            <option>
                <value>premium</value>
                <displayValue>Premium</displayValue>
            </option>
            <option>
                <value>silver</value>
                <displayValue>Silver</displayValue>
            </option>
            <option>
                <value>standard</value>
                <displayValue>Standard</displayValue>
            </option>
        </options>
    </attribute>
    <attribute name="operations_in" custom="true">
        <dataSize>1055</dataSize>
        <dataType>stringList</dataType>
        <options isMultiSelect="true">
            <option>
                <value>1</value>
                <displayValue>Washington</displayValue>
            </option>
            <option>
                <value>2</value>
                <displayValue>New York</displayValue>
            </option>
            <option>
                <value>3</value>
                <displayValue>San Jose</displayValue>
            </option>
            <option>
                <value>4</value>
                <displayValue>Chicago</displayValue>
            </option>
        </options>
    </attribute>
    <attribute name="contactPersons">
        <attribute name="contactPerson">
            <attribute name="type">
                <dataSize>255</dataSize>
                <dataType>stringList</dataType>
                <options>
                    <option>
                        <value>billing</value>
                        <displayValue>Billing</displayValue>
                    </option>
                    <option>
                        <value>legal</value>
                        <displayValue>Legal</displayValue>
                    </option>
                    <option>
                        <value>shipping</value>
                        <displayValue>Shipping</displayValue>
                    </option>
                    <option>
                        <value>technical</value>
                        <displayValue>Technical</displayValue>
                    </option>
                </options>
            </attribute>
            <attribute name="identification">
                <attribute name="type">
                    <dataSize>255</dataSize>
                    <dataType>stringList</dataType>
                    <options>
                        <option>
                            <value>License</value>
                        </option>
                        <option>
                            <value>Passport</value>
                        </option>
                        <option>
                            <value>SSN</value>
                        </option>
                    </options>
                </attribute>
            </attribute>
            <attribute name="second_id" custom="true">
                <dataSize>8</dataSize>
                <dataType>stringList</dataType>
                <options isMultiSelect="false">
                    <option>
                        <value>1</value>
                        <displayValue>Passport</displayValue>
                    </option>
                    <option>
                        <value>2</value>
                        <displayValue>Driving License</displayValue>
                    </option>
                    <option>
                        <value>3</value>
                        <displayValue>SSN</displayValue>
                    </option>
                    <option>
                        <value>4</value>
                        <displayValue>DMV ID</displayValue>
                    </option>
                </options>
            </attribute>
            <attribute name="second_id_value" custom="true">
                <dataSize>100</dataSize>
                <dataType>string</dataType>
            </attribute>
            <attribute name="contactPoints">
                <attribute name="contactPoint">
                    <attribute name="activeness" custom="true">
                        <dataSize>9</dataSize>
                        <dataType>integer</dataType>
                    </attribute>
                </attribute>
            </attribute>
        </attribute>
    </attribute>
</attributes>

TRY IT OUT Try it out - Retrieve customer attributes      

---

JSON

Request

Method	URL
GET	/ws/v12/interaction/customer/attributes?$attribute=all

Request headers

Name	Values
X-egain-session	valid session ID
Accept	application/json
Accept-Language	en-US

Response:
HTTP/1.1 200 OK

Response headers

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

Response body

{
    "attribute": [
        {
            "attribute": [
                {
                    "attribute": [
                        {
                            "dataSize": 255,
                            "dataType": "stringList",
                            "options": {
                                "option": [
                                    {
                                        "value": "association",
                                        "displayValue": "Association"
                                    },
                                    {
                                        "value": "club",
                                        "displayValue": "Club"
                                    },
                                    {
                                        "value": "household",
                                        "displayValue": "Household"
                                    },
                                    {
                                        "value": "joint_account",
                                        "displayValue": "Joint Account"
                                    },
                                    {
                                        "value": "membership",
                                        "displayValue": "Membership"
                                    },
                                    {
                                        "value": "other",
                                        "displayValue": "Other"
                                    },
                                    {
                                        "value": "test121",
                                        "displayValue": "Test121"
                                    }
                                ]
                            },
                            "name": "type"
                        },
                        {
                            "dataSize": 255,
                            "dataType": "stringList",
                            "options": {
                                "option": [
                                    {
                                        "value": "Asia Pacific"
                                    },
                                    {
                                        "value": "Austrlasia"
                                    },
                                    {
                                        "value": "Europe"
                                    },
                                    {
                                        "value": "United States"
                                    }
                                ]
                            },
                            "name": "region"
                        }
                    ],
                    "name": "group"
                },
                {
                    "attribute": [
                        {
                            "dataSize": 255,
                            "dataType": "stringList",
                            "options": {
                                "option": [
                                    {
                                        "value": "Asia Pacific"
                                    },
                                    {
                                        "value": "Austrlasia"
                                    },
                                    {
                                        "value": "Europe"
                                    },
                                    {
                                        "value": "United States"
                                    }
                                ]
                            },
                            "name": "region"
                        }
                    ],
                    "name": "corporate"
                }
            ],
            "name": "type"
        },
        {
            "dataSize": 255,
            "dataType": "stringList",
            "options": {
                "option": [
                    {
                        "value": "Afghanistan"
                    },
                    {
                        "value": "Albania"
                    }
                    <!-- .... more countries -->                   
                ]
            },
            "name": "country"
        },
        {
            "dataSize": 255,
            "dataType": "stringList",
            "options": {
                "option": [
                    {
                        "value": "finance",
                        "displayValue": "Finance"
                    },
                    {
                        "value": "health_care",
                        "displayValue": "Health care"
                    },
                    {
                        "value": "telecom",
                        "displayValue": "Telecom"
                    }
                ]
            },
            "name": "industry"
        },
        {
            "dataSize": 255,
            "dataType": "stringList",
            "options": {
                "option": [
                    {
                        "value": "gold",
                        "displayValue": "Gold"
                    },
                    {
                        "value": "platinum",
                        "displayValue": "Platinum"
                    },
                    {
                        "value": "premium",
                        "displayValue": "Premium"
                    },
                    {
                        "value": "silver",
                        "displayValue": "Silver"
                    },
                    {
                        "value": "standard",
                        "displayValue": "Standard"
                    }
                ]
            },
            "name": "level"
        },
        {
            "dataSize": 1055,
            "dataType": "stringList",
            "options": {
                "option": [
                    {
                        "value": "1",
                        "displayValue": "Washington"
                    },
                    {
                        "value": "2",
                        "displayValue": "New York"
                    },
                    {
                        "value": "3",
                        "displayValue": "San Jose"
                    },
                    {
                        "value": "4",
                        "displayValue": "Chicago"
                    }
                ],
                "isMultiSelect": true
            },
            "name": "operations_in",
            "custom": true
        },
        {
            "attribute": [
                {
                    "attribute": [
                        {
                            "dataSize": 255,
                            "dataType": "stringList",
                            "options": {
                                "option": [
                                    {
                                        "value": "billing",
                                        "displayValue": "Billing"
                                    },
                                    {
                                        "value": "legal",
                                        "displayValue": "Legal"
                                    },
                                    {
                                        "value": "shipping",
                                        "displayValue": "Shipping"
                                    },
                                    {
                                        "value": "technical",
                                        "displayValue": "Technical"
                                    }
                                ]
                            },
                            "name": "type"
                        },
                        {
                            "attribute": [
                                {
                                    "dataSize": 255,
                                    "dataType": "stringList",
                                    "options": {
                                        "option": [
                                            {
                                                "value": "License"
                                            },
                                            {
                                                "value": "Passport"
                                            },
                                            {
                                                "value": "SSN"
                                            }
                                        ]
                                    },
                                    "name": "type"
                                }
                            ],
                            "name": "identification"
                        },
                        {
                            "dataSize": 8,
                            "dataType": "stringList",
                            "options": {
                                "option": [
                                    {
                                        "value": "1",
                                        "displayValue": "Passport"
                                    },
                                    {
                                        "value": "2",
                                        "displayValue": "Driving License"
                                    },
                                    {
                                        "value": "3",
                                        "displayValue": "SSN"
                                    },
                                    {
                                        "value": "4",
                                        "displayValue": "DMV ID"
                                    }
                                ],
                                "isMultiSelect": false
                            },
                            "name": "second_id",
                            "custom": true
                        },
                        {
                            "dataSize": 100,
                            "dataType": "string",
                            "name": "second_id_value",
                            "custom": true
                        },
                        {
                            "attribute": [
                                {
                                    "attribute": [
                                        {
                                            "dataSize": 9,
                                            "dataType": "integer",
                                            "name": "activeness",
                                            "custom": true
                                        }
                                    ],
                                    "name": "contactPoint"
                                }
                            ],
                            "name": "contactPoints"
                        }
                    ],
                    "name": "contactPerson"
                }
            ],
            "name": "contactPersons"
        }
    ],
    "resource": "customer"
}

TRY IT OUT Try it out - Retrieve customer attributes