Reference for http://api2.redtailtechnology.com/crm/v1/rest/contacts/searchv2?page={PAGE}&deleted={DELETED}
Url: http://api2.redtailtechnology.com/crm/v1/rest/contacts/searchv2?page={PAGE}&deleted={DELETED}
HTTP Method: POST
Message direction | Format | Body |
---|---|---|
Request | Xml | Example,Schema |
Request | Json | Example |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example request Xml body:
<ArrayOfSearch xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model"> <Search> <Field>lastupdate</Field> <Operand>Equals</Operand> <Value>String content</Value> </Search> <Search> <Field>lastupdate</Field> <Operand>Equals</Operand> <Value>String content</Value> </Search> </ArrayOfSearch>
The following is an example request Json body:
[{ "Field":0, "Operand":0, "Value":"String content" }]
The following is an example response Xml body:
<ContactsSearchExtended_Result xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Responses.v1"> <Contacts> <BasicExtended xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model"> <ClientID>2147483647</ClientID> <CompanyName>String content</CompanyName> <CompanyNameID>2147483647</CompanyNameID> <DatabaseID>2147483647</DatabaseID> <Deleted>true</Deleted> <Designation>String content</Designation> <DobDay>2147483647</DobDay> <DobMonth>2147483647</DobMonth> <FamilyHeadID>2147483647</FamilyHeadID> <FamilyName>String content</FamilyName> <FirstName>String content</FirstName> <IsFamilyHead>true</IsFamilyHead> <JobTitle>String content</JobTitle> <LastName>String content</LastName> <LastUpdate>1999-05-31T11:20:00</LastUpdate> <MiddleName>String content</MiddleName> <Name>String content</Name> <Nickname>String content</Nickname> <Photo>String content</Photo> <RecAddUser>2147483647</RecAddUser> <Salutation>String content</Salutation> <SpouseName>String content</SpouseName> <SpouseNameID>2147483647</SpouseNameID> <Suffix>String content</Suffix> <TaxID>String content</TaxID> <Type>String content</Type> <TypeID>String content</TypeID> </BasicExtended> <BasicExtended xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model"> <ClientID>2147483647</ClientID> <CompanyName>String content</CompanyName> <CompanyNameID>2147483647</CompanyNameID> <DatabaseID>2147483647</DatabaseID> <Deleted>true</Deleted> <Designation>String content</Designation> <DobDay>2147483647</DobDay> <DobMonth>2147483647</DobMonth> <FamilyHeadID>2147483647</FamilyHeadID> <FamilyName>String content</FamilyName> <FirstName>String content</FirstName> <IsFamilyHead>true</IsFamilyHead> <JobTitle>String content</JobTitle> <LastName>String content</LastName> <LastUpdate>1999-05-31T11:20:00</LastUpdate> <MiddleName>String content</MiddleName> <Name>String content</Name> <Nickname>String content</Nickname> <Photo>String content</Photo> <RecAddUser>2147483647</RecAddUser> <Salutation>String content</Salutation> <SpouseName>String content</SpouseName> <SpouseNameID>2147483647</SpouseNameID> <Suffix>String content</Suffix> <TaxID>String content</TaxID> <Type>String content</Type> <TypeID>String content</TypeID> </BasicExtended> </Contacts> <TotalRecords>2147483647</TotalRecords> </ContactsSearchExtended_Result>
The following is an example response Json body:
{ "Contacts":[{ "ClientID":2147483647, "CompanyName":"String content", "CompanyNameID":2147483647, "DatabaseID":2147483647, "Deleted":true, "Designation":"String content", "DobDay":2147483647, "DobMonth":2147483647, "FamilyHeadID":2147483647, "FamilyName":"String content", "FirstName":"String content", "IsFamilyHead":true, "JobTitle":"String content", "LastName":"String content", "LastUpdate":"\/Date(928174800000-0700)\/", "MiddleName":"String content", "Name":"String content", "Nickname":"String content", "Photo":"String content", "RecAddUser":2147483647, "Salutation":"String content", "SpouseName":"String content", "SpouseNameID":2147483647, "Suffix":"String content", "TaxID":"String content", "Type":"String content", "TypeID":"String content" }], "TotalRecords":2147483647 }
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/REDTAIL.Model" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/REDTAIL.Model" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:complexType name="ArrayOfSearch"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Search" nillable="true" type="tns:Search" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfSearch" nillable="true" type="tns:ArrayOfSearch" /> <xs:complexType name="Search"> <xs:sequence> <xs:element minOccurs="0" name="Field" type="tns:Search.SearchField" /> <xs:element minOccurs="0" name="Operand" type="tns:Search.SearchOperand" /> <xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="Search" nillable="true" type="tns:Search" /> <xs:simpleType name="Search.SearchField"> <xs:restriction base="xs:string"> <xs:enumeration value="lastupdate" /> <xs:enumeration value="name" /> <xs:enumeration value="recadd" /> <xs:enumeration value="phoneNumber" /> <xs:enumeration value="tag_group" /> <xs:enumeration value="firstname" /> <xs:enumeration value="lastname" /> <xs:enumeration value="familyname" /> <xs:enumeration value="familyhead" /> <xs:enumeration value="clientStatus" /> <xs:enumeration value="contactType" /> <xs:enumeration value="clientSource" /> <xs:enumeration value="city" /> <xs:enumeration value="state" /> <xs:enumeration value="zip" /> <xs:enumeration value="employer" /> <xs:enumeration value="emailaddress" /> <xs:enumeration value="intellisearch" /> <xs:enumeration value="accountNumber" /> <xs:enumeration value="taxid"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">73</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> <xs:element name="Search.SearchField" nillable="true" type="tns:Search.SearchField" /> <xs:simpleType name="Search.SearchOperand"> <xs:restriction base="xs:string"> <xs:enumeration value="Equals" /> <xs:enumeration value="GreaterThan" /> <xs:enumeration value="LessThan" /> <xs:enumeration value="NotEqual" /> <xs:enumeration value="Like" /> <xs:enumeration value="Begins" /> <xs:enumeration value="IsEmpty" /> </xs:restriction> </xs:simpleType> <xs:element name="Search.SearchOperand" nillable="true" type="tns:Search.SearchOperand" /> </xs:schema>
Additional request Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Responses.v1" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Responses.v1" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.datacontract.org/2004/07/REDTAIL.Model" /> <xs:complexType name="ContactsSearchExtended_Result"> <xs:sequence> <xs:element minOccurs="0" name="Contacts" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/REDTAIL.Model" type="q1:ArrayOfBasicExtended" /> <xs:element minOccurs="0" name="TotalRecords" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="ContactsSearchExtended_Result" nillable="true" type="tns:ContactsSearchExtended_Result" /> </xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/REDTAIL.Model" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/REDTAIL.Model" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfBasicExtended"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="BasicExtended" nillable="true" type="tns:BasicExtended" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfBasicExtended" nillable="true" type="tns:ArrayOfBasicExtended" /> <xs:complexType name="BasicExtended"> <xs:sequence> <xs:element minOccurs="0" name="ClientID" type="xs:int" /> <xs:element minOccurs="0" name="CompanyName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CompanyNameID" type="xs:int" /> <xs:element minOccurs="0" name="DatabaseID" type="xs:int" /> <xs:element minOccurs="0" name="Deleted" type="xs:boolean" /> <xs:element minOccurs="0" name="Designation" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="DobDay" type="xs:int" /> <xs:element minOccurs="0" name="DobMonth" type="xs:int" /> <xs:element minOccurs="0" name="FamilyHeadID" type="xs:int" /> <xs:element minOccurs="0" name="FamilyName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="FirstName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="IsFamilyHead" type="xs:boolean" /> <xs:element minOccurs="0" name="JobTitle" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="LastName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="LastUpdate" type="xs:dateTime" /> <xs:element minOccurs="0" name="MiddleName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Nickname" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Photo" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="RecAddUser" type="xs:int" /> <xs:element minOccurs="0" name="Salutation" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SpouseName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SpouseNameID" type="xs:int" /> <xs:element minOccurs="0" name="Suffix" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="TaxID" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Type" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="TypeID" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="BasicExtended" nillable="true" type="tns:BasicExtended" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>