Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type V2AvailablePropertyAgentDetails ¶
type V2AvailablePropertyAgentDetails struct { // Internal 'Agent Code' referencing 'Agent' PropertyAgentCode string `json:"PropertyAgentCode,omitempty"` // 1st choice email address of 'Agent' PropertyAgentEmail1 string `json:"PropertyAgentEmail1,omitempty"` // 2nd choice email address of 'Agent' PropertyAgentEmail2 string `json:"PropertyAgentEmail2,omitempty"` // Fax No. for 'Agent' PropertyAgentFax string `json:"PropertyAgentFax,omitempty"` // Name of 'Agent' PropertyAgentFullName string `json:"PropertyAgentFullName,omitempty"` // Mobile No. for 'Agent' PropertyAgentPhoneMobile string `json:"PropertyAgentPhoneMobile,omitempty"` // Work No. for 'Agent' PropertyAgentPhoneWork string `json:"PropertyAgentPhoneWork,omitempty"` // Title for 'Agent' PropertyAgentTitle string `json:"PropertyAgentTitle,omitempty"` // External Codes provided by 3rd parties that require references to their own services PropertyExternalCodes string `json:"PropertyExternalCodes,omitempty"` }
V2AvailablePropertyAgentDetails v2 available property agent details
swagger:model v2AvailablePropertyAgentDetails
func (*V2AvailablePropertyAgentDetails) MarshalBinary ¶
func (m *V2AvailablePropertyAgentDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2AvailablePropertyAgentDetails) UnmarshalBinary ¶
func (m *V2AvailablePropertyAgentDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2AvailablePropertyCustomList ¶
type V2AvailablePropertyCustomList struct { // Name of a 'Custom List Entry' PropertyCustomName string `json:"PropertyCustomName,omitempty"` // Value of a 'Custom List Entry' PropertyCustomValue string `json:"PropertyCustomValue,omitempty"` }
V2AvailablePropertyCustomList Companies can elect to have extra field names and values that are setup specifically for their company. These can be diplayed in this 'Custom List' array with a related 'Name' and 'Value' entry. If none are setup this will return an empty array
swagger:model v2AvailablePropertyCustomList
func (*V2AvailablePropertyCustomList) MarshalBinary ¶
func (m *V2AvailablePropertyCustomList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2AvailablePropertyCustomList) UnmarshalBinary ¶
func (m *V2AvailablePropertyCustomList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2AvailablePropertyDetails ¶
type V2AvailablePropertyDetails struct { // 'Street No.' in in a 'Street Address' PropertyAddress1 string `json:"PropertyAddress1,omitempty"` // 'Street Name' in in a 'Street Address' PropertyAddress2 string `json:"PropertyAddress2,omitempty"` // 'Suburb' in in a 'Street Address' PropertyAddress3 string `json:"PropertyAddress3,omitempty"` // 'City' in in a 'Street Address' PropertyAddress4 string `json:"PropertyAddress4,omitempty"` // property agent PropertyAgent *V2AvailablePropertyAgentDetails `json:"PropertyAgent,omitempty"` // Code indicating how many times this record has been updated. The code is incremented by 1 on each update. This can also be used to track if the record has been updated since the last request. PropertyChangeCode float64 `json:"PropertyChangeCode,omitempty"` // The 'Internal Code' of the 'Property'. This code is only unique within the client database. It is recommended that you use 'PropertyCodeGlobal' if you are making the data public or consuming property information from multiple client databases. PropertyCode string `json:"PropertyCode,omitempty"` // The 'Global Code' of the 'Property'. This code is unique across ALL Palace databases. It is recommended that you use 'PropertyCodeGlobal' if you are making the data public or consuming property information from multiple client databases. PropertyCodeGlobal string `json:"PropertyCodeGlobal,omitempty"` // property custom list PropertyCustomList []*V2AvailablePropertyCustomList `json:"PropertyCustomList"` // Date the property is available from. This will be formatted as yyyy-MM-dd PropertyDateAvailable string `json:"PropertyDateAvailable,omitempty"` // property features PropertyFeatures *V2AvailablePropertyFeatures `json:"PropertyFeatures,omitempty"` // Generally is used as in 'Internal' reference for a 'Map Grid' for grouping purposes. PropertyGrid string `json:"PropertyGrid,omitempty"` // A description of the 'Management Type' of the property. Although these descriptions can be defined by the user, Palace has a 'Pattern Criteria' definiting 4 specific types of 'Managements'. Descriptions containing the word 'Manage' specifies a residential management. Descriptions containing the word 'Casual' specifies a casual property. Descriptions containing the word 'Commercial' specifies a commercial management. Descriptions containing the word 'Holiday' specifies a holiday management PropertyManagementType string `json:"PropertyManagementType,omitempty"` // This is user defined 'Free Form' text giving a name to a property (NOTE: This is not the same as the address of the property) PropertyName string `json:"PropertyName,omitempty"` // Internal code assigned to the 'Owner' of the property. PropertyOwnerCode string `json:"PropertyOwnerCode,omitempty"` // This is the amount of the rent. PropertyRentAmount float64 `json:"PropertyRentAmount,omitempty"` // This is related to the the 'PropertyRentAmount' field (e.g. 200 / Week). The 'Rental Period' indicates how often the rent should be paid on this property. Options are Day, Week, Fortnight, Month PropertyRentalPeriod string `json:"PropertyRentalPeriod,omitempty"` // This is a user defined code for sorting. Generally, this will be the same as the 'Street Addres' name PropertySortCode string `json:"PropertySortCode,omitempty"` // This value will be 'Active' or 'Inactive' and indicates if the 'Property' is an active management at this time (NOTE: An 'Inactive' management may suggest the 'Property' is having work done at this time and cannot currently be rented) PropertyStatus string `json:"PropertyStatus,omitempty"` // property suburb PropertySuburb []*V2AvailablePropertySuburbs `json:"PropertySuburb"` // The 'Unit' of the 'Property'. If displaying the full 'Property Address' and a 'Unit' exists, the system should display 'Unit / PropertyAddress1' (e.g. 1/15 Stuart Street). PropertyUnit string `json:"PropertyUnit,omitempty"` }
V2AvailablePropertyDetails v2 available property details
swagger:model v2AvailablePropertyDetails
func (*V2AvailablePropertyDetails) MarshalBinary ¶
func (m *V2AvailablePropertyDetails) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2AvailablePropertyDetails) UnmarshalBinary ¶
func (m *V2AvailablePropertyDetails) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2AvailablePropertyFeatures ¶
type V2AvailablePropertyFeatures struct { // Advertising body PropertyAdvertText string `json:"PropertyAdvertText,omitempty"` // Amenities close to property PropertyAmenities string `json:"PropertyAmenities,omitempty"` // No. of bathrooms. PropertyBathroomsNo string `json:"PropertyBathroomsNo,omitempty"` // No. of bedrooms. PropertyBedroomsNo string `json:"PropertyBedroomsNo,omitempty"` // No. of carports. PropertyCarsNo string `json:"PropertyCarsNo,omitempty"` // This will be one of the following options (Apartment, House, Home and Income, Lifestyle, Unit, Townhouse, Holiday Home, Section Res, Flats). PropertyClass string `json:"PropertyClass,omitempty"` // No. of ensuites. PropertyEnsuitesNo string `json:"PropertyEnsuitesNo,omitempty"` // Free form list of other features PropertyFeatureDetails string `json:"PropertyFeatureDetails,omitempty"` // Floor area in metres (squared PropertyFloorArea string `json:"PropertyFloorArea,omitempty"` // Free form list of furnishings within the property PropertyFurnishings string `json:"PropertyFurnishings,omitempty"` // latitude and longitude separted by : (From Google Maps API) PropertyGeographicLocation string `json:"PropertyGeographicLocation,omitempty"` // Header for the 'Advert Text'. PropertyHeader string `json:"PropertyHeader,omitempty"` // Land area in hectares PropertyLandAreaHectares string `json:"PropertyLandAreaHectares,omitempty"` // Land area in metres (squared) PropertyLandAreaMSquared string `json:"PropertyLandAreaMSquared,omitempty"` // Is the 'Property' a new construction (Yes / No) PropertyNewConstruction string `json:"PropertyNewConstruction,omitempty"` // This can be a number or free form text PropertyParking string `json:"PropertyParking,omitempty"` // Is the 'Property' allowed to have pets (Yes / No) PropertyPetsAllowed string `json:"PropertyPetsAllowed,omitempty"` // 'Post Code' of Property PropertyPostCode string `json:"PropertyPostCode,omitempty"` // Should the 'Property Address' be published online PropertyPublishAddress string `json:"PropertyPublishAddress,omitempty"` // Should the 'Property' entry be published online PropertyPublishEntry string `json:"PropertyPublishEntry,omitempty"` // Is the 'Property' allowed smoking on premise (Yes / No) PropertySmokersAllowed string `json:"PropertySmokersAllowed,omitempty"` // Number of Storeys of the property PropertyStories string `json:"PropertyStories,omitempty"` // URL of 'Virtual Tour' or 'Video' PropertyVirtualTourURL string `json:"PropertyVirtualTourURL,omitempty"` // Link to website or listing URL PropertyWebLinkURL string `json:"PropertyWebLinkURL,omitempty"` // Year the property was built. PropertyYearBuilt string `json:"PropertyYearBuilt,omitempty"` }
V2AvailablePropertyFeatures These are a specific set of 'Feature' entries avaiable for each property.
swagger:model v2AvailablePropertyFeatures
func (*V2AvailablePropertyFeatures) MarshalBinary ¶
func (m *V2AvailablePropertyFeatures) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2AvailablePropertyFeatures) UnmarshalBinary ¶
func (m *V2AvailablePropertyFeatures) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2AvailablePropertyImages ¶
type V2AvailablePropertyImages struct { // Base64 encoded image. PropertyImageBase64 string `json:"PropertyImageBase64,omitempty"` // Internal 'Image Code' (This is only unique to a specific image) PropertyImageCode string `json:"PropertyImageCode,omitempty"` // Global 'Image Code' (This is unique across ALL Palace databases) PropertyImageCodeGlobal string `json:"PropertyImageCodeGlobal,omitempty"` // Free form user defined description. PropertyImageDescription string `json:"PropertyImageDescription,omitempty"` }
V2AvailablePropertyImages v2 available property images
swagger:model v2AvailablePropertyImages
func (*V2AvailablePropertyImages) MarshalBinary ¶
func (m *V2AvailablePropertyImages) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2AvailablePropertyImages) UnmarshalBinary ¶
func (m *V2AvailablePropertyImages) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2AvailablePropertyImagesURL ¶
type V2AvailablePropertyImagesURL struct { // Internal 'Image Code' (This is only unique to a specific image) PropertyImageCode string `json:"PropertyImageCode,omitempty"` // Global 'Image Code' (This is unique across ALL Palace databases) PropertyImageCodeGlobal string `json:"PropertyImageCodeGlobal,omitempty"` // Free form user defined description. PropertyImageDescription string `json:"PropertyImageDescription,omitempty"` // URL to Full Image (Not resized) PropertyImageURL string `json:"PropertyImageURL,omitempty"` // URL to Image (Resized to medium thumbnail) PropertyImageURLThumbnailMedium string `json:"PropertyImageURLThumbnailMedium,omitempty"` // URL to Image (Resized to small thumbnail) PropertyImageURLThumbnailSmall string `json:"PropertyImageURLThumbnailSmall,omitempty"` }
V2AvailablePropertyImagesURL v2 available property images URL
swagger:model v2AvailablePropertyImagesURL
func (*V2AvailablePropertyImagesURL) MarshalBinary ¶
func (m *V2AvailablePropertyImagesURL) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2AvailablePropertyImagesURL) UnmarshalBinary ¶
func (m *V2AvailablePropertyImagesURL) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2AvailablePropertyPrevious ¶
type V2AvailablePropertyPrevious struct { // The 'Global Code' of the 'Property'. This code is unique across ALL Palace databases. It is recommended that you use 'PropertyCodeGlobal' if you are making the data public or consuming property information from multiple client databases. PropertyCodeGlobal string `json:"PropertyCodeGlobal,omitempty"` // When the 'Date Available' was removed from the 'Property' (Marking the property as no longer available). This will be formatted as yyyy-MM-dd PropertyDateAvailableRemoved string `json:"PropertyDateAvailableRemoved,omitempty"` // Descripton of the 'Reason' the 'Date Available' was removed. This is separated by a colon (See example above) PropertyDateAvailableRemovedReason string `json:"PropertyDateAvailableRemovedReason,omitempty"` }
V2AvailablePropertyPrevious v2 available property previous
swagger:model v2AvailablePropertyPrevious
func (*V2AvailablePropertyPrevious) MarshalBinary ¶
func (m *V2AvailablePropertyPrevious) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2AvailablePropertyPrevious) UnmarshalBinary ¶
func (m *V2AvailablePropertyPrevious) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2AvailablePropertySuburbs ¶
type V2AvailablePropertySuburbs struct { // External Code Reference (NOTE: Based to 'Suburb Type') PropertySuburbCode string `json:"PropertySuburbCode,omitempty"` // Suburb District (NOTE: In 'Australia' this displays a 'Post Code') PropertySuburbDistrictOrPostcode string `json:"PropertySuburbDistrictOrPostcode,omitempty"` // Suburb Name. PropertySuburbName string `json:"PropertySuburbName,omitempty"` // Region (NOTE: In 'Australia' this displays a 'State') PropertySuburbRegionOrState string `json:"PropertySuburbRegionOrState,omitempty"` // The 'Suburb Type' is describes where the source of the suburb code originates PropertySuburbType string `json:"PropertySuburbType,omitempty"` }
V2AvailablePropertySuburbs v2 available property suburbs
swagger:model v2AvailablePropertySuburbs
func (*V2AvailablePropertySuburbs) MarshalBinary ¶
func (m *V2AvailablePropertySuburbs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2AvailablePropertySuburbs) UnmarshalBinary ¶
func (m *V2AvailablePropertySuburbs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation