MCP
- Haal MCP status op
- Publiceer een project
- Valideer project met regels van MCP kanaal
- Valideer (extra) parameters die klant invuld t.b.v. publish/revoke request
- Ondersteunde kanalen
- PropertyNL collegiale makelaars
Bij alle methodes van deze API module dient authenticatie informatie mee gestuurd te worden met het request.
Haal MCP status op
GET /1.0/mcp/:apiObjectId
Response
Status: 200 OK
{
"channels": [
{
"channel":{
"name": "NVM Tiara Wonen"
}
},
{
"channel":{
"name": "RealNext":,
"publication":{
"uuid": "9ff5ff7a-e8b5-407c-ac0c-2e8aac281fcb",
"doc": "2015-11-18 10:34:41",
"dlm": "2015-11-18 10:40:26",
"status": "busy",
"mutations":[
{
"type": "publish",
"doc": "2015-11-18 10:34:41",
"status": "new"
},{
"type": "publish",
"doc": "2015-11-18 10:40:26",
"status": "new"
}
]
}
}
}
]
}
Publiceer een project
POST /1.0/mcp/:apiObjectId
Parameters
Naam | Type | Omschrijving |
---|---|---|
type |
string |
Mcp kanaal type (tiara_wonen, tiara_bog, etc) |
publish |
boolean |
Bij een aanmelding dient deze op true te staan. |
revoke |
boolean |
Bij een afmelding dient deze op true te staan. |
Voor bepaalde kanalen kunnen er extra parameters meegegeven worden, zie hiervoor de sectie ondersteunde kanalen.
Response
Status: 200 OK
Valideer project met regels van MCP kanaal
GET /1.0/mcp/:apiObjectId/validate
Parameters
Naam | Type | Omschrijving |
---|---|---|
type |
string |
Mcp kanaal type (tiara_wonen, tiara_bog, etc) |
publish |
boolean |
Publiceren (true), anders niet opgegeven |
revoke |
boolean |
Afmelden (true), anders niet opgegeven |
status |
string |
'active' (Checks voor al eerder gepubliceerd project worden uitgevoerd), 'inactive' (Checks voor nog niet eerder gepubliceerd project worden uitgevoerd), 'unknown' (Checks op basis van active state worden overgeslagen) of niet opgegeven (API bepaald zelf of object al eerder gepubliceerd is) |
Response met foutmeldingen
Status: 200 OK
{
"valid": false,
"errors": {
"Algemeen": [
"Woonobject: Energie label eind datum moet in de toekomst liggen."
],
"Leisure": [
"Overige leisure: Aantal verblijven is verplicht.",
"Overige leisure: Capaciteit in personen is verplicht."
],
"Gebouw": [
"Energie label eind datum moet in de toekomst liggen."
]
}
}
Response zonder foutmeldingen
Status: 200 OK
{
"valid": true
}
Valideer extra parameters die voor een kanaal opgegeven kunnen worden
GET /1.0/mcp/:apiObjectId/validateoptions
Parameters
Naam | Type | Omschrijving |
---|---|---|
type |
string |
Mcp kanaal type (tiara_bog, realnext, property_nl) |
publish |
boolean |
Publiceren (true), anders niet opgegeven |
revoke |
boolean |
Afmelden (true), anders niet opgegeven |
Voor de rest dienen de extra parameters zoals bij het publish request opgegeven worden (Zie ondersteunde kanalen). Deze validatie dient dus aangeroepen te worden nadat de gebruiker de waarde van deze parameters opgegeven heeft.
Response met foutmeldingen
Status: 200 OK
{
"valid": false,
"errors": {
"MCP kanaal": [
"Het project zelf mag niet voorkomen bij de nevenfunctie projecten"
],
"Deel transaktie": [
"Prijs is verplicht.",
"Huur prijs (per m2/jaar) voor een winkelruimte dient tussen de 30 en 3000 te liggen."
]
}
}
Response zonder foutmeldingen
Status: 200 OK
{
"valid": true
}
Ondersteunde kanalen
Op dit moment worden de volgende kanalen ondersteund om naar toe te publiceren via de API:
Naam | Type |
---|---|
Tiara Wonen | tiara_wonen |
Tiara Bedrijfs Onroerend Goed | tiara_bog |
PropertyNL | property_nl |
Pararius | pararius |
Huislijn | huislijn |
Zoek alle Huizen | zah |
Rooftrack | rooftrack |
De Bedrijfsmakelaar | bedrijfsmakelaar |
Jumba | jumba |
Bedrijfspand.com | bedrijfspand |
iLocate | ilocate |
Extra parameters voor Tiara Wonen en Bedrijfs Onroerend Goed
Gebruik de valideer extra parameters call om de waardes te valideren!
Naam | Type | Verplicht? | Omschrijving |
---|---|---|---|
internet | boolean | nee | Publiceren naar Funda |
confidential | boolean | nee | Publiceren als vertrouwelijk |
publishtime | integer | nee | Unix timestamp vanaf wanneer object op Funda getoond moet worden. |
revoketime | integer | nee | Unix timestamp vanaf wanneer object niet meer op Funda getoond moet worden. |
co_applicants | array | nee | Array met integer NVM nummers van de medeaanmelders. |
purchasing_agent | integer | nee | Integer NVM nummer van de aankoopmakelaar (bij een afmelding). |
co_applicant_signing_out | integer | nee |
Integer NVM nummer van de medeaanmelder namens wie de afmelding verstuurd wordt (bij een afmelding). De medenaanmelder dient bij de voorgaande mutatie aanwezig zijn geweest. |
Extra parameters voor Tiara Bedrijfs Onroerend Goed
Bijna alle parameters hebben betrekking op deelafmeldingen (alleen secondary_project_api_ids, buyer_renter_name, buyer_renter_reason_establishment en buyer_renter_origin_zipcode niet).
Naam | Type | Verplicht? | Omschrijving |
---|---|---|---|
secondary_project_api_ids | array | nee | API object id's van objecten die als nevenbestemming gebruikt dienen te worden. |
buyer_renter_name | string | Bij een (verkocht/verhuurd) afmelding | De naam van de koper/huurder |
buyer_renter_reason_establishment | string | nee | Reden vestiging van de koper/huurder. Mogelijke waardes: inkrimping, uitbreiding, verplaatsing, nieuwe vestiging, belegging, huurverlenging |
buyer_renter_origin_zipcode | string | nee | Postcode herkomst van de koper/huurder. Dient uit 4 cijfers + 2 letters te bestaan (regex: [1-9]{1}[0-9]{3} ?[A-Z]{2}) |
transaction_type | string | ja | Verkocht, Verhuurd |
transaction_price | int | ja | Prijs van de transactie |
transaction_price_btw | boolean | nee | Standaard 'false' |
transaction_price_condition | string | ja | per maand, per jaar, per vierkante meter per jaar, kosten koper, vrij op naam |
transaction_sale_saleleaseback | boolean | nee | alleen van toepassing voor koop, standaard false |
transaction_parcel_space | int | ja | Perceel oppervlakte van de deeltransactie |
transaction_sbicodes | array | nee | SBI codes van de deeltransactie, zie het Yes-co systeem voor de mogelijke waardes |
transaction_servicecosts_price | int | nee | Servicekosten, alleen voor huur |
transaction_servicecosts_btw | boolean | nee | BTW over de servicekosten? Alleen voor huur. Standaard false. |
transaction_servicecosts_condition | string | afhankelijk | per maand, per jaar, per vierkante meter per jaar. Alleen voor huur. Verplicht indien transaction_servicecosts_price opgegeven is. |
transaction_rental_incentives | boolean | nee | Incentives. Alleen voor huur. Standaard false. |
transaction_rental_incentives_waarde | int | nee | Waarde van de incentives. Alleen voor huur. |
transaction_rental_incentives_maanden | int | nee | Aantal maanden van de incentives. Alleen voor huur. |
transaction_rental_datestartagreement | date | afhankelijk | Datum ingang huurovereenkomst. Alleen voor huur, dan ook verplicht. |
transaction_rental_contractduration | int | afhankelijk | Duur van het contract. Alleen voor huur, dan ook verplicht. |
transaction_date_sign_contract | date | ja | Datum ondertekening contract. |
transaction_sale_date_transport | date | afhankelijk | Datum transport. Alleen voor koop, dan ook verplicht. |
transaction_sale_investor_type | string | nee | Type investeerder. Alleen voor koop. Mogelijke waardes: bank/verzekeraar, beursfonds, pensioenfonds, particuliere belegger, vastgoedfonds, onbekend |
transaction_sale_investor_nationality | string | nee | Nationaliteit investeerder. Alleen voor koop. Mogelijke waardes: Nederlands, Duits, Scandinavisch, overig, onbekend |
transaction_parking_amount | int | nee | Aantal niet overdekte parkeerplaatsen. |
transaction_parking_price | int | nee | Prijs van de niet overdekte parkeerplaatsen |
transaction_parking_btw | boolean | nee | Btw over de prijs van de niet overdekte parkeerplaatsen. Standaard false. |
transaction_parking_indoor_amount | int | nee | Prijs van de overdekte parkeerplaatsen |
transaction_parking_indoor_price | int | nee | Prijs van de overdekte parkeerplaatsen |
transaction_parking_indoor_btw | boolean | nee | Btw over de prijs van de overdekte parkeerplaatsen. Standaard false. |
transaction_reason_establishment | string | nee | Reden vestiging. Mogelijke waardes: inkrimping, uitbreiding, verplaatsing, nieuwe vestiging, belegging, huurverlenging |
transaction_origin_zipcode | string | nee | Postcode herkomst. |
transaction_hall_surface | int | afhankelijk | Oppervlakte van de bedrijfshal. Alleen voor bedrijfsruimte, dan ook verplicht. |
transaction_hall_price | int | nee | Prijs van de bedrijfshal. Alleen voor bedrijfsruimte. |
transaction_hall_btw | boolean | nee | Btw over de prijs van de bedrijfshal. Alleen voor bedrijfsruimte. Standaard false |
transaction_office_surface | int | nee | Oppervlakte van het kantoor. Alleen voor bedrijfsruimte. |
transaction_office_price | int | nee | Prijs van het kantoor. Alleen voor bedrijfsruimte. |
transaction_office_btw | boolean | nee | Btw over de prijs van het kantoor. Alleen voor bedrijfsruimte. Standaard false |
transaction_ground_surface | int | nee | Oppervlakte van het terrein. Alleen voor bedrijfsruimte. |
transaction_ground_price | int | nee | Prijs van het terrein. Alleen voor bedrijfsruimte. |
transaction_ground_btw | boolean | nee | Btw over de prijs van het terrein. Alleen voor bedrijfsruimte. Standaard false |
transaction_surface | int | afhankelijk | Oppervlakte. Alleen niet van toepassing voor bedrijfsruimte. Indien van toepassing ook verplicht. |
transaction_takeover_price | int | afhankelijk | Prijs inventaris / goodwill ter overname. Alleen voor Winkelruimte, Horeca en Leisure, dan ook verplicht. |
transaction_takeover_btw | boolean | nee | Btw over prijs inventaris / goodwill ter overname. Alleen voor Winkelruimte, Horeca en Leisure. Standaard false. |
transaction_takeover_staff | boolean | nee | Personeel ter overname. Alleen voor Winkelruimte, Horeca en Leisure. Standaard false. |
Extra parameters voor PropertyNL
Naam | Type | Omschrijving |
---|---|---|
transaction_name |
string |
Naam van de transactie (verplicht indien er een transactie gemeld wordt) |
transaction_type |
string |
Let, Subtenancy, Sale, Investment, SaleLeaseBack, HerOntwikkeling, Unknown |
transaction_date |
date |
YYYY-mm-dd (verplicht indien er een transactie gemeld wordt) |
transaction_metrage |
int |
Aantal m&sub2; waarover de transactie gaat (verplicht indien er een transactie gemeld wordt) |
transaction_price |
int |
Prijs van de transactie (verplicht indien er een transaction_price_type meegestuurd wordt) |
transaction_price_type |
string |
Prijs type van de transactie (sale, square meter, year) |
transaction_publish |
boolean |
Transactie meenemen naar tijdschrijfen en andere media |
collegial_participant_guids |
string |
GUID's van collegiale makelaars, door middel van ; gescheiden. Zie PropertyNL collegiale makelaars voor het ophalen van de beschikbare collegiale makelaars. |
Indien er transactie gegevens meegestuurd worden bij een publish request (publish = true), dan wordt een deel
transactie verstuurd naar PropertyNL.
Indien er transactie gegevens meegestuurd worden met een revoke request (publish = false), dan wordt een normale
transactie verstuurd naar PropertyNL.
PropertyNL collegiale makelaars
Via deze methode kunnen de beschikbare collegiale makelaars bij PropertyNL opgehaald worden. Het response is in de vorm van: GUID => Naam van de makelaar
De GUID van een makelaar kan weer gebruikt worden bij het publiceren naar PropertyNL (collegial_participant_guids parameter)
GET /1.0/mcp/propertynl/brokers
Response
Status: 200 OK
{
"brokers":
{
"34622D94B23D4C969EA1D8A86FCFA2E7": "Ans de Wijn (sandbox) (Amersfoort)",
"1D5644099CA04DF0BD5FABBBC3B52A9B": "De Voorkant (Amersfoort)",
"14E5A9E7ECC24D3386B45FBD7C60A0DB": "DTZ Zadelhoff (Amsterdam)"
}
}