All Classes Pages
GetActivityAttributesExamples Class Reference

Detailed Description

Examples for Retrieve Activity Attribute Metadata

Example 1 - Get activity type attributes

This example demonstrates the following:

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

XML

Request

Method URL
GET /ws/v12/interaction/activity/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" standalone="yes"?>
<attributes xmlns="http://bindings.egain.com/ws/model/v12/gen/common/attribute" resource="activity">
<attribute name="type">
    <dataSize>255</dataSize>
    <dataType>stringList</dataType>
    <options>
        <option>
            <value>task</value>
            <displayValue>Task</displayValue>
            <attribute name="subType">
                <dataSize>255</dataSize>
                <dataType>stringList</dataType>
                <options>
                    <option>
                        <value>general</value>
                        <displayValue>General</displayValue>
                    </option>
                </options>
            </attribute>
        </option>
        <option>
            <value>call_track</value>
            <displayValue>Call Track</displayValue>
            <attribute name="subType">
                <dataSize>255</dataSize>
                <dataType>stringList</dataType>
                <options>
                    <option>
                        <value>general</value>
                        <displayValue>General</displayValue>
                    </option>
                </options>
            </attribute>
        </option>
        <option>
            <value>social</value>
            <displayValue>Social</displayValue>
            <attribute name="subType">
                <dataSize>255</dataSize>
                <dataType>stringList</dataType>
                <options>
                    <option>
                        <value>general</value>
                        <displayValue>General</displayValue>
                    </option>
                    <option>
                        <value>twitter</value>
                        <displayValue>Twitter</displayValue>
                    </option>
                    <option>
                        <value>facebook</value>
                        <displayValue>Facebook</displayValue>
                    </option>
                    <option>
                        <value>youtube</value>
                        <displayValue>YouTube</displayValue>
                    </option>
					<option>
						<value>instagram</value>
						<displayValue>Instagram</displayValue>
					</option>
                </options>
            </attribute>
        </option>
    </options>
</attribute>
</attributes>

     


JSON

Request

Method URL
GET /ws/v12/interaction/activity/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": [
    {
      "dataSize": 255,
      "dataType": "stringList",
      "options": {
        "option": [
          {  
            "value":"task",
            "displayValue":"Task",
            "attribute":{  
              "dataSize":255,
              "dataType":"stringList",
              "options":{  
                "option":[  
                  {  
                    "value":"general",
                    "displayValue":"General"
                  }
                ]
              },
              "name":"subType"
            }
          },
          {
            "value": "call_track",
            "displayValue": "Call Track",
            "attribute": {
              "dataSize": 255,
              "dataType": "stringList",
              "options": {
                "option": [
                  {
                    "value": "general",
                    "displayValue": "General"
                  }
                ]
              },
              "name": "subType"
            }
          },
          {
            "value": "social",
            "displayValue": "Social",
            "attribute": {
              "dataSize": 255,
              "dataType": "stringList",
              "options": {
                "option": [
                  {
                    "value": "general",
                    "displayValue": "General"
                  },
                  {
                    "value": "twitter",
                    "displayValue": "Twitter"
                  },
                  {
                    "value": "facebook",
                    "displayValue": "Facebook"
                  },
                  {
                    "value": "youtube",
                    "displayValue": "YouTube"
                  },
				{
					"value": "instagram",
					"displayValue": "Instagram"
				}
                ]
              },
              "name": "subType"
            }
          }
        ]
      },
      "name": "type"
    }
  ],
  "resource": "activity"
}

     



Example 2 - Get activity language attribute details

This example demonstrates the following:

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

XML

Request

Method URL
GET /ws/v12/interaction/activity/attributes?$attribute=language

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" standalone="yes" ?>
<attributes xmlns="http://bindings.egain.com/ws/model/v12/gen/common/attribute" resource="activity">
    <attribute name="language">
        <dataSize>5</dataSize>
        <dataType>stringList</dataType>
        <options>
            <option>
                <value>de</value>
                <displayValue>German</displayValue>
            </option>
            <option>
                <value>hi</value>
                <displayValue>Hindi</displayValue>
            </option>
            <option>
                <value>pt</value>
                <displayValue>Portuguese</displayValue>
            </option>
            <option>
                <value>lt</value>
                <displayValue>Lithuanian</displayValue>
            </option>
            <option>
                <value>hr</value>
                <displayValue>Croatian</displayValue>
            </option>
            <option>
                <value>lv</value>
                <displayValue>Latvian</displayValue>
            </option>
            <option>
                <value>hu</value>
                <displayValue>Hungarian</displayValue>
            </option>
            <option>
                <value>zh-cn</value>
                <displayValue>Simplified Chinese</displayValue>
            </option>
            <option>
                <value>uk</value>
                <displayValue>Ukrainian</displayValue>
            </option>
            <option>
                <value>id</value>
                <displayValue>Indonesian</displayValue>
            </option>
            <option>
                <value>ur</value>
                <displayValue>Urdu</displayValue>
            </option>
            <option>
                <value>mk</value>
                <displayValue>Macedonian</displayValue>
            </option>
            <option>
                <value>ml</value>
                <displayValue>Malayalam</displayValue>
            </option>
            <option>
                <value>af</value>
                <displayValue>Afrikaans</displayValue>
            </option>
            <option>
                <value>mr</value>
                <displayValue>Marathi</displayValue>
            </option>
            <option>
                <value>el</value>
                <displayValue>Greek</displayValue>
            </option>
            <option>
                <value>en</value>
                <displayValue>English</displayValue>
            </option>
            <option>
                <value>it</value>
                <displayValue>Italian</displayValue>
            </option>
            <option>
                <value>es</value>
                <displayValue>Spanish</displayValue>
            </option>
            <option>
                <value>et</value>
                <displayValue>Estonian</displayValue>
            </option>
            <option>
                <value>ar</value>
                <displayValue>Arabic</displayValue>
            </option>
            <option>
                <value>vi</value>
                <displayValue>Vietnamese</displayValue>
            </option>
            <option>
                <value>ja</value>
                <displayValue>Japanese</displayValue>
            </option>
            <option>
                <value>ne</value>
                <displayValue>Nepali</displayValue>
            </option>
            <option>
                <value>fa</value>
                <displayValue>Persian</displayValue>
            </option>
            <option>
                <value>ro</value>
                <displayValue>Romanian</displayValue>
            </option>
            <option>
                <value>nl</value>
                <displayValue>Dutch</displayValue>
            </option>
            <option>
                <value>no</value>
                <displayValue>Norwegian</displayValue>
            </option>
            <option>
                <value>fi</value>
                <displayValue>Finnish</displayValue>
            </option>
            <option>
                <value>ru</value>
                <displayValue>Russian</displayValue>
            </option>
            <option>
                <value>bg</value>
                <displayValue>Bulgarian</displayValue>
            </option>
            <option>
                <value>bn</value>
                <displayValue>Bengali</displayValue>
            </option>
            <option>
                <value>fr</value>
                <displayValue>French</displayValue>
            </option>
            <option>
                <value>sk</value>
                <displayValue>Slovak</displayValue>
            </option>
            <option>
                <value>sl</value>
                <displayValue>Slovene</displayValue>
            </option>
            <option>
                <value>so</value>
                <displayValue>Somali</displayValue>
            </option>
            <option>
                <value>sq</value>
                <displayValue>Albanian</displayValue>
            </option>
            <option>
                <value>kn</value>
                <displayValue>Kannada</displayValue>
            </option>
            <option>
                <value>sv</value>
                <displayValue>Swedish</displayValue>
            </option>
            <option>
                <value>ko</value>
                <displayValue>Korean</displayValue>
            </option>
            <option>
                <value>sw</value>
                <displayValue>Swahili</displayValue>
            </option>
            <option>
                <value>zh-tw</value>
                <displayValue>Traditional Chinese</displayValue>
            </option>
            <option>
                <value>ta</value>
                <displayValue>Tamil</displayValue>
            </option>
            <option>
                <value>gu</value>
                <displayValue>Gujarati</displayValue>
            </option>
            <option>
                <value>cs</value>
                <displayValue>Czech</displayValue>
            </option>
            <option>
                <value>pa</value>
                <displayValue>Punjabi</displayValue>
            </option>
            <option>
                <value>te</value>
                <displayValue>Telugu</displayValue>
            </option>
            <option>
                <value>th</value>
                <displayValue>Thai</displayValue>
            </option>
            <option>
                <value>tl</value>
                <displayValue>Tagalog</displayValue>
            </option>
            <option>
                <value>pl</value>
                <displayValue>Polish</displayValue>
            </option>
            <option>
                <value>da</value>
                <displayValue>Danish</displayValue>
            </option>
            <option>
                <value>he</value>
                <displayValue>Hebrew</displayValue>
            </option>
            <option>
                <value>tr</value>
                <displayValue>Turkish</displayValue>
            </option>
        </options>
    </attribute>
</attributes>

     


JSON

Request

Method URL
GET /ws/v12/interaction/activity/attributes?$attribute=language

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": 5,
            "dataType": "stringList",
            "options": {
                "option": [
                    {
                        "value": "de",
                        "displayValue": "German"
                    },
                    {
                        "value": "hi",
                        "displayValue": "Hindi"
                    },
                    {
                        "value": "pt",
                        "displayValue": "Portuguese"
                    },
                    {
                        "value": "lt",
                        "displayValue": "Lithuanian"
                    },
                    {
                        "value": "hr",
                        "displayValue": "Croatian"
                    },
                    {
                        "value": "lv",
                        "displayValue": "Latvian"
                    },
                    {
                        "value": "hu",
                        "displayValue": "Hungarian"
                    },
                    {
                        "value": "zh-cn",
                        "displayValue": "Simplified Chinese"
                    },
                    {
                        "value": "uk",
                        "displayValue": "Ukrainian"
                    },
                    {
                        "value": "id",
                        "displayValue": "Indonesian"
                    },
                    {
                        "value": "ur",
                        "displayValue": "Urdu"
                    },
                    {
                        "value": "mk",
                        "displayValue": "Macedonian"
                    },
                    {
                        "value": "ml",
                        "displayValue": "Malayalam"
                    },
                    {
                        "value": "af",
                        "displayValue": "Afrikaans"
                    },
                    {
                        "value": "mr",
                        "displayValue": "Marathi"
                    },
                    {
                        "value": "el",
                        "displayValue": "Greek"
                    },
                    {
                        "value": "en",
                        "displayValue": "English"
                    },
                    {
                        "value": "it",
                        "displayValue": "Italian"
                    },
                    {
                        "value": "es",
                        "displayValue": "Spanish"
                    },
                    {
                        "value": "et",
                        "displayValue": "Estonian"
                    },
                    {
                        "value": "ar",
                        "displayValue": "Arabic"
                    },
                    {
                        "value": "vi",
                        "displayValue": "Vietnamese"
                    },
                    {
                        "value": "ja",
                        "displayValue": "Japanese"
                    },
                    {
                        "value": "ne",
                        "displayValue": "Nepali"
                    },
                    {
                        "value": "fa",
                        "displayValue": "Persian"
                    },
                    {
                        "value": "ro",
                        "displayValue": "Romanian"
                    },
                    {
                        "value": "nl",
                        "displayValue": "Dutch"
                    },
                    {
                        "value": "no",
                        "displayValue": "Norwegian"
                    },
                    {
                        "value": "fi",
                        "displayValue": "Finnish"
                    },
                    {
                        "value": "ru",
                        "displayValue": "Russian"
                    },
                    {
                        "value": "bg",
                        "displayValue": "Bulgarian"
                    },
                    {
                        "value": "bn",
                        "displayValue": "Bengali"
                    },
                    {
                        "value": "fr",
                        "displayValue": "French"
                    },
                    {
                        "value": "sk",
                        "displayValue": "Slovak"
                    },
                    {
                        "value": "sl",
                        "displayValue": "Slovene"
                    },
                    {
                        "value": "so",
                        "displayValue": "Somali"
                    },
                    {
                        "value": "sq",
                        "displayValue": "Albanian"
                    },
                    {
                        "value": "kn",
                        "displayValue": "Kannada"
                    },
                    {
                        "value": "sv",
                        "displayValue": "Swedish"
                    },
                    {
                        "value": "ko",
                        "displayValue": "Korean"
                    },
                    {
                        "value": "sw",
                        "displayValue": "Swahili"
                    },
                    {
                        "value": "zh-tw",
                        "displayValue": "Traditional Chinese"
                    },
                    {
                        "value": "ta",
                        "displayValue": "Tamil"
                    },
                    {
                        "value": "gu",
                        "displayValue": "Gujarati"
                    },
                    {
                        "value": "cs",
                        "displayValue": "Czech"
                    },
                    {
                        "value": "pa",
                        "displayValue": "Punjabi"
                    },
                    {
                        "value": "te",
                        "displayValue": "Telugu"
                    },
                    {
                        "value": "th",
                        "displayValue": "Thai"
                    },
                    {
                        "value": "tl",
                        "displayValue": "Tagalog"
                    },
                    {
                        "value": "pl",
                        "displayValue": "Polish"
                    },
                    {
                        "value": "da",
                        "displayValue": "Danish"
                    },
                    {
                        "value": "he",
                        "displayValue": "Hebrew"
                    },
                    {
                        "value": "tr",
                        "displayValue": "Turkish"
                    }
                ]
            },
            "name": "language"
        }
    ],
    "resource": "activity"
}

     



Example 3 - Get activity custom attributes

This example demonstrates the following:

  • Getting the metadata for custom attributes of the activity resource.

XML

Request

Method URL
GET /ws/v12/interaction/activity/attributes?$attribute=custom

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" standalone="yes"?>
<attributes xmlns="http://bindings.egain.com/ws/model/v12/gen/common/attribute" resource="activity">
<attribute name="EnquiryID" custom="true">
    <dataSize>9</dataSize>
    <dataType>integer</dataType>
    <defaultValue/>
</attribute>
<attribute name="PassengerCapacity" custom="true">
    <dataSize>9</dataSize>
    <dataType>integer</dataType>
    <defaultValue>5</defaultValue>
</attribute>
<attribute name="EnquirySummary" custom="true">
    <dataSize>8</dataSize>
    <dataType>string</dataType>
    <defaultValue/>
</attribute>
<attribute name="TradeInModel" custom="true">
    <dataSize>8</dataSize>
    <dataType>string</dataType>
    <defaultValue>None</defaultValue>
</attribute>
<attribute name="PurchaseTimeframe" custom="true">
    <dataSize>8</dataSize>
    <dataType>stringList</dataType>
    <options isMultiSelect="false">
        <option>
            <value>0</value>
            <displayValue>Today</displayValue>
        </option>
        <option>
            <value>7</value>
            <displayValue>ThisWeek</displayValue>
        </option>
        <option>
            <value>14</value>
            <displayValue>NextWeek</displayValue>
        </option>
        <option>
            <value>30</value>
            <displayValue>ThisMonth</displayValue>
        </option>
        <option>
            <value>90</value>
            <displayValue>ThisQuarter</displayValue>
        </option>
        <option>
            <value>999</value>
            <displayValue>Unsure</displayValue>
        </option>
    </options>
</attribute>
<attribute name="Customized" custom="true">
    <dataSize>8</dataSize>
    <dataType>stringList</dataType>
    <options isMultiSelect="false">
        <option isDefault="true">
            <value>0</value>
            <displayValue>No</displayValue>
        </option>
        <option>
            <value>1</value>
            <displayValue>Yes</displayValue>
        </option>
    </options>
</attribute>
<attribute name="OptionalFeatures" custom="true">
    <dataSize>255</dataSize>
    <dataType>stringList</dataType>
    <options isMultiSelect="true">
        <option>
            <value>gps</value>
            <displayValue>GPS</displayValue>
        </option>
        <option>
            <value>bsm</value>
            <displayValue>BSM</displayValue>
        </option>
        <option>
            <value>backupcamera</value>
            <displayValue>BackupCamera</displayValue>
        </option>
        <option>
            <value>foglights</value>
            <displayValue>FogLights</displayValue>
        </option>
        <option>
            <value>sunroof</value>
            <displayValue>Sunroof</displayValue>
        </option>
    </options>
</attribute>
<attribute name="FinanceUpsells" custom="true">
    <dataSize>255</dataSize>
    <dataType>stringList</dataType>
    <options isMultiSelect="true">
        <option isDefault="true">
            <value>silverwarranty</value>
            <displayValue>SilverWarranty</displayValue>
        </option>
        <option>
            <value>goldwarranty</value>
            <displayValue>GoldWarranty</displayValue>
        </option>
        <option>
            <value>platinumwarranty</value>
            <displayValue>PlatinumWarranty</displayValue>
        </option>
        <option>
            <value>prepaidmaintenance</value>
            <displayValue>PrepaidMaintenance</displayValue>
        </option>
        <option>
            <value>touchofclass</value>
            <displayValue>TouchOfClass</displayValue>
        </option>
        <option>
            <value>keylessentry</value>
            <displayValue>KeylessEntry</displayValue>
        </option>
        <option>
            <value>lojack</value>
            <displayValue>LoJack</displayValue>
        </option>
    </options>
</attribute>
<attribute name="CustomizationFeatures" custom="true">
    <dataSize>255</dataSize>
    <dataType>stringList</dataType>
    <options isMultiSelect="true">
        <option isDefault="true">
            <value>frontairbags</value>
            <displayValue>FrontAirbags</displayValue>
        </option>
        <option isDefault="true">
            <value>sideairbags</value>
            <displayValue>SideAirbags</displayValue>
        </option>
        <option>
            <value>passengerairbags</value>
            <displayValue>PassengerAirbags</displayValue>
        </option>
        <option>
            <value>heatedseats</value>
            <displayValue>HeatedSeats</displayValue>
        </option>
        <option isDefault="true">
            <value>premiumsound</value>
            <displayValue>PremiumSound</displayValue>
        </option>
        <option>
            <value>moonroof</value>
            <displayValue>Moonroof</displayValue>
        </option>
    </options>
</attribute>
</attributes>

     


JSON

Request

