Reference for http://api2.redtailtechnology.com/crm/v1/rest/contacts/family
Url: http://api2.redtailtechnology.com/crm/v1/rest/contacts/family
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:
<ArrayOfint xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <int>2147483647</int> <int>2147483647</int> </ArrayOfint>
The following is an example request Json body:
[2147483647]
The following is an example response Xml body:
<ArrayOfFamilyRelations xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model"> <FamilyRelations> <ContactID>2147483647</ContactID> <FamilyBasic> <FamilyBasic> <FromGenderID>2147483647</FromGenderID> <FromID>2147483647</FromID> <HeadOfHousehold>true</HeadOfHousehold> <Recid>2147483647</Recid> <RelationshipID>2147483647</RelationshipID> <ToGenderID>2147483647</ToGenderID> <ToID>2147483647</ToID> </FamilyBasic> <FamilyBasic> <FromGenderID>2147483647</FromGenderID> <FromID>2147483647</FromID> <HeadOfHousehold>true</HeadOfHousehold> <Recid>2147483647</Recid> <RelationshipID>2147483647</RelationshipID> <ToGenderID>2147483647</ToGenderID> <ToID>2147483647</ToID> </FamilyBasic> </FamilyBasic> </FamilyRelations> <FamilyRelations> <ContactID>2147483647</ContactID> <FamilyBasic> <FamilyBasic> <FromGenderID>2147483647</FromGenderID> <FromID>2147483647</FromID> <HeadOfHousehold>true</HeadOfHousehold> <Recid>2147483647</Recid> <RelationshipID>2147483647</RelationshipID> <ToGenderID>2147483647</ToGenderID> <ToID>2147483647</ToID> </FamilyBasic> <FamilyBasic> <FromGenderID>2147483647</FromGenderID> <FromID>2147483647</FromID> <HeadOfHousehold>true</HeadOfHousehold> <Recid>2147483647</Recid> <RelationshipID>2147483647</RelationshipID> <ToGenderID>2147483647</ToGenderID> <ToID>2147483647</ToID> </FamilyBasic> </FamilyBasic> </FamilyRelations> </ArrayOfFamilyRelations>
The following is an example response Json body:
[{ "ContactID":2147483647, "FamilyBasic":[{ "FromGenderID":2147483647, "FromID":2147483647, "HeadOfHousehold":true, "Recid":2147483647, "RelationshipID":2147483647, "ToGenderID":2147483647, "ToID":2147483647 }] }]
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfint"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="int" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfint" nillable="true" type="tns:ArrayOfint" /> </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" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/REDTAIL.Model" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfFamilyRelations"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="FamilyRelations" nillable="true" type="tns:FamilyRelations" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfFamilyRelations" nillable="true" type="tns:ArrayOfFamilyRelations" /> <xs:complexType name="FamilyRelations"> <xs:sequence> <xs:element minOccurs="0" name="ContactID" type="xs:int" /> <xs:element minOccurs="0" name="FamilyBasic" nillable="true" type="tns:ArrayOfFamilyBasic" /> </xs:sequence> </xs:complexType> <xs:element name="FamilyRelations" nillable="true" type="tns:FamilyRelations" /> <xs:complexType name="ArrayOfFamilyBasic"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="FamilyBasic" nillable="true" type="tns:FamilyBasic" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfFamilyBasic" nillable="true" type="tns:ArrayOfFamilyBasic" /> <xs:complexType name="FamilyBasic"> <xs:sequence> <xs:element minOccurs="0" name="FromGenderID" type="xs:int" /> <xs:element minOccurs="0" name="FromID" type="xs:int" /> <xs:element minOccurs="0" name="HeadOfHousehold" type="xs:boolean" /> <xs:element minOccurs="0" name="Recid" type="xs:int" /> <xs:element minOccurs="0" name="RelationshipID" type="xs:int" /> <xs:element minOccurs="0" name="ToGenderID" type="xs:int" /> <xs:element minOccurs="0" name="ToID" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="FamilyBasic" nillable="true" type="tns:FamilyBasic" /> </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>