76 lines
2.0 KiB
Markdown
76 lines
2.0 KiB
Markdown
# board_mate.client.ClientApi
|
|
|
|
All URIs are relative to *https://boardmate_api*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**create**](ClientApi.md#create) | **POST** /client/create | POST client/create
|
|
|
|
|
|
# **create**
|
|
> ResponseBodyString create(client_dto)
|
|
|
|
POST client/create
|
|
|
|
### Example
|
|
|
|
```python
|
|
import time
|
|
import os
|
|
import board_mate.client
|
|
from board_mate.client.models.client_dto import ClientDto
|
|
from board_mate.client.models.response_body_string import ResponseBodyString
|
|
from board_mate.client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Defining the host is optional and defaults to https://boardmate_api
|
|
# See configuration.py for a list of all supported configuration parameters.
|
|
configuration = board_mate.client.Configuration(
|
|
host = "https://boardmate_api"
|
|
)
|
|
|
|
|
|
# Enter a context with an instance of the API client
|
|
with board_mate.client.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = board_mate.client.ClientApi(api_client)
|
|
client_dto = board_mate.client.ClientDto() # ClientDto |
|
|
|
|
try:
|
|
# POST client/create
|
|
api_response = api_instance.create(client_dto)
|
|
print("The response of ClientApi->create:\n")
|
|
pprint(api_response)
|
|
except Exception as e:
|
|
print("Exception when calling ClientApi->create: %s\n" % e)
|
|
```
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**client_dto** | [**ClientDto**](ClientDto.md)| |
|
|
|
|
### Return type
|
|
|
|
[**ResponseBodyString**](ResponseBodyString.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: */*
|
|
|
|
### HTTP response details
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
**200** | OK | - |
|
|
|
|
[[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)
|
|
|