Reference for http://api2.redtailtechnology.com/crm/v1/rest/contacts/{CONTACTID}/documents
Url: http://api2.redtailtechnology.com/crm/v1/rest/contacts/{CONTACTID}/documents
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:
<ArrayOfDocument xmlns="http://schemas.datacontract.org/2004/07/REDTAIL.Model">
<Document>
<AccountID>2147483647</AccountID>
<Category>String content</Category>
<CategoryID>2147483647</CategoryID>
<ClientID>2147483647</ClientID>
<DatabaseID>2147483647</DatabaseID>
<Deleted>true</Deleted>
<DeletedByID>2147483647</DeletedByID>
<DeletedDate>1999-05-31T11:20:00</DeletedDate>
<Description>String content</Description>
<FileExtension>String content</FileExtension>
<FileName>String content</FileName>
<FilePath>String content</FilePath>
<FileSize>2147483647</FileSize>
<RecAdd>1999-05-31T11:20:00</RecAdd>
<RecAddUser>2147483647</RecAddUser>
<RecID>2147483647</RecID>
<Title>String content</Title>
</Document>
<Document>
<AccountID>2147483647</AccountID>
<Category>String content</Category>
<CategoryID>2147483647</CategoryID>
<ClientID>2147483647</ClientID>
<DatabaseID>2147483647</DatabaseID>
<Deleted>true</Deleted>
<DeletedByID>2147483647</DeletedByID>
<DeletedDate>1999-05-31T11:20:00</DeletedDate>
<Description>String content</Description>
<FileExtension>String content</FileExtension>
<FileName>String content</FileName>
<FilePath>String content</FilePath>
<FileSize>2147483647</FileSize>
<RecAdd>1999-05-31T11:20:00</RecAdd>
<RecAddUser>2147483647</RecAddUser>
<RecID>2147483647</RecID>
<Title>String content</Title>
</Document>
</ArrayOfDocument>
The following is an example response Json body:
[{
"AccountID":2147483647,
"Category":"String content",
"CategoryID":2147483647,
"ClientID":2147483647,
"DatabaseID":2147483647,
"Deleted":true,
"DeletedByID":2147483647,
"DeletedDate":"\/Date(928174800000-0700)\/",
"Description":"String content",
"FileExtension":"String content",
"FileName":"String content",
"FilePath":"String content",
"FileSize":2147483647,
"RecAdd":"\/Date(928174800000-0700)\/",
"RecAddUser":2147483647,
"RecID":2147483647,
"Title":"String content"
}]
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="ArrayOfDocument">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Document" nillable="true" type="tns:Document" />
</xs:sequence>
</xs:complexType>
<xs:element name="ArrayOfDocument" nillable="true" type="tns:ArrayOfDocument" />
<xs:complexType name="Document">
<xs:sequence>
<xs:element minOccurs="0" name="AccountID" 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="DatabaseID" type="xs:int" />
<xs:element minOccurs="0" name="Deleted" type="xs:boolean" />
<xs:element minOccurs="0" name="DeletedByID" type="xs:int" />
<xs:element minOccurs="0" name="DeletedDate" type="xs:dateTime" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FileExtension" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FileName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FilePath" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="FileSize" type="xs:int" />
<xs:element minOccurs="0" name="RecAdd" type="xs:dateTime" />
<xs:element minOccurs="0" name="RecAddUser" type="xs:int" />
<xs:element minOccurs="0" name="RecID" type="xs:int" />
<xs:element minOccurs="0" name="Title" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
<xs:element name="Document" nillable="true" type="tns:Document" />
</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>