REST (With XML) - CRM Integration (External Files) – Welcome, Palace Support Centre

POST (Service Name 'v2InsertExternalFile')

NZ: https://serviceapi.realbaselive.com/Service.svc/RestService/v2InsertExternalFile
Aus: https://serviceapia.realbaselive.com/Service.svc/RestService/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:sequence>

<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:sequence>

</xs:complexType>

<xs:element name="v2DiaryExternalFile" nillable="true" type="tns:v2DiaryExternalFile"/>

Example

Definitions

Field Name	Definition
DiaryAgentCode	Agent Association: Code can be obtained from GET (Following contract): NZ https://serviceapi.realbaselive.com/Service.svc/RestService/ViewAllDetailedAgent AUS https://serviceapia.realbaselive.com/Service.svc/RestService/ViewAllDetailedAgent
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).
DiaryGroupCode	Group Association: Code can be obtained from GET (Following contract): NZ https://serviceapi.realbaselive.com/Service.svc/RestService/DiaryGroups AUS https://serviceapia.realbaselive.com/Service.svc/RestService/DiaryGroups
DiaryImage	Image stored as string (Base64 Encoded) You can use a site like http://www.dailycoding.com/utils/converter/imagetobase64.aspx to test encoding input.
DiaryOnline	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'
DiaryType	Must be one of the following values... owner property tenancy supplier
DiaryTypeCode	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...)

Comments