Package: calcasa-api
calcasa-apiThe Calcasa API is used to connect to Calcasa provided services. This is the first production version of the serviceClient packagesNuget-Packagist-PyPIClient implementation notesClients should at all times be tolerant to the following:Extra fields in responsesEmpty or hidden fields in responsesExtra values in enumerationsUnexpected error responses in the form ofProblem DetailsOpenAPI SpecificationThis API is documented inOpenAPI format version 3you can use tools like theOpenAPI Generatorto generate API clients for for example the languages we don't provide a pre-built client for. This is documentedhere.Changelog2023-10-24 (v1.3.0)Addgeldverstrekkerfield to theCallbackInschrijvingmodel.Add support for mTLS on the callback service.By default when requested by the target server the public CA signed TLS certificate with the appropriate domain as Common Name will be offered as the client certificate.Public TLS Certificates rotate every couple of months.Change a couple ofdate-timefields that only contained a date to puredatefields. This might result is a different type in the generated clients and the service-side validation will be more strict. Times included in values will no longer be silently dropped, but will generate an error.ChangeModeldatamodelwaardebepalingsdatumfield to typedatein OpenAPI spec.ChangeBestemmingsdatamodeldatumBestemmingplanfield to typedatein OpenAPI spec.ChangeBodemdatamodeldatumLaatsteOnderzoekfield to typedatein OpenAPI spec.ChangeReferentieobjectmodelverkoopdatumfield to typedatein OpenAPI spec.ChangeVorigeVerkoopmodelverkoopdatumfield to typedatein OpenAPI spec.ChangewaarderingInputParametersmodelpeildatumfield to typedatein OpenAPI spec. This is an input field and will now require a date without a time.AdddesktopTaxatieHerwaarderingproduct to enumerationProductType.The service no longer returns CORS headers.Actions now correctly report the 'application/problem+json' Content-Type in the documentation for theHTTP 422 Unprocessable Entityresponses.AddedenergielabelDatafield toObjectdatamodel to contain the extra information about the energy label.The OpenAPI spec generation was changed slightly and thus the generated and published clients might be affected. There might be some slight breaking changes at compile time, but the functionality remains the same.For example for C# and PHPAdresInfoAdresis now just covered byAdresLikewise for theOmgevingsdata*models that are now all covered byGebiedsdataFor a lot of theWaardering*models they are now using the correct model names, likeWaarderingModel->Modeldata2023-04-17 (v1.2.1)AddexterneReferentiefield to theCallbackInschrijvingandWaarderingWebhookPayloadmodels.2022-08-04 (v1.2.0)Add support for managingCallbackSubscription's, this allows you to subscribe to callbacks for valuations that were not created with your API client.GET /v1/callbacks/inschrijvingenPOST /v1/callbacks/inschrijvingenGET /v1/callbacks/inschrijvingen/{bagNummeraanduidingId}DELETE /v1/callbacks/inschrijvingen/{bagNummeraanduidingId}Addtaxateurnaamfield to theTaxatiedatamodel.Callback URIs should now end in/not just contain it to help stop common errors (ending in=is also still allowed when using a query string).Updating configuration in thePOST /v1/configuratie/callbacksendpoint now clears stored but decommissioned versions from the configuration object.Addklantkenmerkto theWaarderingInputParametersandWaarderingmodels.2022-07-12 (v1.1.7)Added support for the OAuth 2.0 authorization code flow for use of the API with user accounts.AddbouweenheidtoFunderingSoortBronenumeration.2022-05-19 (v1.1.6)AddedltvTeHoogOverbruggingvalue to theBusinessRulesCodeenumeration.2022-04-13 (v1.1.5)Fix the schema forOperationvaluefield for the benefit of the PHP and Python code generators, these will now correctly support any value type.2022-04-12 (v1.1.4)Added proper Content-Disposition headers to theGET /v1/rapporten/{id}andGET /v1/facturen/{id}endpoints with the correct filename.Fix Mime Types for thePOST /v1/configuratie/callbacksendpoint to only acceptapplication/json.Fix C# API client to correctly use theapplication/json-patch+jsoncontent type in requests that require it.Fix C# client'sFileParametertype correct handling of response headers likeContent-DispositionandContent-Type.Removed C# client's useless implementation ofIValidatableObject.Fix Python client's internal namespace name being illegalcalcasa-api->calcasa.api.2022-03-22 (v1.1.3)Add 402 (Payment required) and 422 (Unprocessable entity) as potential response forPATCH /v1/waarderingen/{id}.2022-03-17 (v1.1.2)Fixed response type forGET /v1/geldverstrekkers/{productType}endpoint.2022-03-08 (v1.1.1)AddedGET /v1/geldverstrekkers/{productType}endpoint.Restored allProblemDetailsmodels.2022-03-07 (v1.1.0)AddedisErfpachttoWaarderingInputParameters.Cleaned up serialization of null values, they should no longer appear in the output.2021-02-04Added extra clarification to the documentation pertaining to theWaarderingInputParametersand which fields are required for the different input parameter combinations.2022-01-11 (v1.0.2)FixedGET /api/v1/bodem/{id}endpoint path parameter description, query parameter was never meant to be there.2021-12-23Clarified the documentation pertaining to theWaarderingInputParametersand which fields are required for the different product types.2021-12-22 (v1.0.1)Dates are now serialized in the ISO date-only formatyyyy-MM-ddto stop any confusion around timezones and are all assumed to be in UTC.peildatuminWaarderingsInputParametersdatum_bestemmingplaninBestemmingsdatadatum_laatste_onderzoekinBodemdataverkoopdatuminReferentieobjectverkoopdatuminVorigeVerkoopwaardebepalingsdatuminModeldataReintroduced theWaarderingWebhookPayloadmodel that was omitted.2021-12-21Patching the status of aWaarderingobject will now immediatly reflect its new status in the response object.2021-12-13 (v1.0.0)Initial release ofv1based onv0.0.6Cross-Origin Resource SharingThis API features Cross-Origin Resource Sharing (CORS) implemented in compliance withW3C spec.
And that allows cross-domain communication from the browser.
All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.AuthenticationAuthentication is done viaOAuth2and theclient credentialsgrant type.Previous versions changelogs2022-02-02API versionv0was removed from service.2021-12-23Markv0as officially deprecated. No further versions will be released. Every implementation should move tov12021-12-10 (v0.0.6)Added extra fieldpeildatumto theWaarderingInputParametersmodel.2021-11-25 (v0.0.5)Updated all reported OAuth2 scopes and reduced the superflous scope information on each endpoint.2021-11-23 (v0.0.4)Added per square meter developments to theWaarderingOntwikkelingobject (fields with thePerVierkantemetersuffix).2021-11-15 (v0.0.3)Added callback update and read endpoints and models.Updated documentation.2021-11-11Renamed /fundering endpoint to /funderingen to be more in line with other endpointsRenamedHerstelTypetoFunderingHerstelType.AddedFunderingTypevalues.2021-11-10Adjusted OpenAPI Spec generation to fix some issues with certain generators. This also means that the nullable nature of certain fields is now correctly represented. Please refer to the Generation article for more information, the config files were updated aswell.2021-11-09AddedStatusandTaxatiedatumtoTaxatiedatamodel.2021-11-08Renamedidfield inAdresInfomodel tobagNummeraanduidingId.AddedGET /v0/fundering/{id}endpoint with corresponding models.Changed HTTP response code for theBusinessRulesProblemDetailserror return type ofPOST /v0/waarderingfrom422 Unprocessable Entityto406 Not Acceptableto fix a duplicate.2021-10-13Addedtaxatiefield toWaarderingmodel.AddedTaxatiedatamodel containing thetaxatieorganisatiefield for desktop valuations.2021-09-29Addedaangemaakttimestamp field toWaarderingmodel.AddedWaarderingZoekParametersmodel to replaceWaarderingInputParametersin thePOST /v0/waarderingen/zoekenendpoint.SplitOmgevingsdatamodel into a set of separateGebiedsdatamodels that also contain extra statistics.Addedbijzonderhedenfield toVorigeVerkoopmodel.RenamedReferentieBijzonderhedenmodel toVerkoopBijzonderheden.2021-09-22Initial release ofv0This Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.3.0Package version: 1.3.0Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visithttps://www.calcasa.nl/contactRequirements.Python >=3.6Installation & Usagepip installIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)Then import the package:importcalcasa.apiSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importcalcasa.apiGetting StartedPlease follow theinstallation procedureand then run the following:importtimeimportcalcasa.apifrompprintimportpprintfromcalcasa.api.apiimportadressen_apifromcalcasa.api.model.adresimportAdresfromcalcasa.api.model.adres_infoimportAdresInfofromcalcasa.api.model.not_found_problem_detailsimportNotFoundProblemDetailsfromcalcasa.api.model.permissions_denied_problem_detailsimportPermissionsDeniedProblemDetailsfromcalcasa.api.model.problem_detailsimportProblemDetails# Defining the host is optional and defaults to https://api.calcasa.nl# See configuration.py for a list of all supported configuration parameters.configuration=calcasa.api.Configuration(host="https://api.calcasa.nl")# 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.# Configure OAuth2 access token for authorization: oauthconfiguration=calcasa.api.Configuration(host="https://api.calcasa.nl")configuration.access_token='YOUR_ACCESS_TOKEN'# Configure OAuth2 access token for authorization: oauthconfiguration=calcasa.api.Configuration(host="https://api.calcasa.nl")configuration.access_token='YOUR_ACCESS_TOKEN'# Enter a context with an instance of the API clientwithcalcasa.api.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=adressen_api.AdressenApi(api_client)bag_nummeraanduiding_id=1# 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)pprint(api_response)exceptcalcasa.api.ApiExceptionase:print("Exception when calling AdressenApi->get_adres:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttps://api.calcasa.nlClassMethodHTTP requestDescriptionAdressenApiget_adresGET/api/v1/adressen/{bagNummeraanduidingId}Adres info op basis van BAG Nummeraanduiding Id.AdressenApisearch_adresPOST/api/v1/adressen/zoekenZoek adres info op basis van het gegeven adres.BestemmingsplannenApiget_bestemming_by_idGET/api/v1/bestemmingsplannen/{bagNummeraanduidingId}Gegevens over de bestemmingsplannen op de locatie van een adres (BAG Nummeraanduiding ID).BodemApiget_bodem_by_idGET/api/v1/bodem/{bagNummeraanduidingId}Gegevens over de bodemkwaliteit op de locatie van een adres (BAG Nummeraanduiding ID).BuurtApiget_buurtGET/api/v1/buurt/{buurtId}Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is.CallbacksApiadd_or_update_callback_subscriptionPOST/api/v1/callbacks/inschrijvingenVoeg een callback inschrijving toe (of werk bij) voor de huidige client voor een adres.CallbacksApidelete_notification_subscriptionDELETE/api/v1/callbacks/inschrijvingen/{bagNummeraanduidingId}Verwijder de callback inschrijving voor deze client, dit adres en optioneel een geldverstrekker.CallbacksApiget_notification_subscriptionGET/api/v1/callbacks/inschrijvingen/{bagNummeraanduidingId}Haal de callback inschrijving op voor deze client, dit adres en eventueel opgegeven geldverstrekker.CallbacksApiget_notification_subscriptionsGET/api/v1/callbacks/inschrijvingenHaal de callback inschrijvingen binnen voor deze client.ConfiguratieApiget_callbacksGET/api/v1/configuratie/callbacksHaal de geconfigureerde callback URL's op voor de huidige client.ConfiguratieApiupdate_callbacksPOST/api/v1/configuratie/callbacksConfigureer callback URL voor een specifieke API versie voor de huidige client.FacturenApiget_factuurGET/api/v1/facturen/{id}Factuur op basis van een waardering Id.FotosApiget_fotoGET/api/v1/fotos/{id}Foto op basis van een foto Id.FunderingenApiget_fundering_by_idGET/api/v1/funderingen/{bagNummeraanduidingId}Gegevens over de fundering op de locatie van een adres (BAG Nummeraanduiding ID).GeldverstrekkersApiget_geldverstrekkersGET/api/v1/geldverstrekkers/{productType}Alle geldverstrekkers die te gebruiken zijn voor aanvragen.RapportenApiget_rapportGET/api/v1/rapporten/{id}Rapport op basis van waardering Id.WaarderingenApicreate_waarderingPOST/api/v1/waarderingenCreërt een waardering.WaarderingenApiget_waarderingGET/api/v1/waarderingen/{id}Waardering op basis van Id.WaarderingenApiget_waardering_ontwikkelingGET/api/v1/waarderingen/{id}/ontwikkelingWaardering ontwikkeling op basis van waardering Id.WaarderingenApipatch_waarderingenPATCH/api/v1/waarderingen/{id}Patcht een waardering.WaarderingenApisearch_waarderingenPOST/api/v1/waarderingen/zoekenZoek waardering op basis van input parameters.Documentation For ModelsAanvraagdoelAdresAdresInfoBestemmingsdataBodemStatusTypeBodemdataBusinessRulesCodeBusinessRulesProblemDetailsCallbackCallbackInschrijvingCbsIndelingEnergielabelEnergielabelDataFactuurFotoFunderingDataBronFunderingHerstelTypeFunderingRisicoFunderingRisicoLabelFunderingSoortBronFunderingTypeFunderingTyperingFunderingdataGebiedsdataGeldverstrekkerInvalidArgumentProblemDetailsJsonPatchDocumentKlantwaardeTypeKwartaalModeldataNotFoundProblemDetailsNotitieNotitiesObjectdataOmgevingsdataOperationOperationTypePermissionsDeniedProblemDetailsProblemDetailsProductTypeRapportReferentieobjectResourceExhaustedProblemDetailsTaxatiedataTaxatiestatusValidationProblemDetailsVerkoopBijzonderhedenVorigeVerkoopWaarderingWaarderingInputParametersWaarderingOntwikkelingWaarderingOntwikkelingKwartaalWaarderingStatusWaarderingWebhookPayloadWaarderingZoekParametersWoningTypeDocumentation For AuthorizationoauthType: OAuthFlow: applicationAuthorization URL:Scopes:all: Full permissions for all areas.api:all: Full permissions for all areas of the public API.api:bestemmingsplannen:all: Full permissions for the bestemmingsplannen area of the public API.api:bodem:all: Full permissions for the bodem area of the public API.api:buurt:all: Full permissions for the buurt area of the public API.api:configuratie:all: Full permissions for the configuratie area of the public API.api:callback:all: Full permissions for the callback area of the public API.api:facturen:all: Full permissions for the facturen area of the public API.api:fotos:all: Full permissions for the fotos area of the public API.api:funderingen:all: Full permissions for the funderingen area of the public API.api:rapporten:all: Full permissions for the rapporten area of the public API.api:waarderingen:all: Full permissions for the waarderingen area of the public API.api:adressen:read: Read permissions for the adressen area of the public API.api:bestemmingsplannen:read: Read permissions for the bestemmingsplannen area of the public API.api:bodem:read: Read permissions for the bodem area of the public API.api:buurt:read: Read permissions for the buurt area of the public API.api:configuratie:read: Read permissions for the configuratie area of the public API.api:configuratie:write: Write permissions for the configuratie area of the public API.api:callback:read: Read permissions for the callback area of the public API.api:callback:write: Write permissions for the callback area of the public API.api:facturen:read: Read permissions for the facturen area of the public API.api:fotos:read: Read permissions for the fotos area of the public API.api:funderingen:read: Read permissions for the funderingen area of the public API.api:geldverstrekkers:read: Read permissions for the geldverstrekkers area of the public API.api:rapporten:read: Read permissions for the rapporten area of the public API.api:waarderingen:create: Create permissions for the waarderingen area of the public API.api:waarderingen:patch: Patch permissions for the waarderingen area of the public API.api:waarderingen:read: Read permissions for the waarderingen area of the public API.api:waarderingen:ontwikkeling: Read permissions for the ontwikkelingen endpoint in the waarderingen area of the public API.oauthType: OAuthFlow: accessCodeAuthorization URL:https://authentication.calcasa.nl/oauth2/v2.0/authorizeScopes:all: Full permissions for all areas.api:all: Full permissions for all areas of the public API.api:bestemmingsplannen:all: Full permissions for the bestemmingsplannen area of the public API.api:bodem:all: Full permissions for the bodem area of the public API.api:buurt:all: Full permissions for the buurt area of the public API.api:configuratie:all: Full permissions for the configuratie area of the public API.api:callback:all: Full permissions for the callback area of the public API.api:facturen:all: Full permissions for the facturen area of the public API.api:fotos:all: Full permissions for the fotos area of the public API.api:funderingen:all: Full permissions for the funderingen area of the public API.api:rapporten:all: Full permissions for the rapporten area of the public API.api:waarderingen:all: Full permissions for the waarderingen area of the public API.api:adressen:read: Read permissions for the adressen area of the public API.api:bestemmingsplannen:read: Read permissions for the bestemmingsplannen area of the public API.api:bodem:read: Read permissions for the bodem area of the public API.api:buurt:read: Read permissions for the buurt area of the public API.api:configuratie:read: Read permissions for the configuratie area of the public API.api:configuratie:write: Write permissions for the configuratie area of the public API.api:callback:read: Read permissions for the callback area of the public API.api:callback:write: Write permissions for the callback area of the public API.api:facturen:read: Read permissions for the facturen area of the public API.api:fotos:read: Read permissions for the fotos area of the public API.api:funderingen:read: Read permissions for the funderingen area of the public API.api:geldverstrekkers:read: Read permissions for the geldverstrekkers area of the public API.api:rapporten:read: Read permissions for the rapporten area of the public API.api:waarderingen:create: Create permissions for the waarderingen area of the public API.api:waarderingen:patch: Patch permissions for the waarderingen area of the public API.api:waarderingen:read: Read permissions for the waarderingen area of the public API.api:waarderingen:ontwikkeling: Read permissions for the ontwikkelingen endpoint in the waarderingen area of the public API.Authorinfo@calcasa.nlNotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in calcasa.api.apis and calcasa.api.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:Solution 1:
Use specific imports for apis and models like:from calcasa.api.api.default_api import DefaultApifrom calcasa.api.model.pet import PetSolution 2:
Before importing the package, adjust the maximum recursion limit as shown below:import sys
sys.setrecursionlimit(1500)
import calcasa.api
from calcasa.api.apis import *
from calcasa.api.models import *