about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs/ApiGetAuthUnitApi.md
blob: 8ad20c4c1a618b24a35ecf54b48622e063db1e29 (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<!--
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>.
-->

# \\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)