Reference for http://api2.redtailtechnology.com/crm/v1/rest/contacts/search/beginswith?value={VALUE}&page={PAGE}
Url: http://api2.redtailtechnology.com/crm/v1/rest/contacts/search/beginswith?value={VALUE}&page={PAGE}
HTTP Method: GET
Message direction | Format | Body |
---|---|---|
Request | N/A | The Request body is empty. |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example response Xml body:
<Contacts_Result xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Responses.v1"> <Contacts> <Name xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Contact"> <ContactID>2147483647</ContactID> <DatabaseID>2147483647</DatabaseID> <FullName2>String content</FullName2> <FullName3>String content</FullName3> <FullName4>String content</FullName4> <fullname1>String content</fullname1> <shortname1>String content</shortname1> <shortname2>String content</shortname2> </Name> <Name xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Contact"> <ContactID>2147483647</ContactID> <DatabaseID>2147483647</DatabaseID> <FullName2>String content</FullName2> <FullName3>String content</FullName3> <FullName4>String content</FullName4> <fullname1>String content</fullname1> <shortname1>String content</shortname1> <shortname2>String content</shortname2> </Name> </Contacts> <TotalRecords>2147483647</TotalRecords> </Contacts_Result>
The following is an example response Json body:
{ "Contacts":[{ "ContactID":2147483647, "DatabaseID":2147483647, "FullName2":"String content", "FullName3":"String content", "FullName4":"String content", "fullname1":"String content", "shortname1":"String content", "shortname2":"String content" }], "TotalRecords":2147483647 }
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.Contact" /> <xs:complexType name="Contacts_Result"> <xs:sequence> <xs:element minOccurs="0" name="Contacts" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Contact" type="q1:ArrayOfName" /> <xs:element minOccurs="0" name="TotalRecords" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="Contacts_Result" nillable="true" type="tns:Contacts_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.Contact" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Contact" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfName"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Name" nillable="true" type="tns:Name" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfName" nillable="true" type="tns:ArrayOfName" /> <xs:complexType name="Name"> <xs:sequence> <xs:element minOccurs="0" name="ContactID" type="xs:int" /> <xs:element minOccurs="0" name="DatabaseID" type="xs:int" /> <xs:element minOccurs="0" name="FullName2" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="FullName3" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="FullName4" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="fullname1" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="shortname1" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="shortname2" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="Name" nillable="true" type="tns:Name" /> </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>