WebCrmApiSearchPerson Method |
Returns a list of Organisation_ID and Person_ID pairs (max 10000).
The list is sorted by name.
Namespace: dk.webCRM.ApiSync.WebServiceAssembly: dk.webCRM.ApiSync.WebService (in dk.webCRM.ApiSync.WebService.dll) Version: 2.0.0.5 (2.0.0.5)
Syntaxpublic SearchPersonResult SearchPerson(
int searchFieldNumber,
string searchValue,
long organisationID,
SearchOptions options
)
Public Function SearchPerson (
searchFieldNumber As Integer,
searchValue As String,
organisationID As Long,
options As SearchOptions
) As SearchPersonResult
public:
SearchPersonResult^ SearchPerson(
int searchFieldNumber,
String^ searchValue,
long long organisationID,
SearchOptions options
)
member SearchPerson :
searchFieldNumber : int *
searchValue : string *
organisationID : int64 *
options : SearchOptions -> SearchPersonResult
Parameters
- searchFieldNumber
- Type: SystemInt32
Identifies type of data used for the search:
- 1: Peson name.
- 2: Person email.
- 3: Direct telephone or Mobile number (Telephone or Mobile for B2C version).
- X: Custom field value. X can be 101 to 116 (= custom field 1 to 16).
- Y: Checkmark custom field value. Y can be 201 to 210 ( = checkmark field 1 – 10 ).
- searchValue
- Type: SystemString
Value used for the search.
It may include "%" in the beginning or end as wild cards.
Search value must not exceed 50 characters in length. - organisationID
- Type: SystemInt64
Organisation ID.
This value can be zero to search in all organisations
or greater than 0 to limit to a specific organisation. - options
- Type: dk.webCRM.ApiSync.BusinessLayer.EnumsSearchOptions
Enables specify additional search options:
IgnoreCase: indicates whether to ignore case.
Return Value
Type:
SearchPersonResultReturns the count and a list of organisation ID and person ID pairs (max 10000) value.
Examples
WebCrmApiSoapClient proxy = new WebCrmApiSoapClient();
ErrorStatus errorStatus;
TicketHeader ticket = proxy.Authenticate("cm1111aaaaaa", "username", "password", out errorStatus);
SearchPersonResult result = Proxy.SearchPerson(ticket, 1, "Edvin Van Der Sar", 0, SearchOptions.None);
See Also