Name |
Value |
ExternalId |
Object
Name |
Value |
description |
The unique identifier for a property |
required |
true |
type |
string |
|
ParentId |
Object
Name |
Value |
description |
If the property belongs to a promotion, its unique identifier |
required |
false |
type |
integer |
|
AgencyReference |
Object
Name |
Value |
description |
Reference given by the agency to the property |
required |
true |
type |
string |
|
TypeId |
Object
Name |
Value |
description |
Identifies the type of the property within the following enumeration |
required |
true |
type |
integer |
dictionary |
View possible values |
|
SubTypeId |
Object
Name |
Value |
description |
Optional, Indicates the subtype of the property from the value selected in 'TypeId' field |
required |
false |
type |
integer |
dictionary |
View possible values |
|
IsNewConstruction |
Object
Name |
Value |
description |
Indicates if this is a new construction individual property |
required |
false |
type |
boolean |
|
PropertyStatusId |
Object
Name |
Value |
Description |
Indicates the property status for the agency |
required |
true |
type |
integer |
dictionary |
View possible values |
|
ExpirationCauseId |
Object
Name |
Value |
description |
If the property has expired, this field indicates the cause |
required |
false |
type |
integer |
dictionary |
View possible values |
|
ShowSurface |
Object
Name |
Value |
description |
Indicates if the surface has to be shown in the public view of the property |
required |
true |
type |
boolean |
|
ContactTypeId |
Object
Name |
Value |
description |
Defines the type of contact provided |
required |
true |
type |
integer |
dictionary |
View possible values |
|
ContactName |
Object
Name |
Value |
description |
Complete name (and surname) of the property's contact person |
required |
false |
type |
string |
|
IsPromotion |
Object
Name |
Value |
description |
Indicates if this is a set of new construction properties |
required |
true |
type |
boolean |
|
PromotionTypeId |
Object
Name |
Value |
description |
If the property is a promotion, this field defines its type |
required |
false |
type |
integer |
|
BankAwardedId |
Object
Name |
Value |
description |
If the property is bank awarded, it indicates the entity id |
required |
false |
type |
integer |
dictionary |
View possible values |
|
PropertyAddress |
Object
Name |
Value |
id |
PropertyAddress |
title |
PropertyAddress |
description |
Defines where is exactly located the property |
required |
true |
type |
array |
items |
Object
Name |
Value |
id |
PropertyAddress |
type |
object |
ZipCode |
Object
Name |
Value |
description |
ZIP Code (not required if x and y are specified) |
required |
false |
type |
string |
|
CountryId |
|
Zone |
Object
Name |
Value |
description |
Free text. Zone where is located the property |
required |
false |
type |
string |
|
StreetTypeId |
Object
Name |
Value |
description |
The type of the street where is located the property according to the following enum |
required |
true |
type |
integer |
dictionary |
View possible values |
|
Street |
Object
Name |
Value |
description |
Free text. The name of the street |
required |
false |
type |
string |
|
Number |
Object
Name |
Value |
description |
Number of the street |
required |
false |
type |
string |
|
FloorId |
Object
Name |
Value |
description |
Enum for the floor |
required |
false |
type |
integer |
dictionary |
View possible values |
|
Door |
Object
Name |
Value |
description |
Free text. Indicates the door number (or letter) in the floor where is located the property |
required |
false |
type |
string |
|
Stair |
Object
Name |
Value |
description |
Free text. Indicates the Stair (if any) where is located the property |
required |
false |
type |
string |
|
x |
Object
Name |
Value |
description |
Longitude coordinate used to geographycally position the property |
required |
true |
type |
number |
|
y |
Object
Name |
Value |
description |
Lattitude coordinate used to geographycally position the property |
required |
true |
type |
number |
|
VisibilityModeId |
Object
Name |
Value |
description |
Defines how to show the property address |
required |
true |
type |
integer |
dictionary |
View possible values |
|
|
|
PropertyDocument |
Object
Name |
Value |
id |
PropertyDocument |
title |
PropertyDocument |
description |
Entity used to define the property's document(s) like pictures, videos and others |
required |
false |
type |
array |
items |
Object
Name |
Value |
id |
PropertyDocument |
type |
object |
TypeId |
Object
Name |
Value |
description |
Describes the type of file according to the following enumeration |
required |
true |
type |
integer |
dictionary |
View possible values |
|
Description |
Object
Name |
Value |
description |
Free text. Provide a description for the document. |
required |
false |
type |
string |
|
Url |
Object
Name |
Value |
description |
It must contain the file name (i.e. 'picture.jpg') |
required |
true |
type |
string |
|
RoomTypeId |
Object
Name |
Value |
description |
If the document refers to a room, you can indicate it within this field, according to the following enumeration |
required |
false |
type |
integer |
dictionary |
View possible values |
|
FileTypeId |
Object
Name |
Value |
description |
Indicates the file type according to the following enum |
required |
true |
type |
integer |
dictionary |
View possible values |
|
Visible |
Object
Name |
Value |
description |
Indicates whether the document has to be shown in publications or communications |
required |
true |
type |
boolean |
|
SortingId |
Object
Name |
Value |
description |
Use it to alter the order of appearence of the document in lists |
required |
true |
type |
integer |
|
|
|
PropertyFeature |
Object
Name |
Value |
id |
PropertyFeature |
title |
PropertyFeature |
description |
Entity used to define the property's features (extras) |
required |
true |
type |
array |
items |
Object
Name |
Value |
id |
PropertyFeature |
type |
object |
properties |
Object
Name |
Value |
FeatureId |
Object
Name |
Value |
description |
Describes the type of feature according to the following enumeration |
required |
true |
type |
integer |
dictionary |
View possible values
|
|
LanguageId |
Object
Name |
Value |
description |
The language of the comments, according to the following enumeration |
required |
true |
type |
integer |
dictionary |
View possible values
|
|
DecimalValue |
Object
Name |
Value |
description |
If the feature type is 'DecimalValue', 'List' or 'Multiple', its value must be placed in this field |
required |
false |
type |
number |
|
BoolValue |
Object
Name |
Value |
description |
If the feature type is 'BooleanValue', its value must be placed in this field |
required |
false |
type |
boolean |
|
DateValue |
Object
Name |
Value |
description |
If the feature type is 'DateValue', its value must be placed in this field |
required |
false |
type |
string |
|
TextValue |
Object
Name |
Value |
description |
If the feature type is 'TextValue', its value must be placed in this field |
required |
false |
type |
string |
|
|
|
|
PropertyContactInfo |
Object
Name |
Value |
id |
PropertyContactInfo |
title |
PropertyContactInfo |
description |
Contains the contact information provided by the agency (i.e. e-mail, phone..). |
required |
true |
type |
array |
items |
Object
Name |
Value |
id |
PropertyContactInfo |
type |
object |
properties |
Object
Name |
Value |
TypeId |
Object
Name |
Value |
description |
Describes the type of contact according to the following enumeration |
required |
true |
type |
integer |
dictionary |
View possible values
|
|
Value |
Object
Name |
Value |
description |
Free text with the value of the contact source |
required |
true |
type |
string |
|
ValueTypeId |
Object
Name |
Value |
description |
Indicates if the contact refers to the agency, the agend or other specified |
required |
true |
type |
integer |
dictionary |
View possible values
|
|
|
|
|
PropertyAnnotation |
Object
Name |
Value |
id |
PropertyAnnotation |
title |
PropertyAnnotation |
description |
Use this object for providing additional comments to the property |
required |
false |
type |
array |
items |
Object
Name |
Value |
id |
PropertyAnnotation |
type |
object |
properties |
Object
Name |
Value |
Annotation |
Object
Name |
Value |
description |
Free text |
required |
true |
type |
string |
|
|
|
|
PropertyUser |
Object
Name |
Value |
id |
PropertyUser |
title |
PropertyUser |
description |
The user agent(s) managing the property |
required |
false |
type |
array |
items |
Object
Name |
Value |
id |
PropertyUser |
type |
object |
properties |
Object
Name |
Value |
UserId |
Object
Name |
Value |
description |
Unique identifier of the user agent |
required |
true |
type |
integer |
|
IsPrincipal |
Object
Name |
Value |
description |
The property may have more than one user agents managing it, but only one can be the principal |
required |
true |
type |
boolean |
|
|
|
|
PropertyFeatureGroupComment |
Object
Name |
Value |
id |
PropertyFeatureGroupComment |
title |
PropertyFeatureGroupComment |
description |
If a feature is able to have comments or annotations, these are provided in this object |
required |
false |
type |
array |
items |
Object
Name |
Value |
id |
PropertyFeatureGroupComment |
type |
object |
properties |
Object
Name |
Value |
FeatureGroupId |
Object
Name |
Value |
required |
true |
type |
integer |
|
LanguageId |
Object
Name |
Value |
description |
The language of the comments, according to the following enumeration |
required |
true |
type |
integer |
dictionary |
View possible values
|
|
Comments |
Object
Name |
Value |
description |
Free Text |
required |
true |
type |
string |
|
|
|
|
PropertyRegistryInfo |
Object
Name |
Value |
id |
PropertyRegistryInfo |
title |
PropertyRegistryInfo |
required |
false |
type |
object |
properties |
Object
Name |
Value |
Reference |
Object
Name |
Value |
description |
Catastral reference |
required |
false |
type |
string |
|
Volume |
Object
Name |
Value |
description |
Physical volume where the property is registrated |
required |
false |
type |
string |
|
Book |
Object
Name |
Value |
description |
Physical book where the property is registrated |
required |
false |
type |
string |
|
Page |
Object
Name |
Value |
description |
Physical page of the book where the property is registrated |
required |
false |
type |
string |
|
RegistryOf |
Object
Name |
Value |
description |
Place where the registration is done |
required |
false |
type |
string |
|
RegistryNumber |
Object
Name |
Value |
description |
Registry Number |
required |
false |
type |
string |
|
Description |
Object
Name |
Value |
description |
Free text. Additional comments |
required |
false |
type |
string |
|
RegistryProperty |
Object
Name |
Value |
description |
Registry Property |
required |
false |
type |
string |
|
|
|
PromotionTypology |
Object
Name |
Value |
id |
PromotionTypology |
title |
PromotionTypology |
description |
If the property has a parent id, this objects indicates the promotion typology |
required |
false |
type |
array |
items |
Object
Name |
Value |
id |
PromotionTypology |
type |
object |
properties |
Object
Name |
Value |
Value |
Object
Name |
Value |
description |
Free text. Describes the typology of the property |
required |
true |
type |
string |
|
|
|
|
PropertyCustomer |
Object
Name |
Value |
id |
PropertyCustomer |
title |
PropertyCustomer |
required |
false |
type |
array |
items |
Object
Name |
Value |
id |
PropertyCustomer |
type |
object |
properties |
Object
Name |
Value |
CustomerId |
Object
Name |
Value |
description |
The Unique identifier of the customer |
required |
true |
type |
integer |
|
IsPrincipal |
Object
Name |
Value |
description |
A property may have one or more than one owner customers, but only one can be the principal |
required |
true |
type |
boolean |
|
|
|
|
PropertyPublications |
Object
Name |
Value |
id |
PropertyPublications |
title |
PropertyPublications |
description |
List of publications which the property will be sent to |
required |
false |
type |
array |
items |
Object
Name |
Value |
id |
PropertyPublication |
type |
object |
properties |
Object
Name |
Value |
PublicationId |
Object
Name |
Value |
description |
The unique identifier where the property is published, according to the following enumeration |
required |
true |
type |
integer |
dictionary |
View possible values
|
|
PublicationTypeId |
Object
Name |
Value |
description |
There are different type of publications ie; Ov, Own Web, etc |
required |
true |
type |
integer |
dictionary |
View possible values
|
|
|
|
|
PropertyTransaction |
Object
Name |
Value |
id |
PropertyTransaction |
title |
PropertyTransaction |
description |
Describes the transaction features of the property (i.e. Price, currency, payment periodicity...) |
required |
true |
type |
array |
items |
Object
Name |
Value |
id |
PropertyTransaction |
type |
object |
properties |
Object
Name |
Value |
TransactionTypeId |
Object
Name |
Value |
description |
Indicates the type of the transaction according to the following enumeration |
required |
true |
type |
integer |
dictionary |
View possible values
|
|
CustomerPrice |
Object
Name |
Value |
description |
The property price asked by the customer for this transacton type |
required |
false |
type |
number |
|
Price |
Object
Name |
Value |
description |
The property price for this transacton type |
required |
true |
type |
number |
|
PriceM2 |
Object
Name |
Value |
description |
The property price for this transacton type for each square meter |
required |
true |
type |
number |
|
CurrencyId |
Object
Name |
Value |
description |
Defines the currency applied to the transaction price according to the following enumeration |
required |
true |
type |
integer |
dictionary |
View possible values
|
|
PaymentPeriodicityId |
Object
Name |
Value |
description |
defines the periodicity that the transaction payment is made where appropiate according to the following enumeration |
required |
false |
type |
integer |
dictionary |
View possible values
|
|
ShowPrice |
Object
Name |
Value |
description |
Hide/show price in communications and publications |
required |
true |
type |
boolean |
|
Conditions |
Object
Name |
Value |
description |
Free text. If the property is option offer, describes the transaction conditions |
required |
false |
type |
string |
|
|
|
|