API Documentation¶
Client module¶
This module contains utiltiy functions for interacting with AGIV soap services.
New in version 0.1.0.
- crabpy.client.capakey_factory(**kwargs)[source]¶
Factory that generates a CAPAKEY client.
Return type: suds.client.Client
Capakey gateway module¶
This module contains an opionated gateway for the capakey webservice.
New in version 0.2.0.
- class crabpy.gateway.capakey.Afdeling(id, naam=None, gemeente=None, centroid=None, bounding_box=None, **kwargs)[source]¶
A Cadastral Division of a Gemeente.
- class crabpy.gateway.capakey.CapakeyGateway(client, **kwargs)[source]¶
A gateway to the capakey webservice.
- get_kadastrale_afdeling_by_id(id)[source]¶
Retrieve a ‘kadastrale afdeling’ by id.
Parameters: id – An id of a kadastrale afdeling. Return type: A Afdeling.
- get_perceel_by_capakey(capakey)[source]¶
Get a perceel.
Parameters: capakey – An capakey for a perceel. Return type: Perceel
- get_perceel_by_id_and_sectie(id, sectie)[source]¶
Get a perceel.
Parameters: - id – An id for a perceel.
- sectie – The Sectie that contains the perceel.
Return type:
- get_perceel_by_percid(percid)[source]¶
Get a perceel.
Parameters: percid – A percid for a perceel. Return type: Perceel
- get_sectie_by_id_and_afdeling(id, afdeling)[source]¶
Get a sectie.
Parameters: - id – An id of a sectie. eg. “A”
- afdeling – The Afdeling for in which the sectie can be found. Can also be the id of and afdeling.
Return type: A Sectie.
- list_gemeenten(sort=1)[source]¶
List all gemeenten in Vlaanderen.
Parameters: sort (integer) – What field to sort on. Return type: A list of Gemeente.
- list_kadastrale_afdelingen(sort=1)[source]¶
List all kadastrale afdelingen in Flanders.
Parameters: sort (integer) – Field to sort on. Return type: A list of Afdeling.
- list_kadastrale_afdelingen_by_gemeente(gemeente, sort=1)[source]¶
List all kadastrale afdelingen in a gemeente.
Parameters: - gemeente – The Gemeente for which the afdelingen are wanted.
- sort (integer) – Field to sort on.
Return type: A list of Afdeling.
- class crabpy.gateway.capakey.Gemeente(id, naam=None, centroid=None, bounding_box=None, **kwargs)[source]¶
The smallest administrative unit in Belgium.
- class crabpy.gateway.capakey.Perceel(id, sectie, capakey, percid, capatype=None, cashkey=None, centroid=None, bounding_box=None, **kwargs)[source]¶
A Cadastral Parcel.
- class crabpy.gateway.capakey.Sectie(id, afdeling, centroid=None, bounding_box=None, **kwargs)[source]¶
A subdivision of a Afdeling.
- crabpy.gateway.capakey.check_lazy_load_afdeling(f)[source]¶
Decorator function to lazy load a Afdeling.
- crabpy.gateway.capakey.check_lazy_load_gemeente(f)[source]¶
Decorator function to lazy load a Gemeente.
Gateway exception module¶
This module contains custom errors that can be generated by gateways.
New in version 0.2.0.
Wsa module¶
This module contains utiltiy functions for using WSA with SOAP services.
New in version 0.1.0.
Wsse module¶
This module adds a UsernameDigestToken for use with SOAP services.
New in version 0.2.0.