de-klinikatlas


Namede-klinikatlas JSON
Version 1.0.0 PyPI version JSON
download
home_pagehttps://github.com/bundesAPI/klinikatlas-api
SummaryBundes-Klinik-Atlas API
upload_time2024-05-31 14:26:13
maintainerNone
docs_urlNone
authorBundesAPI
requires_python>=3.6
licenseApache-2.0
keywords openapi openapi-generator klinikatlas app api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # klinikatlas
Die API des Bundes-Klinik-Atlas stellt eine Vielzahl von Informationen über deutsche Kliniken und deren Ausstattung bereit.

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

- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://bundes-klinik-atlas.de](https://bundes-klinik-atlas.de)

## Requirements.

Python >= 3.6

## Installation & Usage
### pip install

```sh
pip install deutschland[klinikatlas]
```

### poetry install

```sh
poetry add deutschland -E klinikatlas
```

### 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 klinikatlas
```

## Getting Started

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

```python

import time
from deutschland import klinikatlas
from pprint import pprint
from deutschland.klinikatlas.api import default_api
from deutschland.klinikatlas.model.fileadmin_json_german_places_json_get200_response_inner import FileadminJsonGermanPlacesJsonGet200ResponseInner
from deutschland.klinikatlas.model.fileadmin_json_german_states_json_get200_response_inner import FileadminJsonGermanStatesJsonGet200ResponseInner
from deutschland.klinikatlas.model.fileadmin_json_icd_codes_json_get200_response_inner import FileadminJsonIcdCodesJsonGet200ResponseInner
from deutschland.klinikatlas.model.fileadmin_json_locations_json_get200_response_inner import FileadminJsonLocationsJsonGet200ResponseInner
from deutschland.klinikatlas.model.fileadmin_json_ops_codes_json_get200_response_inner import FileadminJsonOpsCodesJsonGet200ResponseInner
from deutschland.klinikatlas.model.fileadmin_json_states_json_get200_response_inner import FileadminJsonStatesJsonGet200ResponseInner
from deutschland.klinikatlas.model.searchresults_get200_response import SearchresultsGet200Response
# Defining the host is optional and defaults to https://bundes-klinik-atlas.de
# See configuration.py for a list of all supported configuration parameters.
configuration = klinikatlas.Configuration(
    host = "https://bundes-klinik-atlas.de"
)



# Enter a context with an instance of the API client
with klinikatlas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)

    try:
        # Liste deutscher Orte abrufen
        api_response = api_instance.fileadmin_json_german_places_json_get()
        pprint(api_response)
    except klinikatlas.ApiException as e:
        print("Exception when calling DefaultApi->fileadmin_json_german_places_json_get: %s\n" % e)
```

## Documentation for API Endpoints

All URIs are relative to *https://bundes-klinik-atlas.de*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**fileadmin_json_german_places_json_get**](docs/DefaultApi.md#fileadmin_json_german_places_json_get) | **GET** /fileadmin/json/german-places.json | Liste deutscher Orte abrufen
*DefaultApi* | [**fileadmin_json_german_states_json_get**](docs/DefaultApi.md#fileadmin_json_german_states_json_get) | **GET** /fileadmin/json/german-states.json | Liste deutscher Bundesländer mit Koordinaten abrufen
*DefaultApi* | [**fileadmin_json_icd_codes_json_get**](docs/DefaultApi.md#fileadmin_json_icd_codes_json_get) | **GET** /fileadmin/json/icd_codes.json | Liste der ICD-Codes abrufen
*DefaultApi* | [**fileadmin_json_locations_json_get**](docs/DefaultApi.md#fileadmin_json_locations_json_get) | **GET** /fileadmin/json/locations.json | Liste deutscher Kliniken abrufen
*DefaultApi* | [**fileadmin_json_ops_codes_json_get**](docs/DefaultApi.md#fileadmin_json_ops_codes_json_get) | **GET** /fileadmin/json/ops_codes.json | Liste der OPS-Codes abrufen
*DefaultApi* | [**fileadmin_json_states_json_get**](docs/DefaultApi.md#fileadmin_json_states_json_get) | **GET** /fileadmin/json/states.json | Liste deutscher Bundesländer abrufen
*DefaultApi* | [**krankenhaussuche_krankenhaus_id_get**](docs/DefaultApi.md#krankenhaussuche_krankenhaus_id_get) | **GET** /krankenhaussuche/krankenhaus/{id}/ | Details zu einem spezifischen Krankenhaus abrufen
*DefaultApi* | [**searchresults_get**](docs/DefaultApi.md#searchresults_get) | **GET** /searchresults/ | Suche nach Krankenhäusern basierend auf spezifischen Kriterien


## Documentation For Models

 - [FileadminJsonGermanPlacesJsonGet200ResponseInner](docs/FileadminJsonGermanPlacesJsonGet200ResponseInner.md)
 - [FileadminJsonGermanStatesJsonGet200ResponseInner](docs/FileadminJsonGermanStatesJsonGet200ResponseInner.md)
 - [FileadminJsonIcdCodesJsonGet200ResponseInner](docs/FileadminJsonIcdCodesJsonGet200ResponseInner.md)
 - [FileadminJsonLocationsJsonGet200ResponseInner](docs/FileadminJsonLocationsJsonGet200ResponseInner.md)
 - [FileadminJsonOpsCodesJsonGet200ResponseInner](docs/FileadminJsonOpsCodesJsonGet200ResponseInner.md)
 - [FileadminJsonStatesJsonGet200ResponseInner](docs/FileadminJsonStatesJsonGet200ResponseInner.md)
 - [SearchresultsGet200Response](docs/SearchresultsGet200Response.md)
 - [SearchresultsGet200ResponseFilters](docs/SearchresultsGet200ResponseFilters.md)
 - [SearchresultsGet200ResponseFiltersFieldsInner](docs/SearchresultsGet200ResponseFiltersFieldsInner.md)
 - [SearchresultsGet200ResponseFiltersFieldsInnerOptionsInner](docs/SearchresultsGet200ResponseFiltersFieldsInnerOptionsInner.md)
 - [SearchresultsGet200ResponseFiltersFieldsInnerSliderOptionsInner](docs/SearchresultsGet200ResponseFiltersFieldsInnerSliderOptionsInner.md)
 - [SearchresultsGet200ResponseMetaInfos](docs/SearchresultsGet200ResponseMetaInfos.md)
 - [SearchresultsGet200ResponseMetaInfosSearchArguments](docs/SearchresultsGet200ResponseMetaInfosSearchArguments.md)
 - [SearchresultsGet200ResponseResultsInner](docs/SearchresultsGet200ResponseResultsInner.md)
 - [SearchresultsGet200ResponseResultsInnerContent](docs/SearchresultsGet200ResponseResultsInnerContent.md)
 - [SearchresultsGet200ResponseResultsInnerContentItemsInner](docs/SearchresultsGet200ResponseResultsInnerContentItemsInner.md)
 - [SearchresultsGet200ResponseSortings](docs/SearchresultsGet200ResponseSortings.md)
 - [SearchresultsGet200ResponseSortingsFieldsInner](docs/SearchresultsGet200ResponseSortingsFieldsInner.md)
 - [SearchresultsGet200ResponseSortingsFieldsInnerOptionsInner](docs/SearchresultsGet200ResponseSortingsFieldsInnerOptionsInner.md)


## Documentation For Authorization

 All endpoints do not require authorization.

## Author

poststelle@bmg.bund.de


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



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/bundesAPI/klinikatlas-api",
    "name": "de-klinikatlas",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "OpenAPI, OpenAPI-Generator, klinikatlas, App, API",
    "author": "BundesAPI",
    "author_email": "kontakt@bund.dev",
    "download_url": "https://files.pythonhosted.org/packages/db/95/f0bca6a1e7ff7bfdc0486edb8ebdc88aa42c51333b32ab042dea75b4bcaa/de_klinikatlas-1.0.0.tar.gz",
    "platform": null,
    "description": "# klinikatlas\nDie API des Bundes-Klinik-Atlas stellt eine Vielzahl von Informationen \u00fcber deutsche Kliniken und deren Ausstattung bereit.\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: 1.0.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://bundes-klinik-atlas.de](https://bundes-klinik-atlas.de)\n\n## Requirements.\n\nPython >= 3.6\n\n## Installation & Usage\n### pip install\n\n```sh\npip install deutschland[klinikatlas]\n```\n\n### poetry install\n\n```sh\npoetry add deutschland -E klinikatlas\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 klinikatlas\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 klinikatlas\nfrom pprint import pprint\nfrom deutschland.klinikatlas.api import default_api\nfrom deutschland.klinikatlas.model.fileadmin_json_german_places_json_get200_response_inner import FileadminJsonGermanPlacesJsonGet200ResponseInner\nfrom deutschland.klinikatlas.model.fileadmin_json_german_states_json_get200_response_inner import FileadminJsonGermanStatesJsonGet200ResponseInner\nfrom deutschland.klinikatlas.model.fileadmin_json_icd_codes_json_get200_response_inner import FileadminJsonIcdCodesJsonGet200ResponseInner\nfrom deutschland.klinikatlas.model.fileadmin_json_locations_json_get200_response_inner import FileadminJsonLocationsJsonGet200ResponseInner\nfrom deutschland.klinikatlas.model.fileadmin_json_ops_codes_json_get200_response_inner import FileadminJsonOpsCodesJsonGet200ResponseInner\nfrom deutschland.klinikatlas.model.fileadmin_json_states_json_get200_response_inner import FileadminJsonStatesJsonGet200ResponseInner\nfrom deutschland.klinikatlas.model.searchresults_get200_response import SearchresultsGet200Response\n# Defining the host is optional and defaults to https://bundes-klinik-atlas.de\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = klinikatlas.Configuration(\n    host = \"https://bundes-klinik-atlas.de\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith klinikatlas.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = default_api.DefaultApi(api_client)\n\n    try:\n        # Liste deutscher Orte abrufen\n        api_response = api_instance.fileadmin_json_german_places_json_get()\n        pprint(api_response)\n    except klinikatlas.ApiException as e:\n        print(\"Exception when calling DefaultApi->fileadmin_json_german_places_json_get: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://bundes-klinik-atlas.de*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**fileadmin_json_german_places_json_get**](docs/DefaultApi.md#fileadmin_json_german_places_json_get) | **GET** /fileadmin/json/german-places.json | Liste deutscher Orte abrufen\n*DefaultApi* | [**fileadmin_json_german_states_json_get**](docs/DefaultApi.md#fileadmin_json_german_states_json_get) | **GET** /fileadmin/json/german-states.json | Liste deutscher Bundesl\u00e4nder mit Koordinaten abrufen\n*DefaultApi* | [**fileadmin_json_icd_codes_json_get**](docs/DefaultApi.md#fileadmin_json_icd_codes_json_get) | **GET** /fileadmin/json/icd_codes.json | Liste der ICD-Codes abrufen\n*DefaultApi* | [**fileadmin_json_locations_json_get**](docs/DefaultApi.md#fileadmin_json_locations_json_get) | **GET** /fileadmin/json/locations.json | Liste deutscher Kliniken abrufen\n*DefaultApi* | [**fileadmin_json_ops_codes_json_get**](docs/DefaultApi.md#fileadmin_json_ops_codes_json_get) | **GET** /fileadmin/json/ops_codes.json | Liste der OPS-Codes abrufen\n*DefaultApi* | [**fileadmin_json_states_json_get**](docs/DefaultApi.md#fileadmin_json_states_json_get) | **GET** /fileadmin/json/states.json | Liste deutscher Bundesl\u00e4nder abrufen\n*DefaultApi* | [**krankenhaussuche_krankenhaus_id_get**](docs/DefaultApi.md#krankenhaussuche_krankenhaus_id_get) | **GET** /krankenhaussuche/krankenhaus/{id}/ | Details zu einem spezifischen Krankenhaus abrufen\n*DefaultApi* | [**searchresults_get**](docs/DefaultApi.md#searchresults_get) | **GET** /searchresults/ | Suche nach Krankenh\u00e4usern basierend auf spezifischen Kriterien\n\n\n## Documentation For Models\n\n - [FileadminJsonGermanPlacesJsonGet200ResponseInner](docs/FileadminJsonGermanPlacesJsonGet200ResponseInner.md)\n - [FileadminJsonGermanStatesJsonGet200ResponseInner](docs/FileadminJsonGermanStatesJsonGet200ResponseInner.md)\n - [FileadminJsonIcdCodesJsonGet200ResponseInner](docs/FileadminJsonIcdCodesJsonGet200ResponseInner.md)\n - [FileadminJsonLocationsJsonGet200ResponseInner](docs/FileadminJsonLocationsJsonGet200ResponseInner.md)\n - [FileadminJsonOpsCodesJsonGet200ResponseInner](docs/FileadminJsonOpsCodesJsonGet200ResponseInner.md)\n - [FileadminJsonStatesJsonGet200ResponseInner](docs/FileadminJsonStatesJsonGet200ResponseInner.md)\n - [SearchresultsGet200Response](docs/SearchresultsGet200Response.md)\n - [SearchresultsGet200ResponseFilters](docs/SearchresultsGet200ResponseFilters.md)\n - [SearchresultsGet200ResponseFiltersFieldsInner](docs/SearchresultsGet200ResponseFiltersFieldsInner.md)\n - [SearchresultsGet200ResponseFiltersFieldsInnerOptionsInner](docs/SearchresultsGet200ResponseFiltersFieldsInnerOptionsInner.md)\n - [SearchresultsGet200ResponseFiltersFieldsInnerSliderOptionsInner](docs/SearchresultsGet200ResponseFiltersFieldsInnerSliderOptionsInner.md)\n - [SearchresultsGet200ResponseMetaInfos](docs/SearchresultsGet200ResponseMetaInfos.md)\n - [SearchresultsGet200ResponseMetaInfosSearchArguments](docs/SearchresultsGet200ResponseMetaInfosSearchArguments.md)\n - [SearchresultsGet200ResponseResultsInner](docs/SearchresultsGet200ResponseResultsInner.md)\n - [SearchresultsGet200ResponseResultsInnerContent](docs/SearchresultsGet200ResponseResultsInnerContent.md)\n - [SearchresultsGet200ResponseResultsInnerContentItemsInner](docs/SearchresultsGet200ResponseResultsInnerContentItemsInner.md)\n - [SearchresultsGet200ResponseSortings](docs/SearchresultsGet200ResponseSortings.md)\n - [SearchresultsGet200ResponseSortingsFieldsInner](docs/SearchresultsGet200ResponseSortingsFieldsInner.md)\n - [SearchresultsGet200ResponseSortingsFieldsInnerOptionsInner](docs/SearchresultsGet200ResponseSortingsFieldsInnerOptionsInner.md)\n\n\n## Documentation For Authorization\n\n All endpoints do not require authorization.\n\n## Author\n\npoststelle@bmg.bund.de\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in klinikatlas.apis and klinikatlas.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.klinikatlas.api.default_api import DefaultApi`\n- `from deutschland.klinikatlas.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 klinikatlas\nfrom deutschland.klinikatlas.apis import *\nfrom deutschland.klinikatlas.models import *\n```\n\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Bundes-Klinik-Atlas API",
    "version": "1.0.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/bundesAPI/klinikatlas-api/issues",
        "Homepage": "https://github.com/bundesAPI/klinikatlas-api"
    },
    "split_keywords": [
        "openapi",
        " openapi-generator",
        " klinikatlas",
        " app",
        " api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6e67251dd95dac5daab1998d03e429dd34d909e0b710f59f69ff7b064d3104a8",
                "md5": "4c6e2fb0eb12c97a76497357f2420772",
                "sha256": "a1bff16a2496ec7b32a24cd65fe6df07b369364798c211fd6b2a7cd8ca6b2f77"
            },
            "downloads": -1,
            "filename": "de_klinikatlas-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4c6e2fb0eb12c97a76497357f2420772",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 95964,
            "upload_time": "2024-05-31T14:26:11",
            "upload_time_iso_8601": "2024-05-31T14:26:11.930641Z",
            "url": "https://files.pythonhosted.org/packages/6e/67/251dd95dac5daab1998d03e429dd34d909e0b710f59f69ff7b064d3104a8/de_klinikatlas-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "db95f0bca6a1e7ff7bfdc0486edb8ebdc88aa42c51333b32ab042dea75b4bcaa",
                "md5": "52c2e3e342da258d792ac217e46a93a1",
                "sha256": "379d1e79a461171bfdaa2e6adc95703dd4d2f39e7da8ded7af3f92fea8d22e35"
            },
            "downloads": -1,
            "filename": "de_klinikatlas-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "52c2e3e342da258d792ac217e46a93a1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 47388,
            "upload_time": "2024-05-31T14:26:13",
            "upload_time_iso_8601": "2024-05-31T14:26:13.413247Z",
            "url": "https://files.pythonhosted.org/packages/db/95/f0bca6a1e7ff7bfdc0486edb8ebdc88aa42c51333b32ab042dea75b4bcaa/de_klinikatlas-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-31 14:26:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bundesAPI",
    "github_project": "klinikatlas-api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "de-klinikatlas"
}
        
Elapsed time: 0.34326s