de-abfallnavi


Namede-abfallnavi JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/poschi3/abfallnavi-api
SummaryAbfallnavi API
upload_time2022-06-29 21:11:30
maintainer
docs_urlNone
authorBundesAPI
requires_python>=3.6
licenseApache-2.0
keywords openapi openapi-generator abfallnavi app api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # abfallnavi
Termine für Leerung des Abfalls nach Abfallart (Papier, Restmüll, ...). Beispielswerte sind für das Rathaus Nürnberg (Hauptmarkt 18, Nürnberg).

# Kommunen / Regionen

Das System ist in diverse Regionen unterteilt. Zu einer `Region` gehören ein oder mehrere Kommunen.

* `aachen`: Aachen
* `zew2`: AWA Entsorgungs GmbH
* `aw-bgl2`: Bergisch Gladbach
* `bav`: Bergischer Abfallwirtschaftverbund
* `din`: Dinslaken
* `dorsten`: Dorsten
* `gt2`: Gütersloh
* `hlv`: Halver
* `coe`: Kreis Coesfeld
* `krhs`: Kreis Heinsberg
* `pi`: Kreis Pinneberg
* `krwaf`: Kreis Warendorf
* `lindlar`: Lindlar
* `stl`: Lüdenscheid
* `nds`: Norderstedt
* `nuernberg`: Nürnberg
* `roe`: Roetgen
* `solingen`: Solingen
* `wml2`: EGW Westmünsterland

# Benutzung

Für die Abfrage von Terminen ist eine Reihe von IDs (von Orten, Straßen und/oder Hausnummern) in Erfahrung zu bringen. Vorsicht:IDs können sich mit der Zeit ändern

1. Orte aus System holen
2. Mit Ort die Straßen abfragen
3. Mit Straße die Hausnummern abfragen
4. Mit Haunummer die möglichen Fraktionen (Müllsorten) abfragen
5. Mit Hausnummer und Fraktionen alle Termine abrufen

Manchmal wird nicht nach Hausnummer unterschieden


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 0.1.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python >= 3.6

## Installation & Usage
### pip install

```sh
pip install deutschland[abfallnavi]
```

### poetry install

```sh
poetry add deutschland -E abfallnavi
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

## Usage

Import the package:
```python
from deutschland import abfallnavi
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import time
from deutschland import abfallnavi
from pprint import pprint
from deutschland.abfallnavi.api import abholpunkte_api
from deutschland.abfallnavi.model.ort import Ort
from deutschland.abfallnavi.model.ort2 import Ort2
from deutschland.abfallnavi.model.strasse import Strasse
# Defining the host is optional and defaults to https://nuernberg-abfallapp.regioit.de/abfall-app-nuernberg/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = abfallnavi.Configuration(
    host = "https://nuernberg-abfallapp.regioit.de/abfall-app-nuernberg/rest"
)



# Enter a context with an instance of the API client
with abfallnavi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = abholpunkte_api.AbholpunkteApi(api_client)
    strassen_id = 1 # int | Id der Straße

    try:
        # Hausnummern in Straße
        api_response = api_instance.hausnummern_pro_strasse(strassen_id)
        pprint(api_response)
    except abfallnavi.ApiException as e:
        print("Exception when calling AbholpunkteApi->hausnummern_pro_strasse: %s\n" % e)
```

## Documentation for API Endpoints

All URIs are relative to *https://nuernberg-abfallapp.regioit.de/abfall-app-nuernberg/rest*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AbholpunkteApi* | [**hausnummern_pro_strasse**](docs/AbholpunkteApi.md#hausnummern_pro_strasse) | **GET** /strassen/{strassenId} | Hausnummern in Straße
*AbholpunkteApi* | [**ort**](docs/AbholpunkteApi.md#ort) | **GET** /orte/{ortId} | Informationen zu Ort
*AbholpunkteApi* | [**orte**](docs/AbholpunkteApi.md#orte) | **GET** /orte | Orte im System
*AbholpunkteApi* | [**strassen_pro_ort**](docs/AbholpunkteApi.md#strassen_pro_ort) | **GET** /orte/{ortId}/strassen | Straßen im Ort
*FraktionenApi* | [**muellarten**](docs/FraktionenApi.md#muellarten) | **GET** /fraktionen | Müllarten im System
*FraktionenApi* | [**muellarten_pro_hausnummer**](docs/FraktionenApi.md#muellarten_pro_hausnummer) | **GET** /hausnummern/{hausnummernId}/fraktionen | Müllarten für Hausnummer
*FraktionenApi* | [**muellarten_pro_strasse**](docs/FraktionenApi.md#muellarten_pro_strasse) | **GET** /strassen/{strassenId}/fraktionen | Müllarten für Straßen
*TermineApi* | [**download_as_file**](docs/TermineApi.md#download_as_file) | **GET** /kalender-{region}/downloadfile.jsp | Datenexport als PDF oder ICS
*TermineApi* | [**termine_pro_haussnummer**](docs/TermineApi.md#termine_pro_haussnummer) | **GET** /hausnummern/{hausnummernId}/termine | Abholtermine für Hausnummer
*TermineApi* | [**termine_pro_strasse**](docs/TermineApi.md#termine_pro_strasse) | **GET** /strassen/{strassenId}/termine | Abholtermine für Straße


## Documentation For Models

 - [Abholung](docs/Abholung.md)
 - [Bezirk](docs/Bezirk.md)
 - [Fraktion](docs/Fraktion.md)
 - [Hausnummer](docs/Hausnummer.md)
 - [Ort](docs/Ort.md)
 - [Ort2](docs/Ort2.md)
 - [OrtInner](docs/OrtInner.md)
 - [Region](docs/Region.md)
 - [Strasse](docs/Strasse.md)


## Documentation For Authorization

 All endpoints do not require authorization.

## Author

kontakt@bund.dev


## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in abfallnavi.apis and abfallnavi.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 deutschland.abfallnavi.api.default_api import DefaultApi`
- `from deutschland.abfallnavi.model.pet import Pet`

