Jump to: navigation, search

GetAttributes

Purpose

This method is intended for obtaining the complete list of contact attributes. This method is used to return all Contact Attribute objects associated to this Contact. Contact Attribute objects must be declared in Configuration Server in the Contact Attribute enumerator. This configuration is Tenant specific. By default, existing Contact Attributes are:

  • AccountNumber
  • ContactId
  • CustomerSegment
  • EmailAddress
  • FirstName
  • LastName
  • PhoneNumber
  • PIN
  • Title.

Contact Attribute objects are stored in the dedicated MCR DB column ContactAttribute.

URL

  • GET /OMContacts/GetAttributes/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
ContactId String Any valid contact Id Id for the contact which attributes were requested true true
AttributeList KVList If this parameter is not present or if the KVList is empty, all ContactAttributes are returned false true


AttributeList KVList

Key ValueType Value Description Mandatory Unique Default
AttrName String String value represents the name of a Contact Attribute as defined in Configuration Server.

Max. length: 256 characters If AttributeList KVList is empty, all ContactAttributes are returned.

false false

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
TenantID Integer true true
ContactID String true true
CreatedDate String "yyyy-MM-ddTHH:mm:ss.SSSZ" true true
ModifiedDate String "yyyy-MM-ddTHH:mm:ss.SSSZ" true true
MergeIDs String Id of the contacts that were merged into this one. Not mandatory and can have multiple values. false false
Attributes KVList List with all available (or a subset depending on AttributeList input parameter) attributes for the contact with requested ContactId false true

Attributes KVList

Key ValueType Value Description Mandatory Unique Default
(AttributeName) KVList (AttributeName)is the system name of a Contact Attribute as declared in Configuration Server (Tenant specific configuration) false true


KVList

Key ValueType Value Description Mandatory Unique Default
(Attribute Index) KVList (Attribute Index) == 0 means primary false true


KVList

Key ValueType Value Description Mandatory Unique Default
AttrId String Attribute Id true true
AttrValue StringBinary The value type of this parameter depends on the Contact Attribute type declared in Config Server (settings/type). If type is set to:

string(default): value is a String date: value is a String formatted with the pattern:"yyyy-MM-ddTHH:mm:ss.SSSZ" binary: value is a byte array

false true null
MimeType String Applicable for binary contentReturned only if not null. false true
Description String This is the description that can be attached to the contact attribute.Returned only if not null. For example, EmailAddress can be described as "(home)" or "(office)", etc false true


Sample

Attributes EmailAddress 0 AttrId JH8BVJH5J48KL59
AttrValue john.doe@genesys.com
Description (home)
1 AttrId JH8BVJH5J48KL58
AttrValue alice.doe@genesys.com
LastName 0 AttrId JH8BVJH5J48KL60
AttrValue Doe
Picture 0 AttrId JH8BVJH5J48KL61
AttrValue (binary)
MimeType image/jpg

Error

FaultCode FaultString Description
510 {0} not found in database Contact with Id=(ContactId) is not found in database

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.