Reference for http://api2.redtailtechnology.com/crm/v1/rest/contacts?Page={PAGE}&Type={TYPE}&Name={NAME}
Url: http://api2.redtailtechnology.com/crm/v1/rest/contacts?Page={PAGE}&Type={TYPE}&Name={NAME}
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:
<ContactRecords_Result xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model.Responses.v1"> <Detail> <Detail xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model"> <Age>2147483647</Age> <Category>String content</Category> <CategoryID>2147483647</CategoryID> <ClientID>2147483647</ClientID> <ClientSince>1999-05-31T11:20:00</ClientSince> <ClientType>String content</ClientType> <DateofBirth>1999-05-31T11:20:00</DateofBirth> <DateofBirthReminder>true</DateofBirthReminder> <FirstName>String content</FirstName> <Gender>String content</Gender> <InputBy>String content</InputBy> <InputByID>2147483647</InputByID> <InputDate>1999-05-31T11:20:00</InputDate> <LastName>String content</LastName> <MaritalDate>1999-05-31T11:20:00</MaritalDate> <MaritalStatus>String content</MaritalStatus> <MiddleName>String content</MiddleName> <Name>String content</Name> <ReferredBy>String content</ReferredBy> <ServicingAdvisor>String content</ServicingAdvisor> <ServicingAdvisorID>2147483647</ServicingAdvisorID> <Source>String content</Source> <SourceID>2147483647</SourceID> <Status>String content</Status> <StatusID>2147483647</StatusID> <TaxID>String content</TaxID> <WritingAdvisor>String content</WritingAdvisor> <WritingAdvisorID>2147483647</WritingAdvisorID> </Detail> <Detail xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model"> <Age>2147483647</Age> <Category>String content</Category> <CategoryID>2147483647</CategoryID> <ClientID>2147483647</ClientID> <ClientSince>1999-05-31T11:20:00</ClientSince> <ClientType>String content</ClientType> <DateofBirth>1999-05-31T11:20:00</DateofBirth> <DateofBirthReminder>true</DateofBirthReminder> <FirstName>String content</FirstName> <Gender>String content</Gender> <InputBy>String content</InputBy> <InputByID>2147483647</InputByID> <InputDate>1999-05-31T11:20:00</InputDate> <LastName>String content</LastName> <MaritalDate>1999-05-31T11:20:00</MaritalDate> <MaritalStatus>String content</MaritalStatus> <MiddleName>String content</MiddleName> <Name>String content</Name> <ReferredBy>String content</ReferredBy> <ServicingAdvisor>String content</ServicingAdvisor> <ServicingAdvisorID>2147483647</ServicingAdvisorID> <Source>String content</Source> <SourceID>2147483647</SourceID> <Status>String content</Status> <StatusID>2147483647</StatusID> <TaxID>String content</TaxID> <WritingAdvisor>String content</WritingAdvisor> <WritingAdvisorID>2147483647</WritingAdvisorID> </Detail> </Detail> <TotalRecords>2147483647</TotalRecords> </ContactRecords_Result>
The following is an example response Json body:
{ "Detail":[{ "Age":2147483647, "Category":"String content", "CategoryID":2147483647, "ClientID":2147483647, "ClientSince":"\/Date(928174800000-0700)\/", "ClientType":"String content", "DateofBirth":"\/Date(928174800000-0700)\/", "DateofBirthReminder":true, "FirstName":"String content", "Gender":"String content", "InputBy":"String content", "InputByID":2147483647, "InputDate":"\/Date(928174800000-0700)\/", "LastName":"String content", "MaritalDate":"\/Date(928174800000-0700)\/", "MaritalStatus":"String content", "MiddleName":"String content", "Name":"String content", "ReferredBy":"String content", "ServicingAdvisor":"String content", "ServicingAdvisorID":2147483647, "Source":"String content", "SourceID":2147483647, "Status":"String content", "StatusID":2147483647, "TaxID":"String content", "WritingAdvisor":"String content", "WritingAdvisorID":2147483647 }], "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" /> <xs:complexType name="ContactRecords_Result"> <xs:sequence> <xs:element minOccurs="0" name="Detail" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/REDTAIL.Model" type="q1:ArrayOfDetail" /> <xs:element minOccurs="0" name="TotalRecords" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="ContactRecords_Result" nillable="true" type="tns:ContactRecords_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="ArrayOfDetail"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Detail" nillable="true" type="tns:Detail" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfDetail" nillable="true" type="tns:ArrayOfDetail" /> <xs:complexType name="Detail"> <xs:sequence> <xs:element minOccurs="0" name="Age" type="xs:int" /> <xs:element minOccurs="0" name="Category" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CategoryID" type="xs:int" /> <xs:element minOccurs="0" name="ClientID" type="xs:int" /> <xs:element minOccurs="0" name="ClientSince" type="xs:dateTime" /> <xs:element minOccurs="0" name="ClientType" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="DateofBirth" type="xs:dateTime" /> <xs:element minOccurs="0" name="DateofBirthReminder" type="xs:boolean" /> <xs:element minOccurs="0" name="FirstName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Gender" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="InputBy" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="InputByID" type="xs:int" /> <xs:element minOccurs="0" name="InputDate" type="xs:dateTime" /> <xs:element minOccurs="0" name="LastName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="MaritalDate" type="xs:dateTime" /> <xs:element minOccurs="0" name="MaritalStatus" nillable="true" type="xs:string" /> <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="ReferredBy" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ServicingAdvisor" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ServicingAdvisorID" type="xs:int" /> <xs:element minOccurs="0" name="Source" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SourceID" type="xs:int" /> <xs:element minOccurs="0" name="Status" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="StatusID" type="xs:int" /> <xs:element minOccurs="0" name="TaxID" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="WritingAdvisor" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="WritingAdvisorID" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="Detail" nillable="true" type="tns:Detail" /> </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>