Export (0) Print
Expand All

Predicate Data Object

Defines a predicate for the list of customers requested using the SearchCustomers operation.


<xs:complexType name="Predicate">
  <xs:sequence>
    <xs:element name="Field" type="xs:string" nillable="true" minOccurs="0" />
    <xs:element name="Operator" type="tns:PredicateOperator" minOccurs="0"/>
    <xs:element name="Value" type="xs:string" nillable="true" minOccurs="0"/>
  </xs:sequence>
</xs:complexType>

Elements

Element

Description

Data Type

Field

The account or customer element used to filter the results of the SearchCustomers operation.

The following field strings are available.

Field

Description

AccountId

Use this field to search the Id element of the Account object.

System_CLiX_noteNote

Only the Equals operator is supported for this predicate field.

AccountName

Use this field to search the Name element of the Account object.

AccountNumber

Use this field to search the Number element of the Account object.

CustomerId

Use this field to search the Id element of the Customer object.

System_CLiX_noteNote

Only the Equals operator is supported for this predicate field.

CustomerName

Use this field to search the Name element of the Customer object.

CustomerNumber

Use this field to search the Number element of the Customer object.

Email

Use this field to search the Email element of the ContactInfo object within a User.

MarketCountry

Use this field to search the MarketCountry element of the Customer object.

System_CLiX_noteNote

Only the Equals operator is supported for this predicate field.

The MarketCountry and MarketLanguage predicate fields are not required; however, if either is specified then both are required.

MarketLanguage

Use this field to search the MarketLanguage element of the Customer object.

System_CLiX_noteNote

Only the Equals operator is supported for this predicate field.

The MarketCountry and MarketLanguage predicate fields are not required; however, if either is specified then both are required.

PersonName

Use this field to search the combined FirstName, MiddleInitial, and LastName elements of the PersonName object within a User.

The string value corresponding to elements within PersonName should be separated by spaces in the order of FirstName, MiddleInitial, and LastName.

UserName

Use this field to search the UserName element of the User object.

TaxId

For internal use only.

string

Operator

Defines the relationship between the field and the value.

PredicateOperator

Value

The string to search in the specified field.

System_CLiX_noteNote

The length of this string must be four or greater, unless the corresponding field is set to MarketCountry or MarketLanguage.

string

Requirements

CustomerManagementService.svc v8

Namespace: https://adcenter.microsoft.com/api/customermanagement

Community Additions

Show:
© 2014 Microsoft