errorResponse
objectError response with 4xx or 5xx status code
The URI reference that identifies the problem type
>= 1 characters
An human-readable summary of the problem type
>= 1 characters
A human-readable explanation specific to
this occurrence of the problem
>= 1 characters
A URI reference that identifies the specific occurrence of the problem
>= 1 characters
Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01
The HTTP status code generated for this occurrence of the problem
>= 1 characters
Example:400
paginatedResultSet
objectShow Child Parameters
Show Child Parameters
One OfShow Child Parameters
contactRequest
objectThe data of the User who created the contact.
In rare cases, the User may have requested to delete their account / data on our Portals for GDPR Reasons.
In those cases:
- the contact data fields (firstName, lastName, message, name, gender, language) will be set with null fields
- the phoneNumbers will be replaced with an empty array: []
Maximum length is 100 characters
<= 100 characters
Example:Jane
Maximum length is 100 characters
<= 100 characters
Example:Doe
Allowed values:MALEFEMALEOTHERPREFER_NOT_TO_DISCLOSE
Example:FEMALE
Example:test@example.com
Allowed values:DEENESFRHEITNLPTRU
Example:DE
Show Child Parameters
If True : The seeker has indicated that he or she owns a property
If False : The seeker has indicated that he or she does not own a property
if undefined : The seeker has not indicated if he or she owns a property, or the customer contract does not allow the display of the information
leadMetadataCommon
objectUnix timestamp in seconds, indicates when the lead was processed
The portal(brand) where the lead was created.
- BDS-FRA: Belles Demeures France
- IMN-DEU: Immonet Germany
- IWB-BEL: Immoweb Belgium
- IWT-DEU: Immowelt Germany
- YSQ-DEU: Yoursquares Germany
- IWT-AUT: Immowelt Austria
- LCI-FRA: La Cote Immo France
- LIM-FRA: Logic-Immo France
- LIC-FRA: Logic-Immo Construire France
- LIN-FRA: Logic-Immo Neuf France
- LUX-FRA: Luxe Residence France
- MAG-FRA: Meilleurs Agents France
- SLG-FRA: Se Loger France
- BCM-FRA: Se Loger Bureaux et Commerces France
- SLC-FRA: Se Loger Construire France
- SLN-FRA: Se Loger Neuf France
- SIG-DEU: Signify Germany
- SIG-FRA: Signify France
Allowed values:BDS-FRAIMN-DEUIWB-BELIWT-DEUIWT-AUTLCI-FRALIM-FRALIC-FRALIN-FRALUX-FRAMAG-FRASLG-FRABCM-FRASLC-FRASLN-FRAYSQ-DEUSIG-DEUSIG-FRA
Time To Live. Unix timestamp in seconds, after which the lead should be deleted from all systems. Legally 3 years after creation.
classifiedLeadMetadata
Unix timestamp in seconds, indicates when the lead was processed
The portal(brand) where the lead was created.
- BDS-FRA: Belles Demeures France
- IMN-DEU: Immonet Germany
- IWB-BEL: Immoweb Belgium
- IWT-DEU: Immowelt Germany
- YSQ-DEU: Yoursquares Germany
- IWT-AUT: Immowelt Austria
- LCI-FRA: La Cote Immo France
- LIM-FRA: Logic-Immo France
- LIC-FRA: Logic-Immo Construire France
- LIN-FRA: Logic-Immo Neuf France
- LUX-FRA: Luxe Residence France
- MAG-FRA: Meilleurs Agents France
- SLG-FRA: Se Loger France
- BCM-FRA: Se Loger Bureaux et Commerces France
- SLC-FRA: Se Loger Construire France
- SLN-FRA: Se Loger Neuf France
- SIG-DEU: Signify Germany
- SIG-FRA: Signify France
Allowed values:BDS-FRAIMN-DEUIWB-BELIWT-DEUIWT-AUTLCI-FRALIM-FRALIC-FRALIN-FRALUX-FRAMAG-FRASLG-FRABCM-FRASLC-FRASLN-FRAYSQ-DEUSIG-DEUSIG-FRA
Time To Live. Unix timestamp in seconds, after which the lead should be deleted from all systems. Legally 3 years after creation.
Allowed values:CLASSIFIED