Reference for http://api2.redtailtechnology.com/crm/v1/rest/contacts/{CONTACTID}/familyv2

Url: http://api2.redtailtechnology.com/crm/v1/rest/contacts/{CONTACTID}/familyv2

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:

<ArrayOfFamilyExtended xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model">
  <FamilyExtended>
    <FamilyName>String content</FamilyName>
    <FromName>String content</FromName>
    <FromNameID>2147483647</FromNameID>
    <RecID>2147483647</RecID>
    <Relationship>String content</Relationship>
    <RelationshipID>2147483647</RelationshipID>
    <RelationshipLabel>String content</RelationshipLabel>
    <ToName>String content</ToName>
    <ToNameID>2147483647</ToNameID>
    <FamilyID>2147483647</FamilyID>
  </FamilyExtended>
  <FamilyExtended>
    <FamilyName>String content</FamilyName>
    <FromName>String content</FromName>
    <FromNameID>2147483647</FromNameID>
    <RecID>2147483647</RecID>
    <Relationship>String content</Relationship>
    <RelationshipID>2147483647</RelationshipID>
    <RelationshipLabel>String content</RelationshipLabel>
    <ToName>String content</ToName>
    <ToNameID>2147483647</ToNameID>
    <FamilyID>2147483647</FamilyID>
  </FamilyExtended>
</ArrayOfFamilyExtended>

The following is an example response Json body:

[{
	"FamilyName":"String content",
	"FromName":"String content",
	"FromNameID":2147483647,
	"RecID":2147483647,
	"Relationship":"String content",
	"RelationshipID":2147483647,
	"RelationshipLabel":"String content",
	"ToName":"String content",
	"ToNameID":2147483647,
	"FamilyID":2147483647
}]

The following is the response 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:complexType name="ArrayOfFamilyExtended">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="FamilyExtended" nillable="true" type="tns:FamilyExtended" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="ArrayOfFamilyExtended" nillable="true" type="tns:ArrayOfFamilyExtended" />
  <xs:complexType name="FamilyExtended">
    <xs:complexContent mixed="false">
      <xs:extension base="tns:Family">
        <xs:sequence>
          <xs:element minOccurs="0" name="FamilyID" type="xs:int" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:element name="FamilyExtended" nillable="true" type="tns:FamilyExtended" />
  <xs:complexType name="Family">
    <xs:sequence>
      <xs:element minOccurs="0" name="FamilyName" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="FromName" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="FromNameID" type="xs:int" />
      <xs:element minOccurs="0" name="RecID" type="xs:int" />
      <xs:element minOccurs="0" name="Relationship" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="RelationshipID" type="xs:int" />
      <xs:element minOccurs="0" name="RelationshipLabel" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="ToName" nillable="true" type="xs:string" />
      <xs:element minOccurs="0" name="ToNameID" type="xs:int" />
    </xs:sequence>
  </xs:complexType>
  <xs:element name="Family" nillable="true" type="tns:Family" />
</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>