MicrosoftOfficeLiveBusinessContactManager.GetContacts Method

Article
05/05/2014
2 minutes to read

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Returns the list of contacts in the specified contact group that match the search term.

Namespace: WebBCM
Assembly: OfficeLive (in OfficeLive.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("http://schemas.microsoft.com/officelive/soap/GetContacts", RequestNamespace := "http://schemas.microsoft.com/officelive/soap/",  _
    ResponseNamespace := "http://schemas.microsoft.com/officelive/soap/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
<SoapHeaderAttribute("AuditHeaderValue")> _
<SoapHeaderAttribute("UserHeaderValue")> _
Public Function GetContacts ( _
    ContactGroup As String, _
    SearchTerm As String, _
    IsCompactResult As Boolean _
) As Contact()

'Usage
Dim instance As MicrosoftOfficeLiveBusinessContactManager
Dim ContactGroup As String
Dim SearchTerm As String
Dim IsCompactResult As Boolean
Dim returnValue As Contact()

returnValue = instance.GetContacts(ContactGroup, _
    SearchTerm, IsCompactResult)

[SoapDocumentMethodAttribute("http://schemas.microsoft.com/officelive/soap/GetContacts", RequestNamespace = "http://schemas.microsoft.com/officelive/soap/", 
    ResponseNamespace = "http://schemas.microsoft.com/officelive/soap/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("AuditHeaderValue")]
[SoapHeaderAttribute("UserHeaderValue")]
public Contact[] GetContacts(
    string ContactGroup,
    string SearchTerm,
    bool IsCompactResult
)

Parameters

ContactGroup
Type: System.String
ContactGroup Default groups are named:
- Lead or Prospect
- Customer
- Vendor
- Employee
- Newsletter Subscriber
- This parameter must be set to NULL to get all contacts.

SearchTerm
Type: System.String
String on which to filter this search.
This parameter must be set to NULL to get all contacts.

IsCompactResult
Type: System.Boolean
Boolean to request compacted results.

Return Value

Type: []
Array of Contact objects

Remarks

Fields available to match are:

ContactFullname
WorkPhone
CellPhone
HomePhone
Business2Number
PagerNumber
WorkFax
OtherFaxNumber
Email
Email2
IMAddress

Examples

For an interactive example of this method, download the Contact Manager Web service examples tool from the MSDN Code Gallery.