Reference for http://api2.redtailtechnology.com/crm/v1/rest/contacts/{CONTACTID}/family/contacts
Url: http://api2.redtailtechnology.com/crm/v1/rest/contacts/{CONTACTID}/family/contacts
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:
<ArrayOfRecord xmlns="http://schemas.datacontract.org/2004/07/RedtailRESTAPI.CRM.v4"> <Record> <AnniversaryDate>1999-05-31T11:20:00</AnniversaryDate> <Category>String content</Category> <CategoryID>2147483647</CategoryID> <ClientID>2147483647</ClientID> <ClientSinceDate>1999-05-31T11:20:00</ClientSinceDate> <Company>String content</Company> <CompanyID>2147483647</CompanyID> <DatabaseID>2147483647</DatabaseID> <DateOfBirth>1999-05-31T11:20:00</DateOfBirth> <Deleted>true</Deleted> <DeletedOn>1999-05-31T11:20:00</DeletedOn> <Designation>String content</Designation> <Family>true</Family> <FamilyHeadID>2147483647</FamilyHeadID> <Familyname>String content</Familyname> <Firstname>String content</Firstname> <Gender>String content</Gender> <JobTitle>String content</JobTitle> <LastUpdate>1999-05-31T11:20:00</LastUpdate> <Lastname>String content</Lastname> <MaritalStatus>String content</MaritalStatus> <Middlename>String content</Middlename> <Name>String content</Name> <Nickname>String content</Nickname> <RecAdd>1999-05-31T11:20:00</RecAdd> <RecAddUser>2147483647</RecAddUser> <ReferredBy>String content</ReferredBy> <Salutation>String content</Salutation> <ServicingAdvisor>String content</ServicingAdvisor> <ServicingAdvisorID>2147483647</ServicingAdvisorID> <Source>String content</Source> <SourceID>2147483647</SourceID> <Status>String content</Status> <StatusID>2147483647</StatusID> <Suffix>String content</Suffix> <TaxID>String content</TaxID> <Type>String content</Type> <TypeID>String content</TypeID> <WritingAdvisor>String content</WritingAdvisor> <WritingAdvisorID>2147483647</WritingAdvisorID> <exception>String content</exception> </Record> <Record> <AnniversaryDate>1999-05-31T11:20:00</AnniversaryDate> <Category>String content</Category> <CategoryID>2147483647</CategoryID> <ClientID>2147483647</ClientID> <ClientSinceDate>1999-05-31T11:20:00</ClientSinceDate> <Company>String content</Company> <CompanyID>2147483647</CompanyID> <DatabaseID>2147483647</DatabaseID> <DateOfBirth>1999-05-31T11:20:00</DateOfBirth> <Deleted>true</Deleted> <DeletedOn>1999-05-31T11:20:00</DeletedOn> <Designation>String content</Designation> <Family>true</Family> <FamilyHeadID>2147483647</FamilyHeadID> <Familyname>String content</Familyname> <Firstname>String content</Firstname> <Gender>String content</Gender> <JobTitle>String content</JobTitle> <LastUpdate>1999-05-31T11:20:00</LastUpdate> <Lastname>String content</Lastname> <MaritalStatus>String content</MaritalStatus> <Middlename>String content</Middlename> <Name>String content</Name> <Nickname>String content</Nickname> <RecAdd>1999-05-31T11:20:00</RecAdd> <RecAddUser>2147483647</RecAddUser> <ReferredBy>String content</ReferredBy> <Salutation>String content</Salutation> <ServicingAdvisor>String content</ServicingAdvisor> <ServicingAdvisorID>2147483647</ServicingAdvisorID> <Source>String content</Source> <SourceID>2147483647</SourceID> <Status>String content</Status> <StatusID>2147483647</StatusID> <Suffix>String content</Suffix> <TaxID>String content</TaxID> <Type>String content</Type> <TypeID>String content</TypeID> <WritingAdvisor>String content</WritingAdvisor> <WritingAdvisorID>2147483647</WritingAdvisorID> <exception>String content</exception> </Record> </ArrayOfRecord>
The following is an example response Json body:
[{ "AnniversaryDate":"\/Date(928149600000+0000)\/", "Category":"String content", "CategoryID":2147483647, "ClientID":2147483647, "ClientSinceDate":"\/Date(928149600000+0000)\/", "Company":"String content", "CompanyID":2147483647, "DatabaseID":2147483647, "DateOfBirth":"\/Date(928149600000+0000)\/", "Deleted":true, "DeletedOn":"\/Date(928149600000+0000)\/", "Designation":"String content", "Family":true, "FamilyHeadID":2147483647, "Familyname":"String content", "Firstname":"String content", "Gender":"String content", "JobTitle":"String content", "LastUpdate":"\/Date(928149600000+0000)\/", "Lastname":"String content", "MaritalStatus":"String content", "Middlename":"String content", "Name":"String content", "Nickname":"String content", "RecAdd":"\/Date(928149600000+0000)\/", "RecAddUser":2147483647, "ReferredBy":"String content", "Salutation":"String content", "ServicingAdvisor":"String content", "ServicingAdvisorID":2147483647, "Source":"String content", "SourceID":2147483647, "Status":"String content", "StatusID":2147483647, "Suffix":"String content", "TaxID":"String content", "Type":"String content", "TypeID":"String content", "WritingAdvisor":"String content", "WritingAdvisorID":2147483647, "exception":"String content" }]
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/RedtailRESTAPI.CRM.v4" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/RedtailRESTAPI.CRM.v4" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfRecord"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="Record" nillable="true" type="tns:Record" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfRecord" nillable="true" type="tns:ArrayOfRecord" /> <xs:complexType name="Record"> <xs:sequence> <xs:element minOccurs="0" name="AnniversaryDate" type="xs:dateTime" /> <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="ClientSinceDate" type="xs:dateTime" /> <xs:element minOccurs="0" name="Company" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CompanyID" type="xs:int" /> <xs:element minOccurs="0" name="DatabaseID" type="xs:int" /> <xs:element minOccurs="0" name="DateOfBirth" type="xs:dateTime" /> <xs:element minOccurs="0" name="Deleted" type="xs:boolean" /> <xs:element minOccurs="0" name="DeletedOn" type="xs:dateTime" /> <xs:element minOccurs="0" name="Designation" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Family" type="xs:boolean" /> <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="Gender" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="JobTitle" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="LastUpdate" type="xs:dateTime" /> <xs:element minOccurs="0" name="Lastname" nillable="true" type="xs:string" /> <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="Nickname" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="RecAdd" type="xs:dateTime" /> <xs:element minOccurs="0" name="RecAddUser" type="xs:int" /> <xs:element minOccurs="0" name="ReferredBy" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Salutation" 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="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:element minOccurs="0" name="WritingAdvisor" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="WritingAdvisorID" type="xs:int" /> <xs:element minOccurs="0" name="exception" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="Record" nillable="true" type="tns:Record" /> </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>
<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>