clappform-integrations
git pull --recurse-submodules git submodule update --recursive --remote
Itris API Wrapper Documentation
The Itris API wrapper facilitates interaction with the Itris system through both REST and SOAP protocols. It allows users to fetch data from various endpoints and handle cases efficiently.
Installation
First, you need to download the Python package via pip::
$ pip install clappform_integrations==1.0.26
Import package
from clappform_integrations import Itris
import pandas as pd
Initialization
REST Part
To initialize the REST part of the wrapper:
# Formatting of the REST credentials
BASEURL_REST = "https://acc-webservices.itris.net/services/acc-istl-vip"
CLIENT_ID_REST = ""
CLIENT_SECRET_REST = ""
USERNAME_REST = ""
PASSWORD_REST = ""
headers_rest = {
'accept': 'application/json',
'Authorization': '',
}
timeout_rest = 600
itrisrest = Itris.ItrisREST(
BASEURL_REST,
CLIENT_ID_REST,
CLIENT_SECRET_REST,
USERNAME_REST,
PASSWORD_REST,
headers_rest,
timeout_rest
)
SOAP Part
Similarly for the SOAP part of the API, initialize the ItrisSOAP object with the following parameters:
# Formatting of the SOAP credentials
BASEURL_LOGIN_SOAP= 'https://acc-webservices.itris.net/services/acc-istl-soap?WSDL'
BASEURL_SOAP= 'https://acc-webservices.itris.net/services/acc-istl-cad'
PASSWORD_SOAP= ''
PLAINPASSWD_SOAP= ''
SOAPUSERID_SOAP= ''
USERNAME_SOAP= ''
headers_soap= {
'Content-Type' : 'text/xml'
},
timeout_soap= 600
itrissoap = Itris.ItrisSOAP(
BASEURL_LOGIN_SOAP,
BASEURL_SOAP,
USERNAME_SOAP,
PASSWORD_SOAP,
SOAPUSERID_SOAP,
PLAINPASSWD_SOAP,
headers_soap,
timeout_soap
)
Fetching Data
REST Part
- To retrieve data in JSON format, use
fetch_data_from_endpoint. - To retrieve data in DataFrame format, use
fetch_data_as_dataframe.
SOAP Part
Call the desired endpoint directly using call_endpoint. It will return the data in XML format.
Filters
When fetching data from the REST API, several filters can be applied:
$expand: Retrieve related data along with the main data.$skip: Pagination for fetching data in chunks or pages.
Predefined Endpoints
REST Part
The wrapper includes predefined endpoints such as:
FetchRentalObjectsWithHierarchyis utilized alongside the "$expand" filter, pertaining to the hierarchy of rental objects. Within this hierarchy, we retrieve both the units and the complexes they correspond to.
For example:
qParams = { "$expand": "Hierarchie_verhuurbare_objecten", "$skip":0}
unit_df = itrisrest.fetch_data_as_dataframe("FetchRentalObjectsWithHierarchy", qParams)
Custom Endpoints
Users can interact with endpoints not explicitly defined by providing the endpoint's identifier.
For example the Contracten endpoint is a new endpoint:
qParams = { }
contracts = itrisrest.fetch_data_as_dataframe("Contracten", qParams)
SOAP Part
Predefined SOAP endpoints include:
- GetCaseTypeDefinitions
- GetCases
- GetCaseStartState
For example to get the complaints from the SOAP part you can use:
qParams = { }
response_GetCaseTypeDefinitions = itrissoap.call_endpoint("GetCaseTypeDefinitions", qParams)
Metadata
Release files for clappform-integrations 1.0.32
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| clappform_integrations-1.0.32.tar.gz | 16.5 kB | Without provenance | Details for clappform_integrations-1.0.32.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| clappform_integrations-1.0.32-py3-none-any.whl | Python 3 | none | any | Details for clappform_integrations-1.0.32-py3-none-any.whl |
Total release size: 34.0 kB
Release files / clappform_integrations-1.0.32.tar.gz
| Download URL | clappform_integrations-1.0.32.tar.gz |
|---|---|
| Size | 16.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
98913cfca36a44d05074a40fba48e659a3f8d76e1a74a1200d849aa8b292404d
|
|
BLAKE2b-256 checksum How to use checksums |
48ff8ae3504f69d49b2b18701465822a9f79a50063c22fe514e7dd692ec306f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.11
|
Release files / clappform_integrations-1.0.32-py3-none-any.whl
| Download URL | clappform_integrations-1.0.32-py3-none-any.whl |
|---|---|
| Size | 17.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
40610838abcdbff75994f438f4a1668f52d843c23f5f9f3591ede3d08145f5ce
|
|
BLAKE2b-256 checksum How to use checksums |
80d131c6326e8fb9207d59a52837efc76d5f419c8faf435fb14b6d182e9943c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.11
|
Security for clappform-integrations 1.0.32
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.