You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

235 lines
5.6 KiB
Markdown

# swagger_client.SchuelerApi
All URIs are relative to */*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_schueler**](SchuelerApi.md#create_schueler) | **POST** /schueler |
[**delete_schueler**](SchuelerApi.md#delete_schueler) | **DELETE** /schueler/{id} |
[**get_schueler**](SchuelerApi.md#get_schueler) | **GET** /schueler/{id} |
[**get_schuelers**](SchuelerApi.md#get_schuelers) | **GET** /schueler |
[**update_schueler**](SchuelerApi.md#update_schueler) | **PUT** /schueler/{id} |
# **create_schueler**
> Schueler create_schueler(body)
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.SchuelerApi()
body = swagger_client.SchuelerCreatePayload() # SchuelerCreatePayload |
try:
api_response = api_instance.create_schueler(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SchuelerApi->create_schueler: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**SchuelerCreatePayload**](SchuelerCreatePayload.md)| |
### Return type
[**Schueler**](Schueler.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **delete_schueler**
> delete_schueler(id)
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.SchuelerApi()
id = 56 # int |
try:
api_instance.delete_schueler(id)
except ApiException as e:
print("Exception when calling SchuelerApi->delete_schueler: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| |
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_schueler**
> Schueler get_schueler(id)
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.SchuelerApi()
id = 56 # int |
try:
api_response = api_instance.get_schueler(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SchuelerApi->get_schueler: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| |
### Return type
[**Schueler**](Schueler.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_schuelers**
> Schuelers get_schuelers()
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.SchuelerApi()
try:
api_response = api_instance.get_schuelers()
pprint(api_response)
except ApiException as e:
print("Exception when calling SchuelerApi->get_schuelers: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**Schuelers**](Schuelers.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **update_schueler**
> Schueler update_schueler(body, id)
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.SchuelerApi()
body = swagger_client.SchuelerUpdatePayload() # SchuelerUpdatePayload |
id = 56 # int |
try:
api_response = api_instance.update_schueler(body, id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SchuelerApi->update_schueler: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**SchuelerUpdatePayload**](SchuelerUpdatePayload.md)| |
**id** | **int**| |
### Return type
[**Schueler**](Schueler.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)