Trendsic Platform Service

ContactSearchRequest

**Requires Authentication**
Requires any of the roles:	Worker, Agent, Administrator

The following routes are available for this service:
POST,OPTIONS	/v1/ContactSearch

**ContactSearchRequest** Parameters:
Name	Parameter	Data Type	Required
AgentId	body	int	No
ContactStatusId	body	int	No
SourceTypeId	body	int	No
ContactCategory	body	int	No
CreatedAfterDate	body	DateTime	No
CreatedBeforeDate	body	DateTime	No

**ContactResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Contact	form	List<Contact>	No

**Contact** Parameters:
Name	Parameter	Data Type	Required
ContactId	form	int	No
ContactType	form	int	No
FirstName	form	string	No
LastName	form	string	No
Name	form	string	No
Role	form	string	No
Title	form	string	No
EmailWork	form	string	No
EmailPersonal	form	string	No
District	form	string	No
DistrictID	form	int	No
School	form	string	No
SchoolID	form	long	No
State	form	string	No
StateName	form	string	No
StateID	form	long	No
CountyID	form	long	No
County	form	string	No
Phone	form	string	No
Department	form	string	No
Flow	form	string	No
LastContact	form	DateTime	No
DoNotContact	form	bool	No
Active	form	bool	No
AgentId	form	int	No
PhoneAlt	form	string	No
PeraContactId	form	int	No
RoomNumber	form	string	No
SourceTypeId	form	int	No
SourceTypeDesc	form	string	No
SourceNote	form	string	No
ContactStatusId	form	int	No
ContactStatusDesc	form	string	No
SSN	form	string	No
DateOfBirth	form	DateTime	No
Deleted	form	bool	No
IsShared	form	bool	No
address_line1	form	string	No
address_city	form	string	No
address_state	form	string	No
address_zip	form	string	No
DeletedBy	form	string	No
DeletedDateTimeUtc	form	DateTime?	No
HasNBC	form	bool	No
HasFactFinderSheet	form	bool	No
MiddleInitial	form	string	No
Tags	form	string	No
DateCreated	form	DateTime	No
PhoneLabel	form	string	No
AltPhoneLabel	form	string	No
Carriers	form	string	No
ContactImage	form	string	No
CompanyAffiliation	form	string	No
AdditionalInformation	form	string	No
HasGiftCard	form	bool	No
ContactCategory	form	int	No
WritingAgentId	form	int	No
WritingAgentName	form	string	No
MaritalStatus	form	string	No
TotalDebtAmount	form	decimal	No
NumberOfDebtAccounts	form	int	No
FactFinderCodeId	form	int	No
BusinessName	form	string	No
DBA	form	string	No
ContactGUID	form	Guid	No
ProjectEndDate	form	DateTime	No
Rate	form	int	No
JobID	form	int	No
JobName	form	string	No
JobCount	form	int	No
Locked	form	bool	No
LockedByAgentId	form	int	No
LockedTimestamp	form	DateTime	No
Initials	form	string	No
ContactCategoryName	form	string	No
SMSOptIn	form	bool	No

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 /v1/ContactSearch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ContactSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentId>0</AgentId>
  <ContactCategory>0</ContactCategory>
  <ContactStatusId>0</ContactStatusId>
  <CreatedAfterDate>0001-01-01T00:00:00</CreatedAfterDate>
  <CreatedBeforeDate>0001-01-01T00:00:00</CreatedBeforeDate>
  <SourceTypeId>0</SourceTypeId>
</ContactSearchRequest>

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

<ContactResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Contact>
    <Contact>
      <Active>false</Active>
      <AdditionalInformation>String</AdditionalInformation>
      <AgentId>0</AgentId>
      <AltPhoneLabel>String</AltPhoneLabel>
      <BusinessName>String</BusinessName>
      <Carriers>String</Carriers>
      <CompanyAffiliation>String</CompanyAffiliation>
      <ContactCategory>0</ContactCategory>
      <ContactCategoryName>String</ContactCategoryName>
      <ContactGUID>00000000-0000-0000-0000-000000000000</ContactGUID>
      <ContactId>0</ContactId>
      <ContactImage>String</ContactImage>
      <ContactStatusDesc>String</ContactStatusDesc>
      <ContactStatusId>0</ContactStatusId>
      <ContactType>0</ContactType>
      <County>String</County>
      <CountyID>0</CountyID>
      <DBA>String</DBA>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
      <Deleted>false</Deleted>
      <DeletedBy>String</DeletedBy>
      <DeletedDateTimeUtc>0001-01-01T00:00:00</DeletedDateTimeUtc>
      <Department>String</Department>
      <District>String</District>
      <DistrictID>0</DistrictID>
      <DoNotContact>false</DoNotContact>
      <EmailPersonal>String</EmailPersonal>
      <EmailWork>String</EmailWork>
      <FactFinderCodeId>0</FactFinderCodeId>
      <FirstName>String</FirstName>
      <Flow>String</Flow>
      <HasFactFinderSheet>false</HasFactFinderSheet>
      <HasGiftCard>false</HasGiftCard>
      <HasNBC>false</HasNBC>
      <Initials>String</Initials>
      <IsShared>false</IsShared>
      <JobCount>0</JobCount>
      <JobID>0</JobID>
      <JobName>String</JobName>
      <LastContact>0001-01-01T00:00:00</LastContact>
      <LastName>String</LastName>
      <Locked>false</Locked>
      <LockedByAgentId>0</LockedByAgentId>
      <LockedTimestamp>0001-01-01T00:00:00</LockedTimestamp>
      <MaritalStatus>String</MaritalStatus>
      <MiddleInitial>String</MiddleInitial>
      <Name>String</Name>
      <NumberOfDebtAccounts>0</NumberOfDebtAccounts>
      <PeraContactId>0</PeraContactId>
      <Phone>String</Phone>
      <PhoneAlt>String</PhoneAlt>
      <PhoneLabel>String</PhoneLabel>
      <ProjectEndDate>0001-01-01T00:00:00</ProjectEndDate>
      <Rate>0</Rate>
      <Role>String</Role>
      <RoomNumber>String</RoomNumber>
      <SMSOptIn>false</SMSOptIn>
      <SSN>String</SSN>
      <School>String</School>
      <SchoolID>0</SchoolID>
      <SourceNote>String</SourceNote>
      <SourceTypeDesc>String</SourceTypeDesc>
      <SourceTypeId>0</SourceTypeId>
      <State>String</State>
      <StateID>0</StateID>
      <StateName>String</StateName>
      <Tags>String</Tags>
      <Title>String</Title>
      <TotalDebtAmount>0</TotalDebtAmount>
      <WritingAgentId>0</WritingAgentId>
      <WritingAgentName>String</WritingAgentName>
      <address_city>String</address_city>
      <address_line1>String</address_line1>
      <address_state>String</address_state>
      <address_zip>String</address_zip>
    </Contact>
  </Contact>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ContactResponse>