Newer
Older
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# {{classname}}
All URIs are relative to *https://localhost/sandboxname/sandboxname/amsi/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**RegistereddevicesByIdDELETE**](RegDevApi.md#RegistereddevicesByIdDELETE) | **Delete** /registered_devices/{registeredDeviceId} | Deregister a device - see clause 5.2.6.
[**RegistereddevicesByIdGET**](RegDevApi.md#RegistereddevicesByIdGET) | **Get** /registered_devices/{registeredDeviceId} | Retrieve information about a device - see clause 5.2.4.
[**RegistereddevicesByIdPUT**](RegDevApi.md#RegistereddevicesByIdPUT) | **Put** /registered_devices/{registeredDeviceId} | Update information about a device including its association to a valid traffic rule - see clauses 5.2.5 and 5.4.3.
[**RegistereddevicesGET**](RegDevApi.md#RegistereddevicesGET) | **Get** /registered_devices | Retrieve information about all devices with a valid traffic rule association - see clause 5.2.2.
[**RegistereddevicesPOST**](RegDevApi.md#RegistereddevicesPOST) | **Post** /registered_devices | Register a new device - see clause 5.2.3.
# **RegistereddevicesByIdDELETE**
> RegistereddevicesByIdDELETE(ctx, registeredDeviceId)
Deregister a device - see clause 5.2.6.
The DELETE method may be used by a service consumer to deregister a device. This method is typically used in the \"device deregistration\" procedure as described in clause 5.2.6.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**registeredDeviceId** | **string**| The unique identifier of the registered device. |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/problem+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)
# **RegistereddevicesByIdGET**
> RegisteredDevicesBody RegistereddevicesByIdGET(ctx, registeredDeviceId)
Retrieve information about a device - see clause 5.2.4.
The GET method may be used by a service consumer to retrieve information about a device. This method is typically used in the \"device registration query\" procedure as described in clause 5.2.4.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**registeredDeviceId** | **string**| The unique identifier of the registered device. |
### Return type
[**RegisteredDevicesBody**](registered_devices_body.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+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)
# **RegistereddevicesByIdPUT**
> RegisteredDevicesRegisteredDeviceIdBody RegistereddevicesByIdPUT(ctx, body, registeredDeviceId)
Update information about a device including its association to a valid traffic rule - see clauses 5.2.5 and 5.4.3.
The PUT method may be used by a service consumer to update a device registration including its association to a valid traffic rule. This method is typically used in the \"device registration update\" procedure as described in clause 5.2.5 and in the \"user transport assignment\" procedure as described in clause 5.4.3.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**body** | [**RegisteredDevicesRegisteredDeviceIdBody**](RegisteredDevicesRegisteredDeviceIdBody.md)| One or more updated attributes that are allowed to be changed are included in the DeviceInfo data structure in the payload body of the request. . |
**registeredDeviceId** | **string**| The unique identifier of the registered device. |
### Return type
[**RegisteredDevicesRegisteredDeviceIdBody**](registered_devices_registeredDeviceId_body.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, application/problem+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)
# **RegistereddevicesGET**
> InlineResponse200 RegistereddevicesGET(ctx, optional)
Retrieve information about all devices with a valid traffic rule association - see clause 5.2.2.
The GET method may be used by a service consumer to retrieve information about all devices with a valid traffic rule association. This method is typically used in the \"registered devices query\" procedure as described in clause 5.2.2.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**optional** | ***RegDevApiRegistereddevicesGETOpts** | optional parameters | nil if no parameters
### Optional Parameters
Optional parameters are passed through a pointer to a RegDevApiRegistereddevicesGETOpts struct
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter** | **optional.String**| Attribute-based filtering parameters according to ETSI GS MEC 009 [i.1]. The API producer shall support receiving the following filtering parameters as part of the URI query string: \"(eq,enabled,TRUE)\". |
**fields** | [**optional.Interface of []string**](string.md)| The list may contain one or more of the following attributes from the DeviceInfo data type: - deviceMetadata - gpsi - msisdn - deviceId - requestedMecTrafficRule - requestedIotPlatformId - requestedUserTransportId |
### Return type
[**InlineResponse200**](inline_response_200.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+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)
# **RegistereddevicesPOST**
> RegisteredDevicesBody RegistereddevicesPOST(ctx, body)
Register a new device - see clause 5.2.3.
The POST method may be used by a service consumer to register a new device. This method is typically used in the \"device registration\" procedure as described in clause 5.2.3.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**body** | [**RegisteredDevicesBody**](RegisteredDevicesBody.md)| Payload body in the request contains the information associated to the IoT device to be registered. |
### Return type
[**RegisteredDevicesBody**](registered_devices_body.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, application/problem+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)