diff options
Diffstat (limited to 'crates/rocie-client/docs/ApiGetAuthUnitApi.md')
| -rw-r--r-- | crates/rocie-client/docs/ApiGetAuthUnitApi.md | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/crates/rocie-client/docs/ApiGetAuthUnitApi.md b/crates/rocie-client/docs/ApiGetAuthUnitApi.md new file mode 100644 index 0000000..3f2b02f --- /dev/null +++ b/crates/rocie-client/docs/ApiGetAuthUnitApi.md @@ -0,0 +1,92 @@ +# \ApiGetAuthUnitApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**unit_by_id**](ApiGetAuthUnitApi.md#unit_by_id) | **GET** /unit/{id} | Get Unit by id +[**units**](ApiGetAuthUnitApi.md#units) | **GET** /units/ | Return all registered units +[**units_by_property_id**](ApiGetAuthUnitApi.md#units_by_property_id) | **GET** /units-by-property/{id} | Return all registered units for a specific unit property + + + +## unit_by_id + +> models::Unit unit_by_id(id) +Get Unit by id + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**id** | [**UnitId**](.md) | Unit id | [required] | + +### Return type + +[**models::Unit**](Unit.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[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) + + +## units + +> Vec<models::Unit> units() +Return all registered units + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Vec<models::Unit>**](Unit.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[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) + + +## units_by_property_id + +> Vec<models::Unit> units_by_property_id(id) +Return all registered units for a specific unit property + +### Parameters + + +Name | Type | Description | Required | Notes +------------- | ------------- | ------------- | ------------- | ------------- +**id** | [**UnitPropertyId**](.md) | Unit property id | [required] | + +### Return type + +[**Vec<models::Unit>**](Unit.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, text/plain + +[[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) + |
