HostedSuite

<back to all web services

ListClientsRequest

Retrieve list of client information

The following routes are available for this service:
POST/api/clients
ListClientsRequest Parameters:
NameParameterData TypeRequiredDescription
ClientIdbodystringNoID of the client you want to filter by. When using this only a single result will be returned.
NamebodystringNoName of the client you want to filter by.
CenterIdbodystringNoFilter by center
ThirdPartyAccountIdbodystringNoFilter by third party account ID
ScreenPopbodystringNoFilter by screen pop
CategoryIdsbodyList<string>NoList of category IDs that the client must have
CustomFieldsFilterbodyDictionary<string, string>NoFilter by custom fields
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/clients HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ListClientsRequest 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>
  <CategoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CategoryIds>
  <CenterId>String</CenterId>
  <ClientId>String</ClientId>
  <CustomFieldsFilter xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </CustomFieldsFilter>
  <Name>String</Name>
  <ScreenPop>String</ScreenPop>
  <ThirdPartyAccountId>String</ThirdPartyAccountId>
</ListClientsRequest>

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

<ArrayOfClientInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <ClientInfo>
    <Address>
      <City>String</City>
      <Country>String</Country>
      <PostalCode>String</PostalCode>
      <State>String</State>
      <Street1>String</Street1>
      <Street2>String</Street2>
    </Address>
    <CallAllowanceAmount>0</CallAllowanceAmount>
    <CallAllowanceType>NotBillable</CallAllowanceType>
    <CallInstructions>String</CallInstructions>
    <Categories i:nil="true" />
    <CenterId>String</CenterId>
    <CenterName>String</CenterName>
    <CustomFields>
      <CustomFieldInfo>
        <Name>String</Name>
        <Value>String</Value>
      </CustomFieldInfo>
    </CustomFields>
    <DateLastModified>String</DateLastModified>
    <FaxNumber>String</FaxNumber>
    <Greeting>String</Greeting>
    <Id>String</Id>
    <IndustryId>String</IndustryId>
    <IndustryName>String</IndustryName>
    <Information>String</Information>
    <Links>
      <HyperlinkInfo>
        <Id>String</Id>
        <Name>String</Name>
        <Url>String</Url>
      </HyperlinkInfo>
    </Links>
    <Location>String</Location>
    <Name>String</Name>
    <PopupInformation>String</PopupInformation>
    <ScreenPops xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </ScreenPops>
    <ThirdPartyAccountId>String</ThirdPartyAccountId>
  </ClientInfo>
</ArrayOfClientInfo>