about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs/ApiGetAuthUnitPropertyApi.md
blob: 35b994ba69693eb861b78fbdf9419dff09b975a3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<!--
rocie - An enterprise grocery management system

Copyright (C) 2026 Benedikt Peetz <benedikt.peetz@b-peetz.de>
SPDX-License-Identifier: GPL-3.0-or-later

This file is part of Rocie.

You should have received a copy of the License along with this program.
If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>.
-->

# \\ApiGetAuthUnitPropertyApi

All URIs are relative to _http://localhost_

| Method                                                                      | HTTP request                | Description                           |
| --------------------------------------------------------------------------- | --------------------------- | ------------------------------------- |
| [**unit_properties**](ApiGetAuthUnitPropertyApi.md#unit_properties)         | **GET** /unit-properties/   | Return all registered unit properties |
| [**unit_property_by_id**](ApiGetAuthUnitPropertyApi.md#unit_property_by_id) | **GET** /unit-property/{id} | Get Unit property by id               |

## unit_properties

> Vec<models::UnitProperty> unit_properties() Return all registered unit
> properties

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::UnitProperty>**](UnitProperty.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)

## unit_property_by_id

> models::UnitProperty unit_property_by_id(id) Get Unit property by id

### Parameters

| Name   | Type                      | Description      | Required   | Notes |
| ------ | ------------------------- | ---------------- | ---------- | ----- |
| **id** | [**UnitPropertyId**](.md) | Unit Property id | [required] |

### Return type

[**models::UnitProperty**](UnitProperty.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)