CRM Integration - Property

How to use the Palace API Web Service (Properties)

Palace offers the ability to perform various functions through a secure API Web Service.  This article describes the REST endpoint and contracts for 'Properties' in Palace.

  • Property List (Sync)
  • Property Insert

GET (Detailed List of 'Properties')

NZ: https://serviceapi.realbaselive.com/Service.svc/RestService/ViewAllDetailedProperty
Aus: https://serviceapia.realbaselive.com/Service.svc/RestService/ViewAllDetailedProperty

(No Parameters)

 Field Name Definition
 PropertyAddress1  Street No. of Property
 PropertyAddress2  Street Name of Property
 PropertyAddress3  Suburb of Property
 PropertyAddress4  Region of Property
 PropertyAgentEmail1  The '1st Email Address' of the 'Primary Agent' for the 'Owner' of the 'Property'
 PropertyAgentEmail2  The '2nd Email Address' of the 'Primary Agent' for the 'Owner' of the 'Property'
 PropertyAgentFullName  The 'Full Name' for the 'Primary Agent' for the 'Owner' of the 'Property'
 PropertyArchived  Indicates if the 'Property' is archived
 PropertyChangeCode  'PropertyChangeCode' allows developers to only update changed records if this information is recorded against the 'PropertyCode'.  If this information has not changed for a previous sync then no update is required within the 3rd party system.
 PropertyCode   Internal unique code generated by Palace. Used to identify a Property within Palace to the corresponding database entry.
 PropertyCurrentBalance  Property 'Current Balance'
 PropertyDateAvailable  Date the property is to be made available for advertising
 PropertyDisbursementsLimited  Are the 'Property Disbursement' limited to a defined amount ('true' or 'false')
 PropertyDisbursementsMaxAmount  If the 'Property Disbursement' is limited, then what is the amount it's limited to.
 PropertyGrid  Grid / Grouping for Geographical Locations (i.e. Map Grids)
 PropertyKeyAccess  'Key Access' information for the property
 PropertyKeyNo  'Key No' for the Property
 PropertyMaintenanceFeePercent  Maintenance Fee %
 PropertyCommissionPercent  Management Fee %
 PropertyName  Property Name
 PropertyOpeningBalance  Property 'Opening Balance' for the current month
 PropertyOurCode  User Code for property
 PropertyOwnerCode

Code can be obtained from GET (Following contract):

NZ
https://serviceapi.realbaselive.com/Service.svc/RestService/ViewAllDetailedOwner

AUS
https://serviceapia.realbaselive.com/Service.svc/RestService/ViewAllDetailedOwner

 PropertyPhone  Property Phone Number
 PropertyPostCode  Property Post Code
 PropertyRentalAmount  Property Rental Amount for 'Advertising'
 PropertyRentalPeriod

 Property Rental Period (only options below):

  • Day
  • Week
  • Fortnight
  • Month
 PropertySortCode  Property Sort Code (Generally this is the 'Street Name')
 PropertyStartDate  Date the Property started being managed
 PropertyStatus  Property Status (Active / Inactive)
 PropertyUnit  Unit of the Property

 


POST (Service Name 'v2InsertProperty')