Solution 2:
Before importing the package, adjust the maximum recursion limit as shown below:
```
import sys
sys.setrecursionlimit(1500)
from deutschland import abfallnavi
from deutschland.abfallnavi.apis import *
from deutschland.abfallnavi.models import *
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/poschi3/abfallnavi-api",
    "name": "de-abfallnavi",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "OpenAPI,OpenAPI-Generator,abfallnavi,App,API",
    "author": "BundesAPI",
    "author_email": "kontakt@bund.dev",
    "download_url": "https://files.pythonhosted.org/packages/7e/af/509f28d7b0cf8f3102dabe12d81bff36d178fe239a4584b0d97ab0caac26/de-abfallnavi-0.1.0.tar.gz",
    "platform": null,
    "description": "# abfallnavi\nTermine f\u00fcr Leerung des Abfalls nach Abfallart (Papier, Restm\u00fcll, ...). Beispielswerte sind f\u00fcr das Rathaus N\u00fcrnberg (Hauptmarkt 18, N\u00fcrnberg).\n\n# Kommunen / Regionen\n\nDas System ist in diverse Regionen unterteilt. Zu einer `Region` geh\u00f6ren ein oder mehrere Kommunen.\n\n* `aachen`: Aachen\n* `zew2`: AWA Entsorgungs GmbH\n* `aw-bgl2`: Bergisch Gladbach\n* `bav`: Bergischer Abfallwirtschaftverbund\n* `din`: Dinslaken\n* `dorsten`: Dorsten\n* `gt2`: G\u00fctersloh\n* `hlv`: Halver\n* `coe`: Kreis Coesfeld\n* `krhs`: Kreis Heinsberg\n* `pi`: Kreis Pinneberg\n* `krwaf`: Kreis Warendorf\n* `lindlar`: Lindlar\n* `stl`: L\u00fcdenscheid\n* `nds`: Norderstedt\n* `nuernberg`: N\u00fcrnberg\n* `roe`: Roetgen\n* `solingen`: Solingen\n* `wml2`: EGW Westm\u00fcnsterland\n\n# Benutzung\n\nF\u00fcr die Abfrage von Terminen ist eine Reihe von IDs (von Orten, Stra\u00dfen und/oder Hausnummern) in Erfahrung zu bringen. Vorsicht:IDs k\u00f6nnen sich mit der Zeit \u00e4ndern\n\n1. Orte aus System holen\n2. Mit Ort die Stra\u00dfen abfragen\n3. Mit Stra\u00dfe die Hausnummern abfragen\n4. Mit Haunummer die m\u00f6glichen Fraktionen (M\u00fcllsorten) abfragen\n5. Mit Hausnummer und Fraktionen alle Termine abrufen\n\nManchmal wird nicht nach Hausnummer unterschieden\n\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 0.1.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython >= 3.6\n\n## Installation & Usage\n### pip install\n\n```sh\npip install deutschland[abfallnavi]\n```\n\n### poetry install\n\n```sh\npoetry add deutschland -E abfallnavi\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\n## Usage\n\nImport the package:\n```python\nfrom deutschland import abfallnavi\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nfrom deutschland import abfallnavi\nfrom pprint import pprint\nfrom deutschland.abfallnavi.api import abholpunkte_api\nfrom deutschland.abfallnavi.model.ort import Ort\nfrom deutschland.abfallnavi.model.ort2 import Ort2\nfrom deutschland.abfallnavi.model.strasse import Strasse\n# Defining the host is optional and defaults to https://nuernberg-abfallapp.regioit.de/abfall-app-nuernberg/rest\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = abfallnavi.Configuration(\n    host = \"https://nuernberg-abfallapp.regioit.de/abfall-app-nuernberg/rest\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith abfallnavi.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = abholpunkte_api.AbholpunkteApi(api_client)\n    strassen_id = 1 # int | Id der Stra\u00dfe\n\n    try:\n        # Hausnummern in Stra\u00dfe\n        api_response = api_instance.hausnummern_pro_strasse(strassen_id)\n        pprint(api_response)\n    except abfallnavi.ApiException as e:\n        print(\"Exception when calling AbholpunkteApi->hausnummern_pro_strasse: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://nuernberg-abfallapp.regioit.de/abfall-app-nuernberg/rest*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AbholpunkteApi* | [**hausnummern_pro_strasse**](docs/AbholpunkteApi.md#hausnummern_pro_strasse) | **GET** /strassen/{strassenId} | Hausnummern in Stra\u00dfe\n*AbholpunkteApi* | [**ort**](docs/AbholpunkteApi.md#ort) | **GET** /orte/{ortId} | Informationen zu Ort\n*AbholpunkteApi* | [**orte**](docs/AbholpunkteApi.md#orte) | **GET** /orte | Orte im System\n*AbholpunkteApi* | [**strassen_pro_ort**](docs/AbholpunkteApi.md#strassen_pro_ort) | **GET** /orte/{ortId}/strassen | Stra\u00dfen im Ort\n*FraktionenApi* | [**muellarten**](docs/FraktionenApi.md#muellarten) | **GET** /fraktionen | M\u00fcllarten im System\n*FraktionenApi* | [**muellarten_pro_hausnummer**](docs/FraktionenApi.md#muellarten_pro_hausnummer) | **GET** /hausnummern/{hausnummernId}/fraktionen | M\u00fcllarten f\u00fcr Hausnummer\n*FraktionenApi* | [**muellarten_pro_strasse**](docs/FraktionenApi.md#muellarten_pro_strasse) | **GET** /strassen/{strassenId}/fraktionen | M\u00fcllarten f\u00fcr Stra\u00dfen\n*TermineApi* | [**download_as_file**](docs/TermineApi.md#download_as_file) | **GET** /kalender-{region}/downloadfile.jsp | Datenexport als PDF oder ICS\n*TermineApi* | [**termine_pro_haussnummer**](docs/TermineApi.md#termine_pro_haussnummer) | **GET** /hausnummern/{hausnummernId}/termine | Abholtermine f\u00fcr Hausnummer\n*TermineApi* | [**termine_pro_strasse**](docs/TermineApi.md#termine_pro_strasse) | **GET** /strassen/{strassenId}/termine | Abholtermine f\u00fcr Stra\u00dfe\n\n\n## Documentation For Models\n\n - [Abholung](docs/Abholung.md)\n - [Bezirk](docs/Bezirk.md)\n - [Fraktion](docs/Fraktion.md)\n - [Hausnummer](docs/Hausnummer.md)\n - [Ort](docs/Ort.md)\n - [Ort2](docs/Ort2.md)\n - [OrtInner](docs/OrtInner.md)\n - [Region](docs/Region.md)\n - [Strasse](docs/Strasse.md)\n\n\n## Documentation For Authorization\n\n All endpoints do not require authorization.\n\n## Author\n\nkontakt@bund.dev\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in abfallnavi.apis and abfallnavi.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from deutschland.abfallnavi.api.default_api import DefaultApi`\n- `from deutschland.abfallnavi.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nfrom deutschland import abfallnavi\nfrom deutschland.abfallnavi.apis import *\nfrom deutschland.abfallnavi.models import *\n```\n\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Abfallnavi API",
    "version": "0.1.0",
    "split_keywords": [
        "openapi",
        "openapi-generator",
        "abfallnavi",
        "app",
        "api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ac83f10994384227f8a9feb3a8c9fd75",
                "sha256": "3f165c23752e265f3c19c03afa1398dffa159881ba0f78d4f596044802b5cc49"
            },
            "downloads": -1,
            "filename": "de_abfallnavi-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ac83f10994384227f8a9feb3a8c9fd75",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 81297,
            "upload_time": "2022-06-29T21:11:28",
            "upload_time_iso_8601": "2022-06-29T21:11:28.297799Z",
            "url": "https://files.pythonhosted.org/packages/7f/93/f7e85560e33fb48ccce883af2bc21e5098900f9041434738d9108d652acc/de_abfallnavi-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "d814902ccb4522f5ede50fdc3deeb524",
                "sha256": "ed44fcbbec6d0a99257210c9e46e1a92332429320117ebfc399d3c8a5642ec03"
            },
            "downloads": -1,
            "filename": "de-abfallnavi-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d814902ccb4522f5ede50fdc3deeb524",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 47652,
            "upload_time": "2022-06-29T21:11:30",
            "upload_time_iso_8601": "2022-06-29T21:11:30.525738Z",
            "url": "https://files.pythonhosted.org/packages/7e/af/509f28d7b0cf8f3102dabe12d81bff36d178fe239a4584b0d97ab0caac26/de-abfallnavi-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-06-29 21:11:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "poschi3",
    "github_project": "abfallnavi-api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "de-abfallnavi"
}
        
Elapsed time: 0.36006s