HostedSuite

<back to all web services

MyContactsRequest

Retrieves list of contacts associated with specified contact

The following routes are available for this service:
POST/api/contacts/my-contacts
MyContactsRequest Parameters:
NameParameterData TypeRequiredDescription
ContactIdbodystringNoThe ID of the contact whose associates you want to retrieve
RequestBase<TResponse> Parameters:
NameParameterData TypeRequiredDescription
CustomerNameformstringYesThe HostedSuite Customer Name
UserNameformstringYesThe HostedSuite User Name. Data visibility and security is based on this user's permissions.
PasswordformstringYesThe HostedSuite User's Password

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/contacts/my-contacts HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MyContactsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <CustomerName>String</CustomerName>
  <Password>String</Password>
  <UserName>String</UserName>
  <ContactId>String</ContactId>
</MyContactsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfContactInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <ContactInfo>
    <Address>
      <City>String</City>
      <Country>String</Country>
      <PostalCode>String</PostalCode>
      <State>String</State>
      <Street1>String</Street1>
      <Street2>String</Street2>
    </Address>
    <Alert>String</Alert>
    <CallInstructions>String</CallInstructions>
    <Categories>
      <CategoryInfo>
        <Id>String</Id>
        <Name>String</Name>
      </CategoryInfo>
    </Categories>
    <CenterId>String</CenterId>
    <CenterName>String</CenterName>
    <ClientId>String</ClientId>
    <ClientName>String</ClientName>
    <CustomFields>
      <CustomFieldInfo>
        <Name>String</Name>
        <Value>String</Value>
      </CustomFieldInfo>
    </CustomFields>
    <DateLastModified>String</DateLastModified>
    <EmailAddresses>
      <EmailAddressInfo>
        <Address>String</Address>
        <Id>String</Id>
        <IncludeInNotifications>false</IncludeInNotifications>
        <Name>String</Name>
        <Type>To</Type>
      </EmailAddressInfo>
    </EmailAddresses>
    <FirstName>String</FirstName>
    <GreetingOverride>String</GreetingOverride>
    <HideInConsole>false</HideInConsole>
    <Id>String</Id>
    <Information>String</Information>
    <Keywords xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Keywords>
    <LastName>String</LastName>
    <Links>
      <HyperlinkInfo>
        <Id>String</Id>
        <Name>String</Name>
        <Url>String</Url>
      </HyperlinkInfo>
    </Links>
    <Location>String</Location>
    <LoginMustChangePasswordAtNextLogin>false</LoginMustChangePasswordAtNextLogin>
    <LongDistanceCode>String</LongDistanceCode>
    <MoreInformation>String</MoreInformation>
    <Name>String</Name>
    <PhoneNumbers>
      <PhoneNumberInfo>
        <DialingRuleId>String</DialingRuleId>
        <Id>String</Id>
        <Mobile>false</Mobile>
        <Name>String</Name>
        <Number>String</Number>
        <TransferTypes>Both</TransferTypes>
      </PhoneNumberInfo>
    </PhoneNumbers>
    <SortPositionInConsole>0</SortPositionInConsole>
    <Status>String</Status>
    <ThirdPartyAccountId>String</ThirdPartyAccountId>
    <Title>String</Title>
    <UserGroupId>String</UserGroupId>
    <UserName>String</UserName>
  </ContactInfo>
</ArrayOfContactInfo>