SOL002SOL003_resp.yaml 19.9 KB
Newer Older
1
2
3
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

4
responses:
5
  206:
6
    description: >
7
      206 PARTIAL CONTENT
8
    headers:
9
10
11
12
13
14
15
16
17
      Content-Type:
        description: >
          The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      Content-Range:
        description: >
          The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
18
        type: string
19
20
        maximum: 1
        minimum: 1
21
22
23
24
25
26
27
28
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
29
      Version:
30
31
        description: >
          Version of the API used in the response.
32
33
34
        type: string
        maximum: 1
        minimum: 1
35
36
    schema:
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Gergely Csatari's avatar
Gergely Csatari committed
37

38
  303:
39
40
41
42
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
43
44
45
46
47
48
49
50
51
52
        maximum: 1
        minimum: 1
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
53
      Version:
54
55
        description: >
          Version of the API used in the response.
56
57
58
        type: string
        maximum: 1
        minimum: 1
59

60
61
  400:
    description: >
62
63
64
65
66
67
68
69
70
71
72
73
74
      400 BAD REQUEST

      400 code can be returned in the following specified cases, the specific cause has to be proper specified in the
      "ProblemDetails" structure to be returned.

      If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect
      query parameters or the payload body contains a syntactically incorrect data structure),
      the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided,
      and should include in the "detail" attribute more information about the source of the problem.

      If the response to a GET request which queries a container resource would be so big that the performance
      of the API producer is adversely affected, and the API producer does not support paging for the affected resource,
      it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include
Giacomo Bernini's avatar
Giacomo Bernini committed
75
      in the "detail" attribute more information about the source of the problem.
76
77
78
79
80
81
82
83
84
85
86
87

      If there is an application error related to the client's input that cannot be easily mapped to any other
      HTTP response code ("catch all error"), the API producer shall respond with this response code.
      The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information
      about the source of the problem.

      If the request contains a malformed access token, the API producer should respond with this response.
      The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750
      and IETF RFC 7235. The ProblemDetails structure may be provided.

      The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0
      for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.
88
89
90
91
92
93
94
95
96
97
98
99
100
101
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
102
      Version:
103
104
        description: >
          Version of the API used in the response.
105
106
107
        type: string
        maximum: 1
        minimum: 1
108
    schema:
109
110
111
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

  401:
112
    description: >
113
114
115
116
117
118
      401 UNAUTHORIZED

      If the request contains no access token even though one is required, or if the request contains an authorization
      token that is invalid (e.g. expired or revoked), the API producer should respond with this response.
      The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750
      and IETF RFC 7235. The ProblemDetails structure may be provided.
119
120
121
122
123
124
125
126
127
128
129
130
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
131
132
        maximum: 1
        minimum: 0
133
      Version:
134
135
        description: >
          Version of the API used in the response.
136
137
138
        type: string
        maximum: 1
        minimum: 1
139
    schema:
140
141
142
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

  403:
143
    description: >
144
145
146
147
148
149
      403 FORBIDDEN

      If the API consumer is not allowed to perform a particular request to a particular resource,
      the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided.
      It should include in the "detail" attribute information about the source of the problem,
      and may indicate how to solve it.
150
151
152
153
154
155
156
157
158
159
160
161
162
163
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
164
      Version:
165
166
        description: >
          Version of the API used in the response.
167
168
169
        type: string
        maximum: 1
        minimum: 1
170
    schema:
171
172
173
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

  404:
174
    description: >
175
176
177
178
179
180
181
182
183
184
185
      404 NOT FOUND

      If the API producer did not find a current representation for the resource addressed by the URI passed
      in the request or is not willing to disclose that one exists, it shall respond with this response code.
      The "ProblemDetails" structure may be provided, including in the "detail" attribute information about
      the source of the problem, e.g. a wrong resource URI variable.

      This response code is not appropriate in case the resource addressed by the URI is a container resource
      which is designed to contain child resources, but does not contain any child resource at the time
      the request is received. For a GET request to an existing empty container resource, a typical response
      contains a 200 OK response code and a payload body with an empty array.