Method URL
GET /ws/v12/interaction/activity/attributes?$attribute=custom

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": 9,
      "dataType": "integer",
      "defaultValue": "",
      "name": "EnquiryID",
      "custom": true
    },
    {
      "dataSize": 9,
      "dataType": "integer",
      "defaultValue": "5",
      "name": "PassengerCapacity",
      "custom": true
    },
    {
      "dataSize": 8,
      "dataType": "string",
      "defaultValue": "",
      "name": "EnquirySummary",
      "custom": true
    },
    {
      "dataSize": 8,
      "dataType": "string",
      "defaultValue": "None",
      "name": "TradeInModel",
      "custom": true
    },
    {
      "dataSize": 8,
      "dataType": "stringList",
      "options": {
        "option": [
          {
            "value": "0",
            "displayValue": "Today"
          },
          {
            "value": "7",
            "displayValue": "ThisWeek"
          },
          {
            "value": "14",
            "displayValue": "NextWeek"
          },
          {
            "value": "30",
            "displayValue": "ThisMonth"
          },
          {
            "value": "90",
            "displayValue": "ThisQuarter"
          },
          {
            "value": "999",
            "displayValue": "Unsure"
          }
        ],
        "isMultiSelect": false
      },
      "name": "PurchaseTimeframe",
      "custom": true
    },
    {
      "dataSize": 8,
      "dataType": "stringList",
      "options": {
        "option": [
          {
            "value": "0",
            "displayValue": "No",
            "isDefault": true
          },
          {
            "value": "1",
            "displayValue": "Yes"
          }
        ],
        "isMultiSelect": false
      },
      "name": "Customized",
      "custom": true
    },
    {
      "dataSize": 255,
      "dataType": "stringList",
      "options": {
        "option": [
          {
            "value": "gps",
            "displayValue": "GPS"
          },
          {
            "value": "bsm",
            "displayValue": "BSM"
          },
          {
            "value": "backupcamera",
            "displayValue": "BackupCamera"
          },
          {
            "value": "foglights",
            "displayValue": "FogLights"
          },
          {
            "value": "sunroof",
            "displayValue": "Sunroof"
          }
        ],
        "isMultiSelect": true
      },
      "name": "OptionalFeatures",
      "custom": true
    },
    {
      "dataSize": 255,
      "dataType": "stringList",
      "options": {
        "option": [
          {
            "value": "silverwarranty",
            "displayValue": "SilverWarranty",
            "isDefault": true
          },
          {
            "value": "goldwarranty",
            "displayValue": "GoldWarranty"
          },
          {
            "value": "platinumwarranty",
            "displayValue": "PlatinumWarranty"
          },
          {
            "value": "prepaidmaintenance",
            "displayValue": "PrepaidMaintenance"
          },
          {
            "value": "touchofclass",
            "displayValue": "TouchOfClass"
          },
          {
            "value": "keylessentry",
            "displayValue": "KeylessEntry"
          },
          {
            "value": "lojack",
            "displayValue": "LoJack"
          }
        ],
        "isMultiSelect": true
      },
      "name": "FinanceUpsells",
      "custom": true
    },
    {
      "dataSize": 255,
      "dataType": "stringList",
      "options": {
        "option": [
          {
            "value": "frontairbags",
            "displayValue": "FrontAirbags",
            "isDefault": true
          },
          {
            "value": "sideairbags",
            "displayValue": "SideAirbags",
            "isDefault": true
          },
          {
            "value": "passengerairbags",
            "displayValue": "PassengerAirbags"
          },
          {
            "value": "heatedseats",
            "displayValue": "HeatedSeats"
          },
          {
            "value": "premiumsound",
            "displayValue": "PremiumSound",
            "isDefault": true
          },
          {
            "value": "moonroof",
            "displayValue": "Moonroof"
          }
        ],
        "isMultiSelect": true
      },
      "name": "CustomizationFeatures",
      "custom": true
    }
  ],
  "resource": "activity"
}

     



Example 4 - Get all activity attributes

This example demonstrates the following:

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

XML

Request

Method URL
GET /ws/v12/interaction/activity/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" standalone="yes"?>
<attributes xmlns="http://bindings.egain.com/ws/model/v12/gen/common/attribute" resource="activity">

