calcasa.api 1.5.4

Calcasa Public API

calcasa.api

The Calcasa API is used to connect to Calcasa provided services. For more information, please visit Documentation or GitHub.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.5.4
• Package version: 1.5.4
• Generator version: 7.16.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.calcasa.nl/contact

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import calcasa.api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import calcasa.api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import calcasa.api
from calcasa.api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.calcasa.nl/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = calcasa.api.Configuration(
    host = "https://api.calcasa.nl/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with calcasa.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = calcasa.api.AdressenApi(api_client)
    bag_nummeraanduiding_id = 56 # int | Een BAG Nummeraanduiding ID om een adres te specificeren.

    try:
        # Adres info op basis van BAG Nummeraanduiding Id.
        api_response = api_instance.get_adres(bag_nummeraanduiding_id)
        print("The response of AdressenApi->get_adres:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdressenApi->get_adres: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.calcasa.nl/api/v1

Class	Method	HTTP request	Description
AdressenApi	get_adres	GET /adressen/{bagNummeraanduidingId}	Adres info op basis van BAG Nummeraanduiding Id.
AdressenApi	search_adres	POST /adressen/zoeken	Zoek adres info op basis van het gegeven adres.
BestemmingsplannenApi	get_bestemming_by_id	GET /bestemmingsplannen/{bagNummeraanduidingId}	Gegevens over de bestemmingsplannen op de locatie van een adres (BAG Nummeraanduiding ID).
BodemApi	get_bodem_by_id	GET /bodem/{bagNummeraanduidingId}	Gegevens over de bodemkwaliteit op de locatie van een adres (BAG Nummeraanduiding ID).
BuurtApi	get_buurt	GET /buurt/{buurtCode}	Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is.
CallbacksApi	add_or_update_callback_subscription	POST /callbacks/inschrijvingen	Voeg een callback inschrijving toe (of werk bij) voor de huidige client voor een adres.
CallbacksApi	delete_notification_subscription	DELETE /callbacks/inschrijvingen/{bagNummeraanduidingId}	Verwijder de callback inschrijving voor deze client, dit adres en optioneel een geldverstrekker.
CallbacksApi	get_notification_subscription	GET /callbacks/inschrijvingen/{bagNummeraanduidingId}	Haal de callback inschrijving op voor deze client, dit adres en eventueel opgegeven geldverstrekker.
CallbacksApi	get_notification_subscriptions	GET /callbacks/inschrijvingen	Haal de callback inschrijvingen binnen voor deze client.
ConfiguratieApi	get_callback_authentication	GET /configuratie/callbacks/authentication	Haal de geconfigureerde callback authenticatie op voor de huidige client.
ConfiguratieApi	get_callbacks	GET /configuratie/callbacks	Haal de geconfigureerde callback URL's op voor de huidige client.
ConfiguratieApi	get_mtls_certificate	GET /configuratie/callbacks/mtls-certificate	Get the self-signed mTLS certificate.
ConfiguratieApi	get_signature_keys	GET /configuratie/callbacks/signature-keys	Get the JWKS keys, deze kunnen worden gebruikt om de echtheid van webhooks te verifiëren.
ConfiguratieApi	post_callback_authentication	POST /configuratie/callbacks/authentication	Update de geconfigureerde callback authenticatie voor de huidige client.
ConfiguratieApi	update_callbacks	POST /configuratie/callbacks	Configureer callback URL voor een specifieke API versie voor de huidige client.
FacturenApi	get_factuur	GET /facturen/{id}	Factuur op basis van een waardering Id.
FotosApi	get_foto	GET /fotos/{id}	Foto op basis van een foto Id.
FunderingenApi	get_fundering_by_id	GET /funderingen/{bagNummeraanduidingId}	Gegevens over de fundering op de locatie van een adres (BAG Nummeraanduiding ID).
GeldverstrekkersApi	get_geldverstrekkers	GET /geldverstrekkers/{productType}	Alle geldverstrekkers die te gebruiken zijn voor aanvragen.
RapportenApi	get_rapport	GET /rapporten/{id}	Rapport op basis van waardering Id.
WaarderingenApi	check_producten	POST /waarderingen/check	Controleert mogelijke producten.
WaarderingenApi	create_waardering	POST /waarderingen	Creërt een waardering.
WaarderingenApi	get_waardering	GET /waarderingen/{id}	Waardering op basis van Id.
WaarderingenApi	get_waardering_ontwikkeling	GET /waarderingen/{id}/ontwikkeling	Waardering ontwikkeling op basis van waardering Id.
WaarderingenApi	patch_waarderingen	PATCH /waarderingen/{id}	Patcht een waardering.
WaarderingenApi	search_waarderingen	POST /waarderingen/zoeken	Zoek waardering op basis van input parameters.

Documentation For Models

• Aanvraagdoel
• Adres
• AdresInfo
• Bestemmingsdata
• BodemStatusType
• Bodemdata
• BusinessRulesCode
• BusinessRulesProblemDetails
• Callback
• CallbackAuthentication
• CallbackInschrijving
• CbsIndeling
• DeelWaarderingWebhookPayload
• Energielabel
• EnergielabelData
• Factuur
• Foto
• FrontendDeeplinks
• FunderingDataBron
• FunderingHerstelType
• FunderingRisico
• FunderingRisicoLabel
• FunderingSoortBron
• FunderingType
• FunderingTypering
• Funderingdata
• Funderingsrisico
• Gebiedsdata
• Geldverstrekker
• InvalidArgumentProblemDetails
• KlantwaardeType
• Kwartaal
• MTLSType
• Modeldata
• NotFoundProblemDetails
• Notitie
• Notities
• Objectdata
• Omgevingsdata
• OnderhoudStaat
• Operation
• OperationType
• Opnamedata
• PermissionsDeniedProblemDetails
• ProblemDetails
• ProductCheck
• ProductCheckItem
• ProductCheckParameters
• ProductType
• Rapport
• Referentieobject
• ResourceExhaustedProblemDetails
• Taxatiedata
• Taxatiestatus
• UnauthorizedProblemDetails
• ValidationProblemDetails
• VerkoopBijzonderheden
• VersionNames
• VorigeVerkoop
• Waardering
• WaarderingInputParameters
• WaarderingOntwikkeling
• WaarderingOntwikkelingKwartaal
• WaarderingStatus
• WaarderingWebhookPayload
• WaarderingZoekParameters
• WebhookPayload
• WoningType

Documentation For Authorization

Authentication schemes defined for the API:

oauth

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• api:adressen:read:
• api:bestemmingsplannen:read:
• api:bodem:read:
• api:buurt:read:
• api:callback:read:
• api:callback:write:
• api:configuratie:read:
• api:configuratie:write:
• api:facturen:read:
• api:fotos:read:
• api:funderingen:read:
• api:geldverstrekkers:read:
• api:rapporten:read:
• api:waarderingen:read:
• api:waarderingen:patch:
• api:waarderingen:ontwikkeling:
• api:waarderingen:create:

Author

[e-mail]