REST (With XML) - CRM Integration (External Files)

POST (Service Name 'v2InsertExternalFile')


XSD Definition

(NOTE: Non-Mandatory elements may be missing, but existing elements must be  in the correct order as listed below)

Red = Mandatory 
Blue = Date Formats (Must be yyyy-MM-dd)

<xs:complexType name="v2DiaryExternalFile">
<xs:element minOccurs="1" name="DiaryAgentCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="DiaryDescription" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="DiaryFileExtension" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="DiaryGroupCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="DiaryImage" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="DiaryOnline" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="DiaryType" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="DiaryTypeCode" nillable="true" type="xs:string"/>
<xs:element name="v2DiaryExternalFile" nillable="true" type="tns:v2DiaryExternalFile"/>



 Field Name Definition

 Agent Association: Code can be obtained from GET (Following contract):



 DiaryDescription  Description of the file uploaded in plain english
 DiaryFileExtension  As the file image gets uploaded as a Base64 string we require a file extension to apply the program association to the file type (e.g. 'PDF') (NOTE: Do not put a period (.) in front of the extension).

 Group Association: Code can be obtained from GET (Following contract):




 Image stored as string (Base64 Encoded)

 You can use a site like to test encoding input.


 This is to confirm if the document can be displayed to the 'Owner', 'Tenancy' or 'Supplier' in through the 'Owner Portal' ('true' or 'false'). 

NOTE: If it is not supplied it is assumed to be 'false'


 Must be one of the following values...

  • owner
  • property
  • tenancy
  • supplier

 Depending on what the 'DiaryType' value is, this is the appropriate code for the type

owner = OwnerCode (e.g. RBOW000043)
property = PropertyCode (e.g. RBPR000343)
tenancy = TenancyCode (e.g. RBTG034903)
supplier = SupplierCode (e.g. RBCR945900)

These codes can be retrieved from their associated contracts (e.g. GetViewAllDetailedOwner etc...)


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request


Please sign in to leave a comment.