de-bewerberboerse


Namede-bewerberboerse JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/bundesAPI/bewerberboerse-api
SummaryArbeitsagentur Bewerberbörse API
upload_time2023-01-15 10:57:30
maintainer
docs_urlNone
authorBundesAPI
requires_python>=3.6
licenseApache-2.0
keywords openapi openapi-generator bewerberboerse app api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Bewerberboerse

Eine der größten Datenbanken für Bewerbende in Deutschland durchsuchen. 

Die Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials können dafür verwendet werden:

**ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e

**ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003

**Achtung**: der generierte Token muss bei folgenden GET-requests an https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service/pc/v1/bewerber im header als 'OAuthAccessToken' inkludiert werden.


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
For more information, please visit [https://github.com/AndreasFischer1985/bewerberboerse-api](https://github.com/AndreasFischer1985/bewerberboerse-api)

## Requirements.

Python >= 3.6

## Installation & Usage
### pip install

```sh
pip install deutschland[Bewerberboerse]
```

### poetry install

```sh
poetry add deutschland -E Bewerberboerse
```

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

## Getting Started

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

```python

import time
from deutschland import Bewerberboerse
from pprint import pprint
from deutschland.Bewerberboerse.api import default_api
# Defining the host is optional and defaults to https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service
# See configuration.py for a list of all supported configuration parameters.
configuration = Bewerberboerse.Configuration(
    host = "https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service"
)



# Enter a context with an instance of the API client
with Bewerberboerse.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    was = "Wissenschaftlicher Mitarbeiter" # str | Beruf, Kenntnisse, Sprachen, etc. (optional)
    ausbildungsart = "au" # str | Ausbildungsart - au=Ausbildung, dsa=Duales Studium (ausbildungsintegrierend), dsp=Duales Studium (praxisintegrierend). (optional)
    wo = "Feucht" # str | Ort, PLZ, Bundesland, Land, etc. (optional)
    umkreis = 0 # int | Umkreis - 0=ganzer Ort; 10=10km; 15=15km; 20=20km; 50=50km; 100=100km; 200=200km. (optional)
    angebotsart = "ar" # str | Angebotsart - ar=Arbeitskräfte; au=Auszubildende/Duales Studium; pt=Praktikanten/Trainees; se=Selbstständige. (optional)
    arbeitszeit = "vz" # str | Arbeitszeit - vz=Vollzeit; tz=Teilzeit; snw=Schicht,Nacht,Wochenende; ht=Heim-/Telearbeit; mj=Minijob. (optional)
    berufserfahrung = "mb" # str | Berufserfahrung - be=Berufseinsteiger*innen; mb=Mit Berufserfahrung. (optional)
    vertragsart = "ub" # str | Vertragsart - be=Befristet; ub=Unbefristet. (optional)
    behinderung = "an" # str | Behinderung - an=Nur Schwerbehinderte oder ihnen gleichgestellte Bewerber*innen anzeigen. (optional) (default to "an")
    page = 0 # int | Ergebnissseite (optional)
    size = 25 # int | Anzahl von Ergebnissen (optional)

    try:
        # Bewerberbörse
        api_response = api_instance.bewerberboerse(was=was, ausbildungsart=ausbildungsart, wo=wo, umkreis=umkreis, angebotsart=angebotsart, arbeitszeit=arbeitszeit, berufserfahrung=berufserfahrung, vertragsart=vertragsart, behinderung=behinderung, page=page, size=size)
        pprint(api_response)
    except Bewerberboerse.ApiException as e:
        print("Exception when calling DefaultApi->bewerberboerse: %s\n" % e)
```

## Documentation for API Endpoints

All URIs are relative to *https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**bewerberboerse**](docs/DefaultApi.md#bewerberboerse) | **GET** /pc/v1/bewerber | Bewerberbörse
*DefaultApi* | [**bewerberdetails**](docs/DefaultApi.md#bewerberdetails) | **GET** /pc/v1/bewerberdetails/{referenznummer} | 


## Documentation For Models



## Documentation For Authorization


## clientCredAuth

- **Type**: OAuth
- **Flow**: application
- **Authorization URL**: 
- **Scopes**: N/A


## Author

andreasfischer1985@web.de


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



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/bundesAPI/bewerberboerse-api",
    "name": "de-bewerberboerse",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "OpenAPI,OpenAPI-Generator,Bewerberboerse,App,API",
    "author": "BundesAPI",
    "author_email": "kontakt@bund.dev",
    "download_url": "https://files.pythonhosted.org/packages/40/21/10bbcbd04c8aa3148aa0611f2178c156c4fe27f31395169182b4ea54a676/de_bewerberboerse-0.1.0.tar.gz",
    "platform": null,
    "description": "# Bewerberboerse\n\nEine der gr\u00f6\u00dften Datenbanken f\u00fcr Bewerbende in Deutschland durchsuchen. \n\nDie Authentifizierung funktioniert per OAuth 2 Client Credentials mit JWTs. Folgende Client-Credentials k\u00f6nnen daf\u00fcr verwendet werden:\n\n**ClientID:** 919b0af7-6e5f-4542-a7f5-04268b8bae2e\n\n**ClientSecret:** 93fce94c-5be2-4dc8-b040-c62818a4b003\n\n**Achtung**: der generierte Token muss bei folgenden GET-requests an https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service/pc/v1/bewerber im header als 'OAuthAccessToken' inkludiert werden.\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\nFor more information, please visit [https://github.com/AndreasFischer1985/bewerberboerse-api](https://github.com/AndreasFischer1985/bewerberboerse-api)\n\n## Requirements.\n\nPython >= 3.6\n\n## Installation & Usage\n### pip install\n\n```sh\npip install deutschland[Bewerberboerse]\n```\n\n### poetry install\n\n```sh\npoetry add deutschland -E Bewerberboerse\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 Bewerberboerse\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 Bewerberboerse\nfrom pprint import pprint\nfrom deutschland.Bewerberboerse.api import default_api\n# Defining the host is optional and defaults to https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = Bewerberboerse.Configuration(\n    host = \"https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith Bewerberboerse.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = default_api.DefaultApi(api_client)\n    was = \"Wissenschaftlicher Mitarbeiter\" # str | Beruf, Kenntnisse, Sprachen, etc. (optional)\n    ausbildungsart = \"au\" # str | Ausbildungsart - au=Ausbildung, dsa=Duales Studium (ausbildungsintegrierend), dsp=Duales Studium (praxisintegrierend). (optional)\n    wo = \"Feucht\" # str | Ort, PLZ, Bundesland, Land, etc. (optional)\n    umkreis = 0 # int | Umkreis - 0=ganzer Ort; 10=10km; 15=15km; 20=20km; 50=50km; 100=100km; 200=200km. (optional)\n    angebotsart = \"ar\" # str | Angebotsart - ar=Arbeitskr\u00e4fte; au=Auszubildende/Duales Studium; pt=Praktikanten/Trainees; se=Selbstst\u00e4ndige. (optional)\n    arbeitszeit = \"vz\" # str | Arbeitszeit - vz=Vollzeit; tz=Teilzeit; snw=Schicht,Nacht,Wochenende; ht=Heim-/Telearbeit; mj=Minijob. (optional)\n    berufserfahrung = \"mb\" # str | Berufserfahrung - be=Berufseinsteiger*innen; mb=Mit Berufserfahrung. (optional)\n    vertragsart = \"ub\" # str | Vertragsart - be=Befristet; ub=Unbefristet. (optional)\n    behinderung = \"an\" # str | Behinderung - an=Nur Schwerbehinderte oder ihnen gleichgestellte Bewerber*innen anzeigen. (optional) (default to \"an\")\n    page = 0 # int | Ergebnissseite (optional)\n    size = 25 # int | Anzahl von Ergebnissen (optional)\n\n    try:\n        # Bewerberb\u00f6rse\n        api_response = api_instance.bewerberboerse(was=was, ausbildungsart=ausbildungsart, wo=wo, umkreis=umkreis, angebotsart=angebotsart, arbeitszeit=arbeitszeit, berufserfahrung=berufserfahrung, vertragsart=vertragsart, behinderung=behinderung, page=page, size=size)\n        pprint(api_response)\n    except Bewerberboerse.ApiException as e:\n        print(\"Exception when calling DefaultApi->bewerberboerse: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://rest.arbeitsagentur.de/jobboerse/bewerbersuche-service*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**bewerberboerse**](docs/DefaultApi.md#bewerberboerse) | **GET** /pc/v1/bewerber | Bewerberb\u00f6rse\n*DefaultApi* | [**bewerberdetails**](docs/DefaultApi.md#bewerberdetails) | **GET** /pc/v1/bewerberdetails/{referenznummer} | \n\n\n## Documentation For Models\n\n\n\n## Documentation For Authorization\n\n\n## clientCredAuth\n\n- **Type**: OAuth\n- **Flow**: application\n- **Authorization URL**: \n- **Scopes**: N/A\n\n\n## Author\n\nandreasfischer1985@web.de\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in Bewerberboerse.apis and Bewerberboerse.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.Bewerberboerse.api.default_api import DefaultApi`\n- `from deutschland.Bewerberboerse.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 Bewerberboerse\nfrom deutschland.Bewerberboerse.apis import *\nfrom deutschland.Bewerberboerse.models import *\n```\n\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Arbeitsagentur Bewerberb\u00f6rse API",
    "version": "0.1.0",
    "split_keywords": [
        "openapi",
        "openapi-generator",
        "bewerberboerse",
        "app",
        "api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "08a5eecfc86c8cbe3864f466b3347ad9306c658f9ea6ab54fd57947d1b2f0937",
                "md5": "4e7b71de5ee7cb9f31e8048592361230",
                "sha256": "60a971d8dc4ce2b7df9901d094e1516bc2a28d59fd8f22c8cfa12efc64846cd0"
            },
            "downloads": -1,
            "filename": "de_bewerberboerse-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4e7b71de5ee7cb9f31e8048592361230",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 44942,
            "upload_time": "2023-01-15T10:57:28",
            "upload_time_iso_8601": "2023-01-15T10:57:28.748125Z",
            "url": "https://files.pythonhosted.org/packages/08/a5/eecfc86c8cbe3864f466b3347ad9306c658f9ea6ab54fd57947d1b2f0937/de_bewerberboerse-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "402110bbcbd04c8aa3148aa0611f2178c156c4fe27f31395169182b4ea54a676",
                "md5": "4ca39f5231bc9181382eefa0b2e02e5f",
                "sha256": "40aba4f2898f6a25ffbbef6a8eb1ddef4c749a5ea3223103229a97b4c8a574d7"
            },
            "downloads": -1,
            "filename": "de_bewerberboerse-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4ca39f5231bc9181382eefa0b2e02e5f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 40953,
            "upload_time": "2023-01-15T10:57:30",
            "upload_time_iso_8601": "2023-01-15T10:57:30.377238Z",
            "url": "https://files.pythonhosted.org/packages/40/21/10bbcbd04c8aa3148aa0611f2178c156c4fe27f31395169182b4ea54a676/de_bewerberboerse-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-15 10:57:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "bundesAPI",
    "github_project": "bewerberboerse-api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "de-bewerberboerse"
}
        
Elapsed time: 0.05891s