<attribute name="language">
	<dataSize>5</dataSize>
	<dataType>stringList</dataType>
	<options>
		<option>
			<value>de</value>
			<displayValue>German</displayValue>
		</option>
		<option>
			<value>hi</value>
			<displayValue>Hindi</displayValue>
		</option>
		<option>
			<value>pt</value>
			<displayValue>Portuguese</displayValue>
		</option>
		<option>
			<value>lt</value>
			<displayValue>Lithuanian</displayValue>
		</option>
		<option>
			<value>hr</value>
			<displayValue>Croatian</displayValue>
		</option>
		<option>
			<value>lv</value>
			<displayValue>Latvian</displayValue>
		</option>
		<option>
			<value>hu</value>
			<displayValue>Hungarian</displayValue>
		</option>
		<option>
			<value>zh-cn</value>
			<displayValue>Simplified Chinese</displayValue>
		</option>
		<option>
			<value>uk</value>
			<displayValue>Ukrainian</displayValue>
		</option>
		<option>
			<value>id</value>
			<displayValue>Indonesian</displayValue>
		</option>
		<option>
			<value>ur</value>
			<displayValue>Urdu</displayValue>
		</option>
		<option>
			<value>mk</value>
			<displayValue>Macedonian</displayValue>
		</option>
		<option>
			<value>ml</value>
			<displayValue>Malayalam</displayValue>
		</option>
		<option>
			<value>af</value>
			<displayValue>Afrikaans</displayValue>
		</option>
		<option>
			<value>mr</value>
			<displayValue>Marathi</displayValue>
		</option>
		<option>
			<value>el</value>
			<displayValue>Greek</displayValue>
		</option>
		<option>
			<value>en</value>
			<displayValue>English</displayValue>
		</option>
		<option>
			<value>it</value>
			<displayValue>Italian</displayValue>
		</option>
		<option>
			<value>es</value>
			<displayValue>Spanish</displayValue>
		</option>
		<option>
			<value>et</value>
			<displayValue>Estonian</displayValue>
		</option>
		<option>
			<value>ar</value>
			<displayValue>Arabic</displayValue>
		</option>
		<option>
			<value>vi</value>
			<displayValue>Vietnamese</displayValue>
		</option>
		<option>
			<value>ja</value>
			<displayValue>Japanese</displayValue>
		</option>
		<option>
			<value>ne</value>
			<displayValue>Nepali</displayValue>
		</option>
		<option>
			<value>fa</value>
			<displayValue>Persian</displayValue>
		</option>
		<option>
			<value>ro</value>
			<displayValue>Romanian</displayValue>
		</option>
		<option>
			<value>nl</value>
			<displayValue>Dutch</displayValue>
		</option>
		<option>
			<value>no</value>
			<displayValue>Norwegian</displayValue>
		</option>
		<option>
			<value>fi</value>
			<displayValue>Finnish</displayValue>
		</option>
		<option>
			<value>ru</value>
			<displayValue>Russian</displayValue>
		</option>
		<option>
			<value>bg</value>
			<displayValue>Bulgarian</displayValue>
		</option>
		<option>
			<value>bn</value>
			<displayValue>Bengali</displayValue>
		</option>
		<option>
			<value>fr</value>
			<displayValue>French</displayValue>
		</option>
		<option>
			<value>sk</value>
			<displayValue>Slovak</displayValue>
		</option>
		<option>
			<value>sl</value>
			<displayValue>Slovene</displayValue>
		</option>
		<option>
			<value>so</value>
			<displayValue>Somali</displayValue>
		</option>
		<option>
			<value>sq</value>
			<displayValue>Albanian</displayValue>
		</option>
		<option>
			<value>kn</value>
			<displayValue>Kannada</displayValue>
		</option>
		<option>
			<value>sv</value>
			<displayValue>Swedish</displayValue>
		</option>
		<option>
			<value>ko</value>
			<displayValue>Korean</displayValue>
		</option>
		<option>
			<value>sw</value>
			<displayValue>Swahili</displayValue>
		</option>
		<option>
			<value>zh-tw</value>
			<displayValue>Traditional Chinese</displayValue>
		</option>
		<option>
			<value>ta</value>
			<displayValue>Tamil</displayValue>
		</option>
		<option>
			<value>gu</value>
			<displayValue>Gujarati</displayValue>
		</option>
		<option>
			<value>cs</value>
			<displayValue>Czech</displayValue>
		</option>
		<option>
			<value>pa</value>
			<displayValue>Punjabi</displayValue>
		</option>
		<option>
			<value>te</value>
			<displayValue>Telugu</displayValue>
		</option>
		<option>
			<value>th</value>
			<displayValue>Thai</displayValue>
		</option>
		<option>
			<value>tl</value>
			<displayValue>Tagalog</displayValue>
		</option>
		<option>
			<value>pl</value>
			<displayValue>Polish</displayValue>
		</option>
		<option>
			<value>da</value>
			<displayValue>Danish</displayValue>
		</option>
		<option>
			<value>he</value>
			<displayValue>Hebrew</displayValue>
		</option>
		<option>
			<value>tr</value>
			<displayValue>Turkish</displayValue>
		</option>
	</options>
</attribute>
<attribute name="EnquiryID" custom="true">
    <dataSize>9</dataSize>
    <dataType>integer</dataType>
    <defaultValue/>
</attribute>
<attribute name="PassengerCapacity" custom="true">
    <dataSize>9</dataSize>
    <dataType>integer</dataType>
    <defaultValue>5</defaultValue>
</attribute>
<attribute name="EnquirySummary" custom="true">
    <dataSize>8</dataSize>
    <dataType>string</dataType>
    <defaultValue/>
</attribute>
<attribute name="TradeInModel" custom="true">
    <dataSize>8</dataSize>
    <dataType>string</dataType>
    <defaultValue>None</defaultValue>
</attribute>
<attribute name="PurchaseTimeframe" custom="true">
    <dataSize>8</dataSize>
    <dataType>stringList</dataType>
    <options isMultiSelect="false">
        <option>
            <value>0</value>
            <displayValue>Today</displayValue>
        </option>
        <option>
            <value>7</value>
            <displayValue>ThisWeek</displayValue>
        </option>
        <option>
            <value>14</value>
            <displayValue>NextWeek</displayValue>
        </option>
        <option>
            <value>30</value>
            <displayValue>ThisMonth</displayValue>
        </option>
        <option>
            <value>90</value>
            <displayValue>ThisQuarter</displayValue>
        </option>
        <option>
            <value>999</value>
            <displayValue>Unsure</displayValue>
        </option>
    </options>
</attribute>
<attribute name="Customized" custom="true">
    <dataSize>8</dataSize>
    <dataType>stringList</dataType>
    <options isMultiSelect="false">
        <option isDefault="true">
            <value>0</value>
            <displayValue>No</displayValue>
        </option>
        <option>
            <value>1</value>
            <displayValue>Yes</displayValue>
        </option>
    </options>
</attribute>
<attribute name="OptionalFeatures" custom="true">
    <dataSize>255</dataSize>
    <dataType>stringList</dataType>
    <options isMultiSelect="true">
        <option>
            <value>gps</value>
            <displayValue>GPS</displayValue>
        </option>
        <option>
            <value>bsm</value>
            <displayValue>BSM</displayValue>
        </option>
        <option>
            <value>backupcamera</value>
            <displayValue>BackupCamera</displayValue>
        </option>
        <option>
            <value>foglights</value>
            <displayValue>FogLights</displayValue>
        </option>
        <option>
            <value>sunroof</value>
            <displayValue>Sunroof</displayValue>
        </option>
    </options>
