Custom Data Types
The following custom complex data types are used in the main definition above (Property Details):
- Lister Type
This field is mandatory to be able to set property as ShareNetwork.
However if the Lister user doesn’t exist in Resales-Online, or this field is not included in the XML, we will set Lister from Default Lister User value (chosen by the customer when setting up their feed)
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| firstName | Text | Yes | YES (Default value) | Lister first name |
| lastName | Text | Yes | YES (Default value) | Lister last Name |
- Address Type
It is possible to include all the address in node address1. We’ll split it if it is bigger than 64 characters.
If both nodes are included (address1 and address2), be sure they are not bigger than 64 characters.
*Note: There is an available setting to take address value from cadastral reference. By default if the address is empty, it will try to get it from cadastral reference (if exists)
To validate and get location, first we check town node, if not a valid location, then we check district node.
Valid locations within the correspondent province.
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| address1 | Text(64) | Yes | YES | First address line, Can include all the address, if >64 chars we'll split it and obtain address2 |
| address2 | Text(64) | Yes | YES/NO | Second address line |
| country | Text | Yes | YES | The country of the property (e.g. ‘Spain’) |
| town | Text | Yes | YES | The town/city location of the property (e.g. ‘Elviria’) |
| province | Text | Yes | YES | The province/county of the property (e.g. Málaga) |
| district | Text | No | The district of the town/city location (e.g. ‘Elviria’ is in the district of ‘Marbella’) | |
| postCode | Text | No | The post code of the property (e.g. ‘29670’) | |
| region | Text | No | The region in which the province lies (e.g. ‘Andalucía’) | |
| gpsLongitude | Decimal | No | The GPS longitude of the property | |
| gpsLatitude | Decimal | No | The GPS latitude of the property | |
| directions | Text | No | Private details of directions to the property |
- SaleDetails Type
saleReferenceId node: Will contains the agency reference. Reference that will be used to search in Resales-Online.
If this reference doesn’t come, we’ll take referenceId as Agency Ref.
This ref also is needed to connect Feed properties with Resales-online properties at the first import execution.
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| saleReferenceId | Text | No | The sale reference identifier of the property | |
| saleType | Text | Yes | Valid values : ‘Freehold’ or ‘Leasehold’ | |
| shared | Numeric(1) | Yes | YES | Valid values : 1=share with other agencies, 0=do not share |
| sharedOnWeb | Numeric(1) | No | Valid values : 1=shared on other agents’ websites and portals, 0=not shared | |
| price | Numeric | Yes | YES | The sale price of the property (including commission) in the given currency |
| commissionPct | Decimal | YES | YES (Default value) | The commission percentage for the property – either the commissionPct or the commissionAmountfield must be present. If both fields are present, the commissionAmount field will take priority. |
| commissionOwnPct | Decimal | Yes | YES (Default value) | The percentage of the total commission that you receive as the listing agent for the property if the property is sold by another agent (e.g. ’ 50’ = 50%) |
| commissionNotes | Text | No | Public notes about the commission available on this property | |
| originalPrice | Numeric | No | The original listed price of the property in the given currency | |
| valuationPrice | Numeric | No | The valuation price of the property in the given currency | |
| valuationYear | Numeric(4) | No | The year of the property valuation |
- RentalDetails Type
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| rentalReferenceId | Text | No | The rental reference identifier of the property | |
| shared | Numeric(1) | Yes | Valid values : 1=share with other agencies, 0=do not share | |
| sharedOnWeb | Numeric(1) | No | Valid values : 1=shared on other agents’ websites and portals, 0=not shared | |
| rentalRates | RentalRate Type | Yes | YES (If it is rental) | Short and long term rental rates for this property (minOccurs=1, maxOccurs=2) |
| rentalBookings | RentalBooking Type | No | Rental bookings for this property (minOccurs=0, maxOccurs=99) |
- RentalRate Type
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| rentalPeriod | Text | Yes | YES | Valid values : ‘week’ or ‘month’ |
| rentalMinAmount | Numeric | Yes | YES | The minimum rental amount for this rental period in the given currency |
| rentalMaxAmount | Numeric | Yes | YES | The maximum rental amount for this rental period in the given currency |
- PropertySize Type
Nodes garden and plot will be a sum of both and mapped to RsGardenPlotSqm
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| built | Numeric | Yes/No | YES | The built size of the property in the given sizeType -mandatory if property type is not ‘Plot’ |
| usefulSurface | Numeric | No | No | Built size excluding the walls and pillars and other non-expendable elements. (85% aprox) |
| terrace | Numeric | No | YES | The terrace size of the property in the given sizeType |
| garden | Numeric | No | YES | The garden size of the property in the given sizeType |
| plot | Numeric | Yes/No | YES | The plot size of the property in the given sizeType - mandatory if property type is ‘Villa’ or ‘Plot’ |
- Costs Type
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| communityFees | Numeric | No | The community fees for the property in the given currency | |
| refuseCollection | Numeric | No | The refuse collection fees for the property in the given currency | |
| localTaxes | Numeric | No | The local taxes for the property in the given currency | |
| ibiReceipt | Numeric(1) | No | Values are ‘0’ for no receipt and ‘1’ for IBI receipt | |
| notaSimple | Numeric(1) | No | Values are ‘0’ for no Nota Simple and ‘1’ for holding the Nota Simple |
- Feature Type
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| featureType | FeatureDetail Type | Yes | Details of the features of this property (minOccurs=1,maxOccurs=14) |
- FeatureDetail Type
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| name | Text | Yes | Name of Feature Type (See Appendix 2 – Property Features) |
|
| value | Text | Yes | Value of Feature Type (See Appendix 2 – Property Features) (minOccurs = 1,maxOccurs=99) |
- Descriptions Type
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| en | Text | Yes | YES | Property description in English |
| es | Text | No | YES | Property description in Spanish |
| de | Text | No | Property description in German | |
| fr | Text | No | Property description in French | |
| nl | Text | No | Property description in Dutch | |
| da | Text | No | Property description in Danish | |
| ru | Text | No | Property description in Russian | |
| se | Text | No | Property description in Swedish | |
| po | Text | No | Property description in Polish | |
| no | Text | No | Property description in Norwegian |
- Images Type
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| image | ImageDetail Type | Yes | YES | Images of this property (minOccurs=1,maxOccurs=99) |
- ImageDetails Type
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| url | Text | Yes | URL link to the property image | |
| title | Text | No | Title of the image |
- Client Type
If you wish to import a client, clientReferenceId is mandaroty. If it is empty, won’t be processed.
clientReferenceId + fisrtName + lastName (minimum required details to import it)
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| clientReferenceId | Text | Yes | The unique identifier for the client. If empty won't be processed. | |
| firstName | Text | Yes | Client’s first name | |
| lastName | Text | Yes | Client’s surname | |
| phoneNumber | Text | No | The landline phone number of the client | |
| mobileNumber | Text | No | The mobile phone number of the client | |
| faxNumber | Text | No | The fax number of the client | |
| primaryEmail | Text | No | The client’s primary email address | |
| secondaryEmail | Text | No | The client’s secondary email address | |
| clientNotes | Text | No | Private notes about the client |
- KeyDetails Type (In progress)
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| keyStatus | Text | Yes | Valid values : ‘With Vendor’, ‘With Keyholder’, ‘In Office’ or ‘None’ | |
| keyReferenceId | Text | No | The reference identifier for the keys of the property | |
| keyHolder | Client Type | No | Details of the Keyholder for the property (maxOccurs=1) | |
| keyNotes | Text | No | Private notes about the keys |
- RentalBooking Type (In progress)
| Field Name | DataType | XML Required (Needed for valid XML) | ShareNetwork Required (Needed to Share in Network) | Comments |
|---|---|---|---|---|
| rentalStartDate | Date(19) | Yes | The start date and time of the rental booking (in ‘YYYY-MM-DD hh:mm:ss’ format) | |
| rentalEndDate | Date(19) | Yes | The end date and time of the rental booking (in ‘YYYY-MM-DD hh:mm:ss’ format) | |
| rentalTenant | Client Type | No | Details of the tenant for this rental booking |