Wat zijn API inzage levels?
Glenn
Laatste update 5 maanden geleden
De makelaar kan bepalen hoeveel informatie wordt vrijgegeven via de API. De makelaar kan deze inzage levels zelf opgeven en aanpassen. Mocht je wel informatie krijgen, maar niet de informatie die zou verwacht, dan kun je dat met de makelaar overleggen. Zie hieronder de verschillende inzage levels:
Object level (voor Wonen API, BOG API en Nieuwbouw API)
Deze optie staat standaard 'aan'. Hiermee geef je de basis set objectgegevens van een object vrij, bestaande uit het volledige adres en de object media.
Objectgegevens
Hiermee vul je (basis) gegevens aan met alle beschikbare objectgegevens uit Realworks CRM.
Transactiegegevens
Hiermee vul je de gegevens aan met de gegevens die vrijkomen na de invoer van de transactiegegevens (Transactieprijs, Datum ondertekening akte, Datum transport).
Relatiegegevens
Hiermee worden bij de object gegevens ook id's van relaties vrijgegeven. Dit zijn alle mogelijke relaties die aan het object gekoppeld zijn: verkopers, kopers, aankopend makelaar, medeaanmelder, notaris en de verkopend makelaar. Bij de object gegevens wordt een id per relatie getoond. De eigenlijke relatiegegevens haal je op via de Relatie API.
Taken en Agenda level
De agenda en taken API's hebben een vrijgave op basis van dagen in verleden en dagen in de toekomst. Daarnaast hebben taken een inzageniveau. Standaard heeft elk kantoor beschikking over de inzageniveaus: Privé en Iedereen. Echter hierin kan een kantoor zelf extra niveaus aanbrengen. Zo kan men bijvoorbeeld kiezen om een Administratie of Directie niveau te gebruiken of beide. Standaard zijn geen dagen en geen inzage niveaus vrijgegeven.
Facturatie
Bij de Facturatie API is geen sprake van verschillende levels. De API wordt aangevraagd aan de hand van een bepaalde vestiging en de administratie van die vestiging wordt beschikbaar via de API.
Mocht onder een administratie meerdere vestigingen zijn gekoppeld; worden alsnog alle facturen van die administratie in de API opgenomen.
Relaties
De volgende relatie levels zijn te gebruiken:
Basis
Hiermee ontvang je basis relatiegegevens zoals: volledige naam, adressen, telefoonnummers, email, maar ook de keus wel/geen mailing en een mailing uitschrijflink.
Plus
Met dit level ontvang je de eerder genoemde gegevens aangevuld met kenmerken en toekomstige adresgegevens (indien vastgelegd in de relatiekaart).
Compleet
Met dit level ontvang je de eerder genoemde gegevens aangevuld met: geboortedatum, geboorteplaats, burgerlijke staat, complete ID gegevens en nationaliteit.
Object level (voor Wonen API, BOG API en Nieuwbouw API)
Deze optie staat standaard 'aan'. Hiermee geef je de basis set objectgegevens van een object vrij, bestaande uit het volledige adres en de object media.
Objectgegevens
Hiermee vul je (basis) gegevens aan met alle beschikbare objectgegevens uit Realworks CRM.
Transactiegegevens
Hiermee vul je de gegevens aan met de gegevens die vrijkomen na de invoer van de transactiegegevens (Transactieprijs, Datum ondertekening akte, Datum transport).
Relatiegegevens
Hiermee worden bij de object gegevens ook id's van relaties vrijgegeven. Dit zijn alle mogelijke relaties die aan het object gekoppeld zijn: verkopers, kopers, aankopend makelaar, medeaanmelder, notaris en de verkopend makelaar. Bij de object gegevens wordt een id per relatie getoond. De eigenlijke relatiegegevens haal je op via de Relatie API.
Taken en Agenda level
De agenda en taken API's hebben een vrijgave op basis van dagen in verleden en dagen in de toekomst. Daarnaast hebben taken een inzageniveau. Standaard heeft elk kantoor beschikking over de inzageniveaus: Privé en Iedereen. Echter hierin kan een kantoor zelf extra niveaus aanbrengen. Zo kan men bijvoorbeeld kiezen om een Administratie of Directie niveau te gebruiken of beide. Standaard zijn geen dagen en geen inzage niveaus vrijgegeven.
Facturatie
Bij de Facturatie API is geen sprake van verschillende levels. De API wordt aangevraagd aan de hand van een bepaalde vestiging en de administratie van die vestiging wordt beschikbaar via de API.
Mocht onder een administratie meerdere vestigingen zijn gekoppeld; worden alsnog alle facturen van die administratie in de API opgenomen.
Relaties
De volgende relatie levels zijn te gebruiken:
Basis
Hiermee ontvang je basis relatiegegevens zoals: volledige naam, adressen, telefoonnummers, email, maar ook de keus wel/geen mailing en een mailing uitschrijflink.
Plus
Met dit level ontvang je de eerder genoemde gegevens aangevuld met kenmerken en toekomstige adresgegevens (indien vastgelegd in de relatiekaart).
Compleet
Met dit level ontvang je de eerder genoemde gegevens aangevuld met: geboortedatum, geboorteplaats, burgerlijke staat, complete ID gegevens en nationaliteit.