</attribute>
<attribute name="FinanceUpsells" custom="true">
    <dataSize>255</dataSize>
    <dataType>stringList</dataType>
    <options isMultiSelect="true">
        <option isDefault="true">
            <value>silverwarranty</value>
            <displayValue>SilverWarranty</displayValue>
        </option>
        <option>
            <value>goldwarranty</value>
            <displayValue>GoldWarranty</displayValue>
        </option>
        <option>
            <value>platinumwarranty</value>
            <displayValue>PlatinumWarranty</displayValue>
        </option>
        <option>
            <value>prepaidmaintenance</value>
            <displayValue>PrepaidMaintenance</displayValue>
        </option>
        <option>
            <value>touchofclass</value>
            <displayValue>TouchOfClass</displayValue>
        </option>
        <option>
            <value>keylessentry</value>
            <displayValue>KeylessEntry</displayValue>
        </option>
        <option>
            <value>lojack</value>
            <displayValue>LoJack</displayValue>
        </option>
    </options>
</attribute>
<attribute name="CustomizationFeatures" custom="true">
    <dataSize>255</dataSize>
    <dataType>stringList</dataType>
    <options isMultiSelect="true">
        <option isDefault="true">
            <value>frontairbags</value>
            <displayValue>FrontAirbags</displayValue>
        </option>
        <option isDefault="true">
            <value>sideairbags</value>
            <displayValue>SideAirbags</displayValue>
        </option>
        <option>
            <value>passengerairbags</value>
            <displayValue>PassengerAirbags</displayValue>
        </option>
        <option>
            <value>heatedseats</value>
            <displayValue>HeatedSeats</displayValue>
        </option>
        <option isDefault="true">
            <value>premiumsound</value>
            <displayValue>PremiumSound</displayValue>
        </option>
        <option>
            <value>moonroof</value>
            <displayValue>Moonroof</displayValue>
        </option>
    </options>
</attribute>
</attributes>

     


JSON

Request

Method URL
GET /ws/v12/interaction/activity/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": [
    {

		"dataSize": 5,
		"dataType": "stringList",
		"options": {
			"option": [
				{
					"value": "de",
					"displayValue": "German"
				},
				{
					"value": "hi",
					"displayValue": "Hindi"
				},
				{
					"value": "pt",
					"displayValue": "Portuguese"
				},
				{
					"value": "lt",
					"displayValue": "Lithuanian"
				},
				{
					"value": "hr",
					"displayValue": "Croatian"
				},
				{
					"value": "lv",
					"displayValue": "Latvian"
				},
				{
					"value": "hu",
					"displayValue": "Hungarian"
				},
				{
					"value": "zh-cn",
					"displayValue": "Simplified Chinese"
				},
				{
					"value": "uk",
					"displayValue": "Ukrainian"
				},
				{
					"value": "id",
					"displayValue": "Indonesian"
				},
				{
					"value": "ur",
					"displayValue": "Urdu"
				},
				{
					"value": "mk",
					"displayValue": "Macedonian"
				},
				{
					"value": "ml",
					"displayValue": "Malayalam"
				},
				{
					"value": "af",
					"displayValue": "Afrikaans"
				},
				{
					"value": "mr",
					"displayValue": "Marathi"
				},
				{
					"value": "el",
					"displayValue": "Greek"
				},
				{
					"value": "en",
					"displayValue": "English"
				},
				{
					"value": "it",
					"displayValue": "Italian"
				},
				{
					"value": "es",
					"displayValue": "Spanish"
				},
				{
					"value": "et",
					"displayValue": "Estonian"
				},
				{
					"value": "ar",
					"displayValue": "Arabic"
				},
				{
					"value": "vi",
					"displayValue": "Vietnamese"
				},
				{
					"value": "ja",
					"displayValue": "Japanese"
				},
				{
					"value": "ne",
					"displayValue": "Nepali"
				},
				{
					"value": "fa",
					"displayValue": "Persian"
				},
				{
					"value": "ro",
					"displayValue": "Romanian"
				},
				{
					"value": "nl",
					"displayValue": "Dutch"
				},
				{
					"value": "no",
					"displayValue": "Norwegian"
				},
				{
					"value": "fi",
					"displayValue": "Finnish"
				},
				{
					"value": "ru",
					"displayValue": "Russian"
				},
				{
					"value": "bg",
					"displayValue": "Bulgarian"
				},
				{
					"value": "bn",
					"displayValue": "Bengali"
				},
				{
					"value": "fr",
					"displayValue": "French"
				},
				{
					"value": "sk",
					"displayValue": "Slovak"
				},
				{
					"value": "sl",
					"displayValue": "Slovene"
				},
				{
					"value": "so",
					"displayValue": "Somali"
				},
				{
					"value": "sq",
					"displayValue": "Albanian"
				},
				{
					"value": "kn",
					"displayValue": "Kannada"
				},
				{
					"value": "sv",
					"displayValue": "Swedish"
				},
				{
					"value": "ko",
					"displayValue": "Korean"
				},
				{
					"value": "sw",
					"displayValue": "Swahili"
				},
				{
					"value": "zh-tw",
					"displayValue": "Traditional Chinese"
				},
				{
					"value": "ta",
					"displayValue": "Tamil"
				},
				{
					"value": "gu",
					"displayValue": "Gujarati"
				},
				{
					"value": "cs",
					"displayValue": "Czech"
				},
				{
					"value": "pa",
					"displayValue": "Punjabi"
				},
				{
					"value": "te",
					"displayValue": "Telugu"
				},
				{
					"value": "th",
					"displayValue": "Thai"
				},
				{
					"value": "tl",
					"displayValue": "Tagalog"
				},
				{
					"value": "pl",
					"displayValue": "Polish"
				},
				{
					"value": "da",
					"displayValue": "Danish"
				},
				{
					"value": "he",
					"displayValue": "Hebrew"
				},
				{
					"value": "tr",
					"displayValue": "Turkish"
				}
			]
		},
		"name": "language"
	},
    {
      "dataSize": 9,
      "dataType": "integer",
      "defaultValue": "",
      "name": "EnquiryID",
      "custom": true
    },
    {
      "dataSize": 9,
      "dataType": "integer",
      "defaultValue": "5",
      "name": "PassengerCapacity",
      "custom": true
    },
    {
      "dataSize": 8,
      "dataType": "string",
      "defaultValue": "",
      "name": "EnquirySummary",
      "custom": true
    },
    {
      "dataSize": 8,
      "dataType": "string",
      "defaultValue": "None",
      "name": "TradeInModel",
      "custom": true
    },
    {
      "dataSize": 8,
      "dataType": "stringList",
      "options": {
        "option": [
          {
            "value": "0",
            "displayValue": "Today"
          },
          {
            "value": "7",
            "displayValue": "ThisWeek"
          },
          {
            "value": "14",
            "displayValue": "NextWeek"
          },
          {
            "value": "30",
            "displayValue": "ThisMonth"
          },
          {
            "value": "90",
            "displayValue": "ThisQuarter"
          },
          {
            "value": "999",
            "displayValue": "Unsure"
          }
        ],
        "isMultiSelect": false
      },
      "name": "PurchaseTimeframe",
      "custom": true
    },
    {
      "dataSize": 8,
      "dataType": "stringList",
      "options": {
        "option": [
          {
            "value": "0",
            "displayValue": "No",
            "isDefault": true
          },
          {
            "value": "1",
            "displayValue": "Yes"
          }
        ],
        "isMultiSelect": false
      },
      "name": "Customized",
      "custom": true
    },
    {
      "dataSize": 255,
      "dataType": "stringList",
      "options": {
        "option": [
          {
            "value": "gps",
            "displayValue": "GPS"
          },
          {
            "value": "bsm",
            "displayValue": "BSM"
          },
          {
            "value": "backupcamera",
            "displayValue": "BackupCamera"
          },
          {
            "value": "foglights",
            "displayValue": "FogLights"
          },
          {
            "value": "sunroof",
            "displayValue": "Sunroof"
          }
        ],
        "isMultiSelect": true
      },
      "name": "OptionalFeatures",
      "custom": true
    },
    {
      "dataSize": 255,
      "dataType": "stringList",
      "options": {
        "option": [
          {
            "value": "silverwarranty",
            "displayValue": "SilverWarranty",
            "isDefault": true
          },
          {
            "value": "goldwarranty",
            "displayValue": "GoldWarranty"
          },
          {
            "value": "platinumwarranty",
            "displayValue": "PlatinumWarranty"
          },
          {
            "value": "prepaidmaintenance",
            "displayValue": "PrepaidMaintenance"
          },
          {
            "value": "touchofclass",
            "displayValue": "TouchOfClass"
          },
          {
            "value": "keylessentry",
            "displayValue": "KeylessEntry"
          },
          {
            "value": "lojack",
            "displayValue": "LoJack"
          }
        ],
        "isMultiSelect": true
      },
      "name": "FinanceUpsells",
      "custom": true
    },
    {
      "dataSize": 255,
      "dataType": "stringList",
      "options": {
        "option": [
          {
            "value": "frontairbags",
            "displayValue": "FrontAirbags",
            "isDefault": true
          },
          {
            "value": "sideairbags",
            "displayValue": "SideAirbags",
            "isDefault": true
          },
          {
            "value": "passengerairbags",
            "displayValue": "PassengerAirbags"
          },
          {
            "value": "heatedseats",
            "displayValue": "HeatedSeats"
          },
          {
            "value": "premiumsound",
            "displayValue": "PremiumSound",
            "isDefault": true
          },
          {
            "value": "moonroof",
            "displayValue": "Moonroof"
          }
        ],
        "isMultiSelect": true
      },
      "name": "CustomizationFeatures",
      "custom": true
    }
  ],
  "resource": "activity"
}