NZ: https://serviceapi.realbaselive.com/Service.svc/RestService/v2InsertProperty
Aus: https://serviceapia.realbaselive.com/Service.svc/RestService/v2InsertProperty

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="v2InsertProperty">
<xs:sequence>
<xs:element minOccurs="1" name="OwnerCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="PropertyAddress1" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="PropertyAddress2" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyAddress3" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyAddress4" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyAdvert" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyBrochureDetails" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyBrochureTitle" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyBuildingGroupCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyBuildingTypeCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyDateAvailable" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyDisbursementsLimited" nillable="true" type="xs:boolean"/>
<xs:element minOccurs="0" name="PropertyDisbursementsMaxAmount" nillable="true" type="xs:double"/>
<xs:element minOccurs="0" name="PropertyExternalSuburbCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyGrid" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyInspectionFeeAmount" nillable="true" type="xs:double"/>
<xs:element minOccurs="0" name="PropertyKeepBackAmount" nillable="true" type="xs:double"/>
<xs:element minOccurs="0name="PropertyKeepBackAmountAccumulatednillable="truetype="xs:double"/>
<xs:element minOccurs="0" name="PropertyKeepBackupReason" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyLocalAuthorityAccountNumber" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyMaintenanceFee" nillable="true" type="xs:double"/>
<xs:element minOccurs="0" name="PropertyManagementFee" nillable="true" type="xs:double"/>
<xs:element minOccurs="0" name="PropertyManagementGroupCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="PropertyManagementTypeCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyMarketValuation" nillable="true" type="xs:double"/>
<xs:element minOccurs="0" name="PropertyMaxTenants" nillable="true" type="xs:int"/>
<xs:element minOccurs="0" name="PropertyName" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyNotes" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyOurCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyPhone" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyPostCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyRentalAmount" nillable="true" type="xs:double"/>
<xs:element minOccurs="0" name="PropertyRentalPeriod" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="PropertySortCode" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyStartDate" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyUnit" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="PropertyWonActiveReason" nillable="true" type="xs:string"/>
<xs:element minOccurs="0" name="PropertyWonActiveReasonComments" nillable="true" type="xs:string"/>
<xs:element minOccurs="1" name="PropertyWonActiveReasonDate" nillable="true" type="xs:string"/><xs:element minOccurs="1" name="SystemBankCode" nillable="true" type="xs:string"/>
</xs:sequence>
</xs:complexType>

 
Example
 

 Definitions

 Field Name Definition
 OwnerCode  Code can be obtained from GET (Following contract):

 NZ
 https://serviceapi.realbaselive.com/Service.svc/RestService/ViewAllDetailedOwner

 AUS
 https://serviceapia.realbaselive.com/Service.svc/RestService/ViewAllDetailedOwner

 PropertyAddress1  Street No. of Property
 PropertyAddress2  Street Name of Property
 PropertyAddress3  Suburb of Property
 PropertyAddress4  Region of Property
 PropertyAdvert  Advert Text to put into Property (Web Advertising)
 PropertyBrochureDetails  Brochure Text to put into Property
 PropertyBrochureTitle  Brochure Title to put into Property
 PropertyBuildingGroupCode  Code can be obtained from GET (Following contract):

 NZ
 https://serviceapi.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedPropertyBuildingGroup

 AUS
 https://serviceapia.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedPropertyBuildingGroup

 PropertyBuildingTypeCode  Code can be obtained from GET (Following contract):

 NZ
 https://serviceapi.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedPropertyBuildingType

 AUS
 https://serviceapia.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedPropertyBuildingType

 PropertyDateAvailable  Date the property is to be made available for advertising
 PropertyDisbursementsLimited  Are the 'Property Disbursement' limited to a defined amount ('true' or 'false')
 PropertyDisbursementsMaxAmount  If the 'Property Disbursement' is limited, then what is the amount it's limited to.
 PropertyExternalSuburbCode  Code can be obtained from GET (Following contract):

 NZ
 https://serviceapi.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedPropertyExternalSuburbs

 AUS
 https://serviceapia.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedPropertyExternalSuburbs

 PropertyGrid  Grid / Grouping for Geographical Locations (i.e. Map Grids)
 PropertyInspectionFeeAmount  Amount to 'Charge' for inspections
 PropertyKeepBackAmount  Amount to 'Keep Back' (This month)
 PropertyKeepBackAmountAccumulated  Amount to 'Keep Back' (Accumulating into 'This Month')
 PropertyKeepBackupReason  What is the 'Keep Back' reason (if you are withholding funds)
 PropertyLocalAuthorityAccountNumber  Local Authority / Rates Number
 PropertyMaintenanceFee  Maintenance Fee %
 PropertyManagementFee  Management Fee %
 PropertyManagementGroupCode  Code can be obtained from GET (Following contract):

 NZ
 https://serviceapi.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedPropertyManagementGroup

 AUS
 https://serviceapia.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedPropertyManagementGroup

 PropertyManagementTypeCode  Code can be obtained from GET (Following contract):

 NZ
 https://serviceapi.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedPropertyManagementType

 AUS
 https://serviceapia.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedPropertyManagementType

 PropertyMarketValuation  Property Market Valuation amount
 PropertyMaxTenants  Maximum number of tenants allowed in property
 PropertyName  Property Name
 PropertyNotes  Notes / Comments to put against property
 PropertyOurCode  User Code for property
 PropertyPhone  Property Phone Number
 PropertyPostCode  Property Post Code
 PropertyRentalAmount  Property Rental Amount for 'Advertising'
 PropertyRentalPeriod

 Property Rental Period (only options below):

  • Day
  • Week
  • Fortnight
  • Month
 PropertySortCode  Property Sort Code (Generally this is the 'Street Name')
 PropertyStartDate  Date the Property started being managed
 PropertyUnit  Unit of the Property
 PropertyWonActiveReason

 How the Property was obtained for management

 Existing reasons can be obtained from GET (Following contract):

NZ
 https://serviceapi.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedPropertyActiveReasons

 AUS
 https://serviceapia.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedPropertyActiveReasons

 PropertyWonActiveReasonComments  How the property was obtained for management (comments)
 PropertyWonActiveReasonDate  Date the property was obtained for management
 SystemBankCode  Code can be obtained from GET (Following contract):

 NZ
 https://serviceapi.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedSystemBank

 AUS
 https://serviceapia.realbaselive.com/Service.svc/RestService/v2ViewAllDetailedSystemBank

 

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

Comments

Please sign in to leave a comment.