iService API Documentation

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: iService API Forms > Customer Info

Displaying contact details (api=details)

Purpose

The details API is used to retrieve contact property values and subscription details of a contact.

UI Reference: The API is called when the Contact Details tab is opened.

URI: webapp-api-custinfo?api=details

Access Rights Required: All agents, but results are only returned for segments to which they have been granted segment access. See __ for customer history.

Request

Request Parameter

Name	Type	Description
contactID	Number	This parameter represents an id of Contact.

Request Payload

{

"contactID": 510

}

Response

The response provides a list of all the properties for the contact. The response includes the built-in properties from the Global segment, contact properties from segments the agent can access, and shared contact properties from all segments. Learn more about contact properties in the user guide.

Response Parameter

The JSON values are explained in Properties That May Be Edited chapter

Response payload example

{
  "properties": [
    {
      "name": "Global",
      "properties": [
        {
          "propertyID": "1",
          "name": "First Name",
          "isDate": false,
          "isDatetime": false,
          "isInteger": false,
          "isNumber": false,
          "allowMultiple": false,
          "hasDescriptions": false,
          "isMultiLine": false,
          "isReadOnly": false,
          "isRequired": false,
          "values": [
            {
              "description": null,
              "value": "John",
              "valueDate": null,
              "valueDatetime": null,
              "valueInt": null,
              "valueNumber": null
            }
          ],
          "valueChoices": [],
          "descriptionChoices": []
        },
        {
          "propertyID": "2",
          "name": "Middle Initial",
          "isDate": false,
          "isDatetime": false,
          "isInteger": false,
          "isNumber": false,
          "allowMultiple": false,
          "hasDescriptions": false,
          "isMultiLine": false,
          "isReadOnly": false,
          "isRequired": false,
          "values": [],
          "valueChoices": [],
          "descriptionChoices": []
        },
        {
          "propertyID": "3",
          "name": "Last Name",
          "isDate": false,
          "isDatetime": false,
          "isInteger": false,
          "isNumber": false,
          "allowMultiple": false,
          "hasDescriptions": false,
          "isMultiLine": false,
          "isReadOnly": false,
          "isRequired": false,
          "values": [
            {
              "description": null,
              "value": "Deer",
              "valueDate": null,
              "valueDatetime": null,
              "valueInt": null,
              "valueNumber": null
            }
          ],
          "valueChoices": [],
          "descriptionChoices": []
        }
      ],
      "logins": [
        {
          "name": "customer11@1to1service.com",
          "type": "Email"
        }
      ],
      "canModifyLogins": true
    },
    {
      "name": "e-shop",
      "properties": [
        {
          "propertyID": "13",
          "name": "Customer Level",
          "isDate": false,
          "isDatetime": false,
          "isInteger": false,
          "isNumber": false,
          "allowMultiple": false,
          "hasDescriptions": false,
          "isMultiLine": false,
          "isReadOnly": false,
          "isRequired": false,
          "values": [],
          "valueChoices": [
            "Bronze",
            "Coal",
            "Gold",
            "Platinum",
            "Silver"
          ],
          "descriptionChoices": []
        }
      ],
      "logins": null,
      "canModifyLogins": false
    },
    {
      "name": "Human Resources",
      "properties": [
        {
          "propertyID": "30",
          "name": "Supervisor",
          "isDate": false,
          "isDatetime": false,
          "isInteger": false,
          "isNumber": false,
          "allowMultiple": false,
          "hasDescriptions": false,
          "isMultiLine": false,
          "isReadOnly": false,
          "isRequired": false,
          "values": [],
          "valueChoices": [],
          "descriptionChoices": []
        }
      ],
      "logins": null,
      "canModifyLogins": false
    }
  ],
  "membership": [
    "2",
    "3",
    "4",
    "5",
    "6",
    "7",
    "8",
    "10",
    "11",
    "12"
  ]
}

Please enable JavaScript to view this site.