Jump to: navigation, search

GetContacts

Purpose

This method is intended for delivering specific range of contacts based on search and sort criteria.

URL

  • GET /OMContacts/GetContacts/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
ContactCount String Asks UCS to return total count of matching Contacts.

Setting this parameter to true results in an extra database query which will decrease performance.

false true false
TenantId Integer true true
SubscriberId String The subscriber (that is, line of business) within the tenant to which the contacts belong. false true
IndexOfFirst Integer Index of the first row in selection false true 0
MaxCount Integer Maximum number of rows in selection false true (schema/select-limit)
SearchCriteria KVList No filtering if not present. See format description in OMContacts / ContactListGet. false true
SortCriteria KVList No ordering if not present. See format description in OMContacts / ContactListGet. false true
AttributeList KVList List of attributes to return. See format description in OMContacts / ContactListGet. false true

Sample

ContactCount true
TenantId 102
IndexOfFirst 2000
MaxCount 2
SearchCriteria AND EQUAL AttrName FirstName
AttrValue John
AND NOT_EQUAL AttrName LastName
AttrValue Doe
SortCriteria 0 Operator ASC AttrName LastName
AttributeList AttrName EmailAddress
AttrName PhoneNumber

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
TotalCount Integer Present only if ContactCount is true in the request false true
CurrentCount Integer The number of Contacts available in this response true true
ContactData KVList See format description in OMContacts / ContactListGet false true


Sample

TotalCount 800000
CurrentCount 2
ContactData 0 Id 1234567890123456
Attributes EmailAddress john@rivers.com
PhoneNumber 1257566
1 Id ABCDEFJIOQJDLHDEC
Attributes EmailAddress john@cole.com
PhoneNumber 354535432

Error

FaultCode FaultString Description
201 Missing parameter 'SubscriberId' SubscriberId was not provided but is a required parameter.
921 SubscriberId '{0}' is invalid or not active. The provided SubscriberId is not valid.
732 Invalid Tenant {0} Provided tenant is not configured in UCS

Feedback

Comment on this article:

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