186
187
188
189
190
191
192
193
194
195
196
197
198
199
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
200
      Version:
201
202
        description: >
          Version of the API used in the response.
203
204
205
        type: string
        maximum: 1
        minimum: 1
206
    schema:
207
208
209
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

  405:
210
    description: >
211
      405 METHOD NOT ALLOWED
Gergely Csatari's avatar
Gergely Csatari committed
212

213
214
      If a particular HTTP method is not supported for a particular resource, the API producer shall respond
      with this response code. The "ProblemDetails" structure may be omitted.
215
216
217
218
219
220
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
221
222
223
224
225
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
226
227
        type: string
        maximum: 1
228
        minimum: 0
229
      Version:
230
231
        description: >
          Version of the API used in the response.
232
233
234
        type: string
        maximum: 1
        minimum: 1
235
    schema:
236
237
238
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

  406:
239
240
241
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
242
243
        type: string
        maximum: 1
244
        minimum: 1
245
246
247
248
249
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
250
251
        type: string
        maximum: 1
252
        minimum: 0
253
      Version:
254
255
        description: >
          Version of the API used in the response.
256
257
258
        type: string
        maximum: 1
        minimum: 1
259
    schema:
260
261
262
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

  409:
263
264
265
266
267
268
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
269
270
271
272
273
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
274
275
        type: string
        maximum: 1
276
        minimum: 0
277
      Version:
278
279
        description: >
          Version of the API used in the response.
280
281
282
        type: string
        maximum: 1
        minimum: 1
283
284
    schema:
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Gergely Csatari's avatar
Gergely Csatari committed
285

286
  412:
287
    description: >
288
      412 PRECONDITION FAILED
Gergely Csatari's avatar
Gergely Csatari committed
289

290
291
292
293
      Error: A precondition given in an HTTP request header is not fulfilled.
      Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity.
      The response body should contain a ProblemDetails structure, in which the "detail" attribute should convey
      more information about the error.
294
295
296
297
298
299
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
300
301
302
303
304
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
305
306
        type: string
        maximum: 1
307
        minimum: 0
308
      Version:
309
310
        description: >
          Version of the API used in the response.
311
312
313
        type: string
        maximum: 1
        minimum: 1
314
    schema:
315
316
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

Giacomo Bernini's avatar
Giacomo Bernini committed
317
318
  413:
    description: >
319
      413 PAYLOAD TOO LARGE
Giacomo Bernini's avatar
Giacomo Bernini committed
320

321
322
323
      If the payload body of a request is larger than the amount of data the API producer is willing or able to process,
      it shall respond with this response code, following the provisions in IETF RFC 7231 for the use
      of the "Retry-After" HTTP header and for closing the connection. The "ProblemDetails" structure may be omitted.
Giacomo Bernini's avatar
Giacomo Bernini committed
324
325
326
327
328
329
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
330
331
332
333
334
335
336
337
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
338
      Version:
339
340
        description: >
          Version of the API used in the response.
341
342
343
        type: string
        maximum: 1
        minimum: 1
Giacomo Bernini's avatar
Giacomo Bernini committed
344
    schema:
345
346
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

Giacomo Bernini's avatar
Giacomo Bernini committed
347
348
  414:
    description: >
349
      414 URI TOO LONG
Giacomo Bernini's avatar
Giacomo Bernini committed
350

351
352
353
      If the request URI of a request is longer than the API producer is willing or able to process,
      it shall respond with this response code. This condition can e.g. be caused by passing long queries
      in the request URI of a GET request. The "ProblemDetails" structure may be omitted.
Giacomo Bernini's avatar
Giacomo Bernini committed
354
355
356
357
358
359
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
360
361
362
363
364
365
366
367
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
368
      Version:
369
370
        description: >
          Version of the API used in the response.
371
372
373
        type: string
        maximum: 1
        minimum: 1
Giacomo Bernini's avatar
Giacomo Bernini committed
374
    schema:
375
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Giacomo Bernini's avatar
Giacomo Bernini committed
376

377
378
379
380
381
382
383
  416:
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
384
385
386
387
388
389
390
391
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
392
      Version:
393
394
        description: >
          Version of the API used in the response.
395
396
397
        type: string
        maximum: 1
        minimum: 1
398
    schema:
399
400
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

401
402
  422:
    description: >
403
404
405
406
407
408
409
410
      422 UNPROCESSABLE ENTITY

      If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data
      cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond
      with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail"
      attribute more information about the source of the problem.

      This error response code is only applicable for methods that have a request body.
411
412
413
414
415
416
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
417
418
419
420
421
422
423
424
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
425
      Version:
426
427
        description: >
          Version of the API used in the response.
428
429
430
        type: string
        maximum: 1
        minimum: 1
431
    schema:
432
433
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

Giacomo Bernini's avatar
Giacomo Bernini committed
434
435
  429:
    description: >
436
437
438
439
440
441
      429 TOO MANY REQUESTS

      If the API consumer has sent too many requests in a defined period of time and the API producer is able
      to detect that condition ("rate limiting"), the API producer shall respond with this response code,
      following the provisions in IETF RFC 6585 [17] for the use of the "Retry-After" HTTP header.
      The "ProblemDetails" structure shall be provided and shall include in the "detail" attribute more information
Giacomo Bernini's avatar
Giacomo Bernini committed
442
      about the source of the problem.
443
444
445

      The period of time and allowed number of requests are configured within the API producer by means
      outside the scope of the present document.
Giacomo Bernini's avatar
Giacomo Bernini committed
446
447
448
449
450
451
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
452
453
454
455
456
457
458
459
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
460
      Version:
461
462
        description: >
          Version of the API used in the response.
463
464
465
        type: string
        maximum: 1
        minimum: 1
Giacomo Bernini's avatar
Giacomo Bernini committed
466
    schema:
467
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
Giacomo Bernini's avatar
Giacomo Bernini committed
468

469
470
  500:
    description: >
471
472
473
474
475
476
      500 INTERNAL SERVER ERROR

      If there is an application error not related to the client's input that cannot be easily mapped to any other
      HTTP response code ("catch all error"), the API producer shall respond with this response code.
      The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information
      about the source of the problem.
477
478
479
480
481
482
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
483
484
485
486
487
488
489
490
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
491
      Version:
492
493
        description: >
          Version of the API used in the response.
494
495
496
        type: string
        maximum: 1
        minimum: 1
497
    schema:
498
499
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

500
501
  503:
    description: >
502
      503 SERVICE UNAVAILABLE
Gergely Csatari's avatar
Gergely Csatari committed
503

504
505
506
507
      If the API producer encounters an internal overload situation of itself or of a system it relies on,
      it should respond with this response code, following the provisions in IETF RFC 7231 for the use of
      the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails"
      structure may be omitted.
508
509
510
511
512
513
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
514
515
516
517
518
519
520
521
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
522
      Version:
523
524
        description: >
          Version of the API used in the response.
525
526
527
        type: string
        maximum: 1
        minimum: 1
528
    schema:
529
530
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

Giacomo Bernini's avatar
Giacomo Bernini committed
531
532
  504:
    description: >
533
      504 GATEWAY TIMEOUT
Giacomo Bernini's avatar
Giacomo Bernini committed
534

535
536
537
      If the API producer encounters a timeout while waiting for a response from an upstream server
      (i.e. a server that the API producer communicates with when fulfilling a request), it should respond
      with this response code.
Giacomo Bernini's avatar
Giacomo Bernini committed
538
539
540
541
542
543
    headers:
      Content-Type:
        description: The MIME type of the body of the response.
        type: string
        maximum: 1
        minimum: 1
544
545
546
547
548
549
550
551
      WWW-Authenticate:
        description: >
          Challenge if the corresponding HTTP request has not provided
          authorization, or error details if the corresponding HTTP
          request has provided an invalid authorization token.
        type: string
        maximum: 1
        minimum: 0
552
      Version:
553
554
        description: >
          Version of the API used in the response.
555
556
557
        type: string
        maximum: 1
        minimum: 1
Giacomo Bernini's avatar
Giacomo Bernini committed
558
    schema:
559
      $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"