C:\Users\klaus\Downloads\metadata\[REF-2] Clearing_Platform_OpenAPI_Definition_V1.yaml 2023-08-22 09:52:10
C:\Users\klaus\Downloads\metadata\[REF-2] Clearing_Platform_OpenAPI_Definition_V1.1.yaml 2023-08-22 09:52:42
Changes: 45
1 # release 1.1 version: 10.8.2023
1 openapi: 3.0.1 2 openapi: 3.0.1
2 info: 3 info:
3 title: Clearing Platform API 4 title: Clearing Platform API
4 description: |- 5 description: |-
5 The Clearing Platform API (for Partner Access) provides a standardized client interface to a Clearing Platform Systems for creating and tracking clearing tickets. 6 The Clearing Platform API (for Partner Access) provides a standardized client interface to a Clearing Platform Systems for creating and tracking clearing tickets.
6 It also contains access to metadata like ItuCarrier and supports attachments (store and retrieve) 7 It also contains access to metadata like ItuCarrier and supports attachments (store and retrieve)
7 version: 1.0.0 8 version: 1.0.0
8 servers: 9 servers:
9 - url: https://serverRoot/partner-api/v1/ 10 - url: https://serverRoot/partner-api/v1/
10 11
11 security: 12 security:
12 - basicAuth: [] 13 - basicAuth: []
13 - bearer: [] 14 - bearer: []
14 15
15 tags: 16 tags:
16 - name: ClearingTicket 17 - name: ClearingTicket
17 - name: NotificationListener 18 - name: NotificationListener
18 - name: ItuCarrier 19 - name: ItuCarrier
19 - name: Attachment 20 - name: Attachment
20 paths: 21 paths:
21 /troubleTicket: 22 /troubleTicket:
22 get: 23 get:
23 tags: 24 tags:
24 - ClearingTicket 25 - ClearingTicket
25 summary: Lists or finds ClearingTicket objects 26 summary: Lists or finds ClearingTicket objects
26 description: This operation lists ClearingTicket entities 27 description: This operation lists ClearingTicket entities
27 operationId: listClearingTicket 28 operationId: listClearingTicket
28 parameters: 29 parameters:
29 - name: externalId 30 - name: externalId
30 in: query 31 in: query
31 description: "Select only clearing tickets with externalId equal 'externalId'. An empty parameter is ignored." 32 description: "Select only clearing tickets with externalId equal 'externalId'. An empty parameter is ignored."
32 schema: 33 schema:
33 type: string 34 type: string
34 - name: ticketType 35 - name: ticketType
35 in: query 36 in: query
36 description: "Select only clearing tickets with scenarios = 'ticketType' (allows pattern: e.g. 1.* selects all scenarios 1.0 — 1.9). An empty parameter is ignored." 37 description: "Select only clearing tickets with scenarios = 'ticketType' (allows pattern: e.g. 1.* selects all scenarios 1.0 — 1.9). An empty parameter is ignored."
37 schema: 38 schema:
38 type: string 39 type: string
39 - name: status 40 - name: status
40 in: query 41 in: query
41 description: "Select only clearing tickets with status equal 'status'. An empty parameter is ignored." 42 description: "Select only clearing tickets with status equal 'status'. An empty parameter is ignored."
42 schema: 43 schema:
43 $ref: '#/components/schemas/StatusType' 44 $ref: '#/components/schemas/StatusType'
44 - name: originator 45 - name: originator
45 in: query 46 in: query
46 description: "Select only clearing tickets with originator equal 'originator'. An empty parameter is ignored." 47 description: "Select only clearing tickets with originator equal 'originator'. An empty parameter is ignored."
47 schema: 48 schema:
48 type: string 49 type: string
49 - name: processor 50 - name: processor
50 in: query 51 in: query
51 description: "Select only clearing tickets with processor equal 'processor'. An empty parameter is ignored." 52 description: "Select only clearing tickets with processor equal 'processor'. An empty parameter is ignored."
52 schema: 53 schema:
53 type: string 54 type: string
54 - name: severity 55 - name: severity
55 in: query 56 in: query
56 description: "Select only clearing tickets with severity equal 'severity'. An empty parameter is ignored." 57 description: "Select only clearing tickets with severity equal 'severity'. An empty parameter is ignored."
57 schema: 58 schema:
58 $ref: '#/components/schemas/SeverityType' 59 $ref: '#/components/schemas/SeverityType'
59 - name: requestedResolutionDateFrom 60 - name: requestedResolutionDateFrom
60 in: query 61 in: query
61 description: "Select only clearing tickets with requestedResolutionDate higher 'requestedResolutionDate'. An empty parameter is ignored." 62 description: "Select only clearing tickets with requestedResolutionDate higher 'requestedResolutionDate'. An empty parameter is ignored."
62 schema: 63 schema:
63 type: string 64 type: string
64 format: date 65 format: date
65 - name: requestedResolutionDateTo 66 - name: requestedResolutionDateTo
66 in: query 67 in: query
67 description: "Select only clearing tickets with requestedResolutionDate less equal 'requestedResolutionDate'. An empty parameter is ignored." 68 description: "Select only clearing tickets with requestedResolutionDate less equal 'requestedResolutionDate'. An empty parameter is ignored."
68 schema: 69 schema:
69 type: string 70 type: string
70 format: date 71 format: date
71 - name: creationDateFrom 72 - name: creationDateFrom
72 in: query 73 in: query
73 description: "Select only clearing tickets with creation date equal or higher 'creationDateFrom' An empty parameter is ignored." 74 description: "Select only clearing tickets with creation date equal or higher 'creationDateFrom' An empty parameter is ignored."
74 schema: 75 schema:
75 type: string 76 type: string
76 format: date 77 format: date
77 - name: creationDateTo 78 - name: creationDateTo
78 in: query 79 in: query
79 description: "Select only clearing tickets with creation date less equal 'creationDateTo' An empty parameter is ignored." 80 description: "Select only clearing tickets with creation date less equal 'creationDateTo' An empty parameter is ignored."
80 schema: 81 schema:
81 type: string 82 type: string
82 format: date 83 format: date
83 - name: lastUpdateFrom 84 - name: lastUpdateFrom
84 in: query 85 in: query
85 description: "Select only clearing tickets with last update equal or higher 'lastUpdateFrom'. An empty parameter is ignored." 86 description: "Select only clearing tickets with last update equal or higher 'lastUpdateFrom'. An empty parameter is ignored."
86 schema: 87 schema:
87 type: string 88 type: string
88 format: date-time 89 format: date-time
89 - name: lastUpdateTo 90 - name: lastUpdateTo
90 in: query 91 in: query
91 description: "Select only clearing tickets with last update less equal 'lastUpdateTo'. An empty parameter is ignored." 92 description: "Select only clearing tickets with last update less equal 'lastUpdateTo'. An empty parameter is ignored."
92 schema: 93 schema:
93 type: string 94 type: string
94 format: date-time 95 format: date-time
95 - name: offset 96 - name: offset
96 in: query 97 in: query
97 description: "Requested index for start of selected clearing tickets to be provided in response. Note: Sort order is always by creation date." 98 description: "Requested index for start of selected clearing tickets to be provided in response. Note: Sort order is always by creation date."
98 schema: 99 schema:
99 type: integer 100 type: integer
100 - name: limit 101 - name: limit
101 in: query 102 in: query
102 description: "Requested number of selected clearing tickets to be provided in response. Note: Sort order is always by creation date." 103 description: "Requested number of selected clearing tickets to be provided in response. Note: Sort order is always by creation date."
103 schema: 104 schema:
104 type: integer 105 type: integer
105 responses: 106 responses:
106 '200': 107 '200':
107 description: Success 108 description: Success
108 content: 109 content:
109 application/json;charset=utf-8: 110 application/json;charset=utf-8:
110 schema: 111 schema:
111 type: array 112 type: array
112 items: 113 items:
113 $ref: '#/components/schemas/ClearingTicket' 114 $ref: '#/components/schemas/ClearingTicket'
114 '206': 115 '206':
115 description: Partial Content 116 description: Partial Content
116 headers: 117 headers:
117 X-Total-Count: 118 X-Total-Count:
118 description: Total number of clearing tickets matching the criteria. 119 description: Total number of clearing tickets matching the criteria.
119 schema: 120 schema:
120 type: integer 121 type: integer
121 X-Result-Count: 122 X-Result-Count:
122 description: Actual number of clearing tickets returned in the response body. 123 description: Actual number of clearing tickets returned in the response body.
123 schema: 124 schema:
124 type: integer 125 type: integer
125 content: 126 content:
126 application/json;charset=utf-8: 127 application/json;charset=utf-8:
127 schema: 128 schema:
128 type: array 129 type: array
129 items: 130 items:
130 $ref: '#/components/schemas/ClearingTicket' 131 $ref: '#/components/schemas/ClearingTicket'
131 '400': 132 '400':
132 description: Bad Request 133 description: Bad Request
133 content: 134 content:
134 application/json;charset=utf-8: 135 application/json;charset=utf-8:
135 schema: 136 schema:
136 $ref: '#/components/schemas/Error' 137 $ref: '#/components/schemas/Error'
137 '401':
138 description: Unauthorized
139 content:
140 application/json;charset=utf-8:
141 schema:
142 $ref: '#/components/schemas/Error'
143 '403':
144 description: Forbidden
145 content:
146 application/json;charset=utf-8:
147 schema:
148 $ref: '#/components/schemas/Error'
149 '404':
150 description: Not Found
151 content:
152 application/json;charset=utf-8:
153 schema:
154 $ref: '#/components/schemas/Error'
155 '405':
156 description: Method Not allowed
157 content:
158 application/json;charset=utf-8:
159 schema:
160 $ref: '#/components/schemas/Error'
161 '409':
162 description: Conflict
163 content:
164 application/json;charset=utf-8:
165 schema:
166 $ref: '#/components/schemas/Error'
167 '500':
168 description: Internal Server Error
169 content:
170 application/json;charset=utf-8:
171 schema:
172 $ref: '#/components/schemas/Error'
173 post: 138 post:
174 tags: 139 tags:
175 - ClearingTicket 140 - ClearingTicket
176 summary: Creates a ClearingTicket 141 summary: Creates a ClearingTicket
177 description: This operation creates a ClearingTicket entity. 142 description: This operation creates a ClearingTicket entity.
178 operationId: createClearingTicket 143 operationId: createClearingTicket
179 requestBody: 144 requestBody:
180 description: The ClearingTicket to be created 145 description: The ClearingTicket to be created
181 content: 146 content:
182 application/json;charset=utf-8: 147 application/json;charset=utf-8:
183 schema: 148 schema:
184 $ref: '#/components/schemas/ClearingTicket' 149 $ref: '#/components/schemas/ClearingTicket'
185 required: true 150 required: true
186 responses: 151 responses:
187 '201': 152 '201':
188 description: Created 153 description: Created
189 content: 154 content:
190 application/json;charset=utf-8: 155 application/json;charset=utf-8:
191 schema: 156 schema:
192 $ref: '#/components/schemas/ClearingTicket' 157 $ref: '#/components/schemas/ClearingTicket'
193 '400': 158 '400':
194 description: Bad Request 159 description: Bad Request
195 content: 160 content:
196 application/json;charset=utf-8: 161 application/json;charset=utf-8:
197 schema: 162 schema:
198 $ref: '#/components/schemas/Error' 163 $ref: '#/components/schemas/Error'
199 '401': 164 '422':
200 description: Unauthorized 165 description: Unprocessable Content
201 content:
202 application/json;charset=utf-8:
203 schema:
204 $ref: '#/components/schemas/Error'
205 '403':
206 description: Forbidden
207 content:
208 application/json;charset=utf-8:
209 schema:
210 $ref: '#/components/schemas/Error'
211 '405':
212 description: Method Not allowed
213 content:
214 application/json;charset=utf-8:
215 schema:
216 $ref: '#/components/schemas/Error'
217 '409':
218 description: Conflict
219 content:
220 application/json;charset=utf-8:
221 schema:
222 $ref: '#/components/schemas/Error'
223 '500':
224 description: Internal Server Error
225 content: 166 content:
226 application/json;charset=utf-8: 167 application/json;charset=utf-8:
227 schema: 168 schema:
228 $ref: '#/components/schemas/Error' 169 $ref: '#/components/schemas/Error'
229 x-codegen-request-body-name: clearingTicket 170 x-codegen-request-body-name: clearingTicket
230 171
231 /troubleTicket/{id}: 172 /troubleTicket/{id}:
232 get: 173 get:
233 tags: 174 tags:
234 - ClearingTicket 175 - ClearingTicket
235 summary: Retrieves a ClearingTicket by ID 176 summary: Retrieves a ClearingTicket by ID
236 description: This operation retrieves a ClearingTicket entity. 177 description: This operation retrieves a ClearingTicket entity.
237 operationId: retrieveClearingTicket 178 operationId: retrieveClearingTicket
238 parameters: 179 parameters:
239 - name: id 180 - name: id
240 in: path 181 in: path
241 description: Identifier of the ClearingTicket 182 description: Identifier of the ClearingTicket
242 required: true 183 required: true
243 schema: 184 schema:
244 type: string 185 type: string
245 responses: 186 responses:
246 '200': 187 '200':
247 description: Success 188 description: Success
248 content: 189 content:
249 application/json;charset=utf-8: 190 application/json;charset=utf-8:
250 schema: 191 schema:
251 $ref: '#/components/schemas/ClearingTicket' 192 $ref: '#/components/schemas/ClearingTicket'
252 '400':
253 description: Bad Request
254 content:
255 application/json;charset=utf-8:
256 schema:
257 $ref: '#/components/schemas/Error'
258 '401':
259 description: Unauthorized
260 content:
261 application/json;charset=utf-8:
262 schema:
263 $ref: '#/components/schemas/Error'
264 '403':
265 description: Forbidden
266 content:
267 application/json;charset=utf-8:
268 schema:
269 $ref: '#/components/schemas/Error'
270 '404': 193 '404':
271 description: Not Found 194 description: Not Found
272 content: 195 content:
273 application/json;charset=utf-8: 196 application/json;charset=utf-8:
274 schema: 197 schema:
275 $ref: '#/components/schemas/Error' 198 $ref: '#/components/schemas/Error'
276 '405':
277 description: Method Not allowed
278 content:
279 application/json;charset=utf-8:
280 schema:
281 $ref: '#/components/schemas/Error'
282 '500':
283 description: Internal Server Error
284 content:
285 application/json;charset=utf-8:
286 schema:
287 $ref: '#/components/schemas/Error'
288 199
289 /troubleTicket/{id}/status: 200 /troubleTicket/{id}/status:
290 patch: 201 patch:
291 tags: 202 tags:
292 - ClearingTicket 203 - ClearingTicket
293 summary: Request a ClearingTicket status change 204 summary: Request a ClearingTicket status change
294 description: This operation requests a ClearingTicket status change. 205 description: This operation requests a ClearingTicket status change.
295 operationId: setClearingTicketStatus 206 operationId: setClearingTicketStatus
296 parameters: 207 parameters:
297 - name: id 208 - name: id
298 in: path 209 in: path
299 description: Identifier of the ClearingTicket 210 description: Identifier of the ClearingTicket
300 required: true 211 required: true
301 schema: 212 schema:
302 type: string 213 type: string
303 requestBody: 214 requestBody:
304 description: The new ClearingTicket status to be set 215 description: The new ClearingTicket status to be set
305 content: 216 content:
306 application/json;charset=utf-8: 217 application/json;charset=utf-8:
307 schema: 218 schema:
308 $ref: '#/components/schemas/StatusChange' 219 $ref: '#/components/schemas/StatusChange'
309 required: true 220 required: true
310 responses: 221 responses:
311 '200': 222 '200':
312 description: Success - request accepted 223 description: Success - request accepted
313 content: 224 content:
314 application/json;charset=utf-8: 225 application/json;charset=utf-8:
315 schema: 226 schema:
316 $ref: '#/components/schemas/ClearingTicket' 227 $ref: '#/components/schemas/ClearingTicket'
317 '400': 228 '400':
318 description: Bad Request 229 description: Bad Request
319 content: 230 content:
320 application/json;charset=utf-8: 231 application/json;charset=utf-8:
321 schema: 232 schema:
322 $ref: '#/components/schemas/Error' 233 $ref: '#/components/schemas/Error'
323 '401':
324 description: Unauthorized
325 content:
326 application/json;charset=utf-8:
327 schema:
328 $ref: '#/components/schemas/Error'
329 '403':
330 description: Forbidden
331 content:
332 application/json;charset=utf-8:
333 schema:
334 $ref: '#/components/schemas/Error'
335 '404': 234 '404':
336 description: Not Found 235 description: Not Found
337 content: 236 content:
338 application/json;charset=utf-8: 237 application/json;charset=utf-8:
339 schema: 238 schema:
340 $ref: '#/components/schemas/Error' 239 $ref: '#/components/schemas/Error'
341 '405': 240 '422':
342 description: Method Not allowed - request denied 241 description: Unprocessable Content
343 content:
344 application/json;charset=utf-8:
345 schema:
346 $ref: '#/components/schemas/Error'
347 '409':
348 description: Conflict
349 content:
350 application/json;charset=utf-8:
351 schema:
352 $ref: '#/components/schemas/Error'
353 '500':
354 description: Internal Server Error
355 content: 242 content:
356 application/json;charset=utf-8: 243 application/json;charset=utf-8:
357 schema: 244 schema:
358 $ref: '#/components/schemas/Error' 245 $ref: '#/components/schemas/Error'
359 x-codegen-request-body-name: status 246 x-codegen-request-body-name: status
360 247
361 /troubleTicket/{id}/resolved: 248 /troubleTicket/{id}/resolved:
362 patch: 249 patch:
363 tags: 250 tags:
364 - ClearingTicket 251 - ClearingTicket
365 summary: Report a ClearingTicket resolution 252 summary: Report a ClearingTicket resolution
366 description: This operation sets a ClearingTicket to status resolved. 253 description: This operation sets a ClearingTicket to status resolved.
367 operationId: setClearingTicketResolved 254 operationId: setClearingTicketResolved
368 parameters: 255 parameters:
369 - name: id 256 - name: id
370 in: path 257 in: path
371 description: Identifier of the ClearingTicket 258 description: Identifier of the ClearingTicket
372 required: true 259 required: true
373 schema: 260 schema:
374 type: string 261 type: string
375 requestBody: 262 requestBody:
376 description: The data to be set along with the resolved status 263 description: The data to be set along with the resolved status
377 content: 264 content:
378 application/json;charset=utf-8: 265 application/json;charset=utf-8:
379 schema: 266 schema:
380 $ref: '#/components/schemas/StatusChangeResolved' 267 $ref: '#/components/schemas/StatusChangeResolved'
381 required: true 268 required: true
382 responses: 269 responses:
383 '200': 270 '200':
384 description: Success - request accepted 271 description: Success - request accepted
385 content: 272 content:
386 application/json;charset=utf-8: 273 application/json;charset=utf-8:
387 schema: 274 schema:
388 $ref: '#/components/schemas/ClearingTicket' 275 $ref: '#/components/schemas/ClearingTicket'
389 '400': 276 '400':
390 description: Bad Request 277 description: Bad Request
391 content: 278 content:
392 application/json;charset=utf-8: 279 application/json;charset=utf-8:
393 schema: 280 schema:
394 $ref: '#/components/schemas/Error' 281 $ref: '#/components/schemas/Error'
395 '401':
396 description: Unauthorized
397 content:
398 application/json;charset=utf-8:
399 schema:
400 $ref: '#/components/schemas/Error'
401 '403':
402 description: Forbidden
403 content:
404 application/json;charset=utf-8:
405 schema:
406 $ref: '#/components/schemas/Error'
407 '404': 282 '404':
408 description: Not Found 283 description: Not Found
409 content: 284 content:
410 application/json;charset=utf-8: 285 application/json;charset=utf-8:
411 schema: 286 schema:
412 $ref: '#/components/schemas/Error' 287 $ref: '#/components/schemas/Error'
413 '405': 288 '422':
414 description: Method Not allowed - request denied 289 description: Unprocessable Content
415 content:
416 application/json;charset=utf-8:
417 schema:
418 $ref: '#/components/schemas/Error'
419 '409':
420 description: Conflict
421 content:
422 application/json;charset=utf-8:
423 schema:
424 $ref: '#/components/schemas/Error'
425 '500':
426 description: Internal Server Error
427 content: 290 content:
428 application/json;charset=utf-8: 291 application/json;charset=utf-8:
429 schema: 292 schema:
430 $ref: '#/components/schemas/Error' 293 $ref: '#/components/schemas/Error'
431 x-codegen-request-body-name: status 294 x-codegen-request-body-name: status
432 295
433 /troubleTicket/{id}/note: 296 /troubleTicket/{id}/note:
434 post: 297 post:
435 tags: 298 tags:
436 - ClearingTicket 299 - ClearingTicket
437 summary: Adds a new ClearingTicket note 300 summary: Adds a new ClearingTicket note
438 description: This operation adds a new ClearingTicket note. 301 description: This operation adds a new ClearingTicket note.
439 operationId: addClearingTicketNote 302 operationId: addClearingTicketNote
440 parameters: 303 parameters:
441 - name: id 304 - name: id
442 in: path 305 in: path
443 description: Identifier of the ClearingTicket 306 description: Identifier of the ClearingTicket
444 required: true 307 required: true
445 schema: 308 schema:
446 type: string 309 type: string
447 requestBody: 310 requestBody:
448 description: The ClearingTicket note to be added 311 description: The ClearingTicket note to be added
449 content: 312 content:
450 application/json;charset=utf-8: 313 application/json;charset=utf-8:
451 schema: 314 schema:
452 $ref: '#/components/schemas/Note' 315 $ref: '#/components/schemas/Note'
453 required: true 316 required: true
454 responses: 317 responses:
455 '201': 318 '201':
456 description: Success - note created 319 description: Success - note created
457 content: 320 content:
458 application/json;charset=utf-8: 321 application/json;charset=utf-8:
459 schema: 322 schema:
460 $ref: '#/components/schemas/ClearingTicket' 323 $ref: '#/components/schemas/ClearingTicket'
461 '400': 324 '400':
462 description: Bad Request 325 description: Bad Request
463 content: 326 content:
464 application/json;charset=utf-8: 327 application/json;charset=utf-8:
465 schema: 328 schema:
466 $ref: '#/components/schemas/Error' 329 $ref: '#/components/schemas/Error'
467 '401':
468 description: Unauthorized
469 content:
470 application/json;charset=utf-8:
471 schema:
472 $ref: '#/components/schemas/Error'
473 '403':
474 description: Forbidden
475 content:
476 application/json;charset=utf-8:
477 schema:
478 $ref: '#/components/schemas/Error'
479 '404': 330 '404':
480 description: Not Found 331 description: Not Found
481 content: 332 content:
482 application/json;charset=utf-8: 333 application/json;charset=utf-8:
483 schema: 334 schema:
484 $ref: '#/components/schemas/Error' 335 $ref: '#/components/schemas/Error'
485 '405': 336 '422':
486 description: Method Not allowed 337 description: Unprocessable Content
487 content:
488 application/json;charset=utf-8:
489 schema:
490 $ref: '#/components/schemas/Error'
491 '500':
492 description: Internal Server Error
493 content: 338 content:
494 application/json;charset=utf-8: 339 application/json;charset=utf-8:
495 schema: 340 schema:
496 $ref: '#/components/schemas/Error' 341 $ref: '#/components/schemas/Error'
497 x-codegen-request-body-name: note 342 x-codegen-request-body-name: note
498 343
499 /troubleTicket/{id}/severity: 344 /troubleTicket/{id}/severity:
500 patch: 345 patch:
501 tags: 346 tags:
502 - ClearingTicket 347 - ClearingTicket
503 summary: Set a new ClearingTicket severity 348 summary: Set a new ClearingTicket severity
504 description: This operation sets a new ClearingTicket severity. 349 description: This operation sets a new ClearingTicket severity.
505 operationId: setClearingTicketSeverity 350 operationId: setClearingTicketSeverity
506 parameters: 351 parameters:
507 - name: id 352 - name: id
508 in: path 353 in: path
509 description: Identifier of the ClearingTicket 354 description: Identifier of the ClearingTicket
510 required: true 355 required: true
511 schema: 356 schema:
512 type: string 357 type: string
513 requestBody: 358 requestBody:
514 description: The new severity to be set 359 description: The new severity to be set
515 required: true 360 required: true
516 content: 361 content:
517 application/json;charset=utf-8: 362 application/json;charset=utf-8:
518 schema: 363 schema:
519 $ref: '#/components/schemas/Severity' 364 $ref: '#/components/schemas/Severity'
520 responses: 365 responses:
521 '200': 366 '200':
522 description: Success - request accepted 367 description: Success - request accepted
523 content: 368 content:
524 application/json;charset=utf-8: 369 application/json;charset=utf-8:
525 schema: 370 schema:
526 $ref: '#/components/schemas/ClearingTicket' 371 $ref: '#/components/schemas/ClearingTicket'
527 '400': 372 '400':
528 description: Bad Request 373 description: Bad Request
529 content: 374 content:
530 application/json;charset=utf-8: 375 application/json;charset=utf-8:
531 schema: 376 schema:
532 $ref: '#/components/schemas/Error' 377 $ref: '#/components/schemas/Error'
533 '401':
534 description: Unauthorized
535 content:
536 application/json;charset=utf-8:
537 schema:
538 $ref: '#/components/schemas/Error'
539 '403':
540 description: Forbidden
541 content:
542 application/json;charset=utf-8:
543 schema:
544 $ref: '#/components/schemas/Error'
545 '404': 378 '404':
546 description: Not Found 379 description: Not Found
547 content: 380 content:
548 application/json;charset=utf-8: 381 application/json;charset=utf-8:
549 schema: 382 schema:
550 $ref: '#/components/schemas/Error' 383 $ref: '#/components/schemas/Error'
551 '405': 384 '422':
552 description: Method Not allowed - request denied 385 description: Unprocessable Content
553 content:
554 application/json;charset=utf-8:
555 schema:
556 $ref: '#/components/schemas/Error'
557 '500':
558 description: Internal Server Error
559 content: 386 content:
560 application/json;charset=utf-8: 387 application/json;charset=utf-8:
561 schema: 388 schema:
562 $ref: '#/components/schemas/Error' 389 $ref: '#/components/schemas/Error'
563 x-codegen-request-body-name: severity 390 x-codegen-request-body-name: severity
564 391
565 /troubleTicket/{id}/clearingData: 392 /troubleTicket/{id}/clearingData:
566 patch: 393 patch:
567 tags: 394 tags:
568 - ClearingTicket 395 - ClearingTicket
569 summary: Set new ClearingTicket data 396 summary: Set new ClearingTicket data
570 description: This operation sets new ClearingTicket data. Only allowed at status "pending". 397 description: This operation sets new ClearingTicket data. Only allowed at status "pending".
571 operationId: setClearingTicketData 398 operationId: setClearingTicketData
572 parameters: 399 parameters:
573 - name: id 400 - name: id
574 in: path 401 in: path
575 description: Identifier of the ClearingTicket 402 description: Identifier of the ClearingTicket
576 required: true 403 required: true
577 schema: 404 schema:
578 type: string 405 type: string
579 requestBody: 406 requestBody:
580 description: The ClearingData to be set 407 description: The ClearingData to be set
581 content: 408 content:
582 application/json;charset=utf-8: 409 application/json;charset=utf-8:
583 schema: 410 schema:
584 $ref: '#/components/schemas/ClearingData' 411 $ref: '#/components/schemas/ClearingData'
585 required: true 412 required: true
586 responses: 413 responses:
587 '200': 414 '200':
588 description: Success - request accepted 415 description: Success - request accepted
589 content: 416 content:
590 application/json;charset=utf-8: 417 application/json;charset=utf-8:
591 schema: 418 schema:
592 $ref: '#/components/schemas/ClearingTicket' 419 $ref: '#/components/schemas/ClearingTicket'
593 '400': 420 '400':
594 description: Bad Request 421 description: Bad Request
595 content: 422 content:
596 application/json;charset=utf-8: 423 application/json;charset=utf-8:
597 schema: 424 schema:
598 $ref: '#/components/schemas/Error' 425 $ref: '#/components/schemas/Error'
599 '401':
600 description: Unauthorized
601 content:
602 application/json;charset=utf-8:
603 schema:
604 $ref: '#/components/schemas/Error'
605 '403':
606 description: Forbidden
607 content:
608 application/json;charset=utf-8:
609 schema:
610 $ref: '#/components/schemas/Error'
611 '404': 426 '404':
612 description: Not Found 427 description: Not Found
613 content: 428 content:
614 application/json;charset=utf-8: 429 application/json;charset=utf-8:
615 schema: 430 schema:
616 $ref: '#/components/schemas/Error' 431 $ref: '#/components/schemas/Error'
617 '405': 432 '422':
618 description: Method Not allowed - request denied 433 description: Unprocessable Content
619 content: 434 content:
620 application/json;charset=utf-8: 435 application/json;charset=utf-8:
621 schema: 436 schema:
622 $ref: '#/components/schemas/Error' 437 $ref: '#/components/schemas/Error'
623 '500': 438 x-codegen-request-body-name: data
624 description: Internal Server Error
625 content:
626 application/json;charset=utf-8:
627 schema:
628 $ref: '#/components/schemas/Error'
629 439
630 /attachment: 440 /attachment:
631 post: 441 post:
632 tags: 442 tags:
633 - Attachment 443 - Attachment
634 summary: Create an attachment 444 summary: Create an attachment
635 description: This operation creates an attachment at on the platform and returns a relative url with a unique id. 445 description: This operation creates an attachment on the platform and returns a relative url with a unique id.
636 operationId: createAttachment 446 operationId: createAttachment
637 parameters: 447 parameters:
638 - name: filename 448 - name: filename
639 in: query 449 in: query
640 schema: 450 schema:
641 type: string 451 type: string
642 - name: Content-Type 452 - name: Content-Type
643 in: header 453 in: header
644 schema: 454 schema:
645 type: string 455 type: string
646 required: true 456 required: true
647 requestBody: 457 requestBody:
648 description: The attachment 458 description: The attachment
649 content: 459 content:
650 application/octet-stream: 460 '*/*':
651 # any media type is accepted, functionally equivalent to `*/*`
652 schema: 461 schema:
653 # a binary file of any type 462 # a binary file of any type
654 type: string 463 type: string
655 format: binary 464 format: binary
656 application/*:
657 schema:
658 type: string
659 format: binary
660 image/*:
661 schema:
662 type: string
663 format: binary
664 text/*:
665 schema:
666 type: string
667 format: binary
668 responses: 465 responses:
669 '201': 466 '201':
670 description: Success - attachment created 467 description: Success - attachment created
671 content: 468 content:
672 application/json;charset=utf-8: 469 application/json;charset=utf-8:
673 schema: 470 schema:
674 $ref: '#/components/schemas/Attachment' 471 $ref: '#/components/schemas/Attachment'
675 '400': 472 '400':
676 description: Bad Request 473 description: Bad Request
677 content: 474 content:
678 application/json;charset=utf-8: 475 application/json;charset=utf-8:
679 schema: 476 schema:
680 $ref: '#/components/schemas/Error' 477 $ref: '#/components/schemas/Error'
681 '401':
682 description: Unauthorized
683 content:
684 application/json;charset=utf-8:
685 schema:
686 $ref: '#/components/schemas/Error'
687 '403':
688 description: Forbidden
689 content:
690 application/json;charset=utf-8:
691 schema:
692 $ref: '#/components/schemas/Error'
693 '405':
694 description: Method Not allowed - request denied
695 content:
696 application/json;charset=utf-8:
697 schema:
698 $ref: '#/components/schemas/Error'
699 '500':
700 description: Internal Server Error
701 content:
702 application/json;charset=utf-8:
703 schema:
704 $ref: '#/components/schemas/Error'
705 478
706 /attachment/{id}: 479 /attachment/{id}:
707 get: 480 get:
708 tags: 481 tags:
709 - Attachment 482 - Attachment
710 summary: Retrieves an attachment by ID 483 summary: Retrieves an attachment by ID
711 description: This operation retrieves an attachment by ID. 484 description: This operation retrieves an attachment by ID.
712 operationId: retrieveAttachment 485 operationId: retrieveAttachment
713 parameters: 486 parameters:
714 - name: id 487 - name: id
715 in: path 488 in: path
716 description: Identifier of the attachment 489 description: Identifier of the attachment
717 required: true 490 required: true
718 schema: 491 schema:
719 type: string 492 type: string
720 # header: content-type 493 # header: content-type
721 responses: 494 responses:
722 '200': 495 '200':
723 description: Success 496 description: Success
724 content: 497 content:
725 application/octet-stream: 498 application/octet-stream:
726 schema: 499 schema:
727 # a binary file of any type 500 # a binary file of any type
728 type: string 501 type: string
729 format: binary 502 format: binary
730 '400':
731 description: Bad Request
732 content:
733 application/json;charset=utf-8:
734 schema:
735 $ref: '#/components/schemas/Error'
736 '401':
737 description: Unauthorized
738 content:
739 application/json;charset=utf-8:
740 schema:
741 $ref: '#/components/schemas/Error'
742 '403':
743 description: Forbidden
744 content:
745 application/json;charset=utf-8:
746 schema:
747 $ref: '#/components/schemas/Error'
748 '404': 503 '404':
749 description: Not Found 504 description: Not Found
750 content: 505 content:
751 application/json;charset=utf-8: 506 application/json;charset=utf-8:
752 schema: 507 schema:
753 $ref: '#/components/schemas/Error' 508 $ref: '#/components/schemas/Error'
754 '405':
755 description: Method Not allowed
756 content:
757 application/json;charset=utf-8:
758 schema:
759 $ref: '#/components/schemas/Error'
760 '500':
761 description: Internal Server Error
762 content:
763 application/json;charset=utf-8:
764 schema:
765 $ref: '#/components/schemas/Error'
766 509
767 /organization: 510 /organization:
768 get: 511 get:
769 tags: 512 tags:
770 - ItuCarrier 513 - ItuCarrier
771 summary: List or find ItuCarrier objects 514 summary: List or find ItuCarrier objects
772 description: This operation list or find ItuCarrier entities 515 description: This operation list or find ItuCarrier entities
773 operationId: listItuCarrier 516 operationId: listItuCarrier
774 responses: 517 responses:
775 '200': 518 '200':
776 description: Success 519 description: Success
777 content: 520 content:
778 application/json;charset=utf-8: 521 application/json;charset=utf-8:
779 schema: 522 schema:
780 type: array 523 type: array
781 items: 524 items:
782 $ref: '#/components/schemas/Organization' 525 $ref: '#/components/schemas/Organization'
783 '400':
784 description: Bad Request
785 content:
786 application/json;charset=utf-8:
787 schema:
788 $ref: '#/components/schemas/Error'
789 '401':
790 description: Unauthorized
791 content:
792 application/json;charset=utf-8:
793 schema:
794 $ref: '#/components/schemas/Error'
795 '403':
796 description: Forbidden
797 content:
798 application/json;charset=utf-8:
799 schema:
800 $ref: '#/components/schemas/Error'
801 '404':
802 description: Not Found
803 content:
804 application/json;charset=utf-8:
805 schema:
806 $ref: '#/components/schemas/Error'
807 '405':
808 description: Method Not allowed
809 content:
810 application/json;charset=utf-8:
811 schema:
812 $ref: '#/components/schemas/Error'
813 '500':
814 description: Internal Server Error
815 content:
816 application/json;charset=utf-8:
817 schema:
818 $ref: '#/components/schemas/Error'
819 526
820 /organization/{id}: 527 /organization/{id}:
821 get: 528 get:
822 tags: 529 tags:
823 - ItuCarrier 530 - ItuCarrier
824 summary: Retrieves an ItuCarrier by ID 531 summary: Retrieves an ItuCarrier by ID
825 description: This operation retrieves a 'ItuCarrier'-Organization entity. Attribute selection 532 description: This operation retrieves a 'ItuCarrier'-Organization entity. Attribute selection
826 is enabled for all first level attributes. 533 is enabled for all first level attributes.
827 operationId: retrieveItuCarrier 534 operationId: retrieveItuCarrier
828 parameters: 535 parameters:
829 - name: id 536 - name: id
830 in: path 537 in: path
831 description: Identifier of the ItuCarrier 538 description: Identifier of the ItuCarrier
832 required: true 539 required: true
833 schema: 540 schema:
834 type: string 541 type: string
835 responses: 542 responses:
836 '200': 543 '200':
837 description: Success 544 description: Success
838 content: 545 content:
839 application/json;charset=utf-8: 546 application/json;charset=utf-8:
840 schema: 547 schema:
841 $ref: '#/components/schemas/Organization' 548 $ref: '#/components/schemas/Organization'
842 '400':
843 description: Bad Request
844 content:
845 application/json;charset=utf-8:
846 schema:
847 $ref: '#/components/schemas/Error'
848 '401':
849 description: Unauthorized
850 content:
851 application/json;charset=utf-8:
852 schema:
853 $ref: '#/components/schemas/Error'
854 '403':
855 description: Forbidden
856 content:
857 application/json;charset=utf-8:
858 schema:
859 $ref: '#/components/schemas/Error'
860 '404': 549 '404':
861 description: Not Found 550 description: Not Found
862 content: 551 content:
863 application/json;charset=utf-8: 552 application/json;charset=utf-8:
864 schema: 553 schema:
865 $ref: '#/components/schemas/Error' 554 $ref: '#/components/schemas/Error'
866 '405':
867 description: Method Not allowed
868 content:
869 application/json;charset=utf-8:
870 schema:
871 $ref: '#/components/schemas/Error'
872 '500':
873 description: Internal Server Error
874 content:
875 application/json;charset=utf-8:
876 schema:
877 $ref: '#/components/schemas/Error'
878
879 555
880 /listener/troubleTicketCreateEvent: 556 /listener/troubleTicketCreateEvent:
881 post: 557 post:
882 tags: 558 tags:
883 - NotificationListener 559 - NotificationListener
884 summary: Client listener for entity ClearingTicketCreateEvent 560 summary: Client listener for entity ClearingTicketCreateEvent
885 description: Client listener for receiving the notification ClearingTicketStatusChangeEvent 561 description: Client listener for receiving the notification ClearingTicketStatusChangeEvent
886 operationId: listenToCreateEvent 562 operationId: listenToCreateEvent
887 requestBody: 563 requestBody:
888 description: The event data 564 description: The event data
889 content: 565 content:
890 application/json;charset=utf-8: 566 application/json;charset=utf-8:
891 schema: 567 schema:
892 $ref: '#/components/schemas/ClearingTicketCreateEvent' 568 $ref: '#/components/schemas/ClearingTicketCreateEvent'
893 required: true 569 required: true
894 responses: 570 responses:
895 '200': 571 '200':
896 description: OK - Notified 572 description: OK - Notified
897 content: {} 573 content: {}
898 '400':
899 description: Bad Request
900 content:
901 application/json;charset=utf-8:
902 schema:
903 $ref: '#/components/schemas/Error'
904 '401':
905 description: Unauthorized
906 content:
907 application/json;charset=utf-8:
908 schema:
909 $ref: '#/components/schemas/Error'
910 '403':
911 description: Forbidden
912 content:
913 application/json;charset=utf-8:
914 schema:
915 $ref: '#/components/schemas/Error'
916 '404':
917 description: Not Found
918 content:
919 application/json;charset=utf-8:
920 schema:
921 $ref: '#/components/schemas/Error'
922 '405':
923 description: Method Not allowed
924 content:
925 application/json;charset=utf-8:
926 schema:
927 $ref: '#/components/schemas/Error'
928 '500':
929 description: Internal Server Error
930 content:
931 application/json;charset=utf-8:
932 schema:
933 $ref: '#/components/schemas/Error'
934 x-codegen-request-body-name: data 574 x-codegen-request-body-name: data
935 575
936 /listener/troubleTicketStatusChangeEvent: 576 /listener/troubleTicketStatusChangeEvent:
937 post: 577 post:
938 tags: 578 tags:
939 - NotificationListener 579 - NotificationListener
940 summary: Client listener for entity ClearingTicketStatusChangeEvent 580 summary: Client listener for entity ClearingTicketStatusChangeEvent
941 description: Client listener for receiving the notification ClearingTicketStatusChangeEvent 581 description: Client listener for receiving the notification ClearingTicketStatusChangeEvent
942 operationId: listenToStatusChangeEvent 582 operationId: listenToStatusChangeEvent
943 requestBody: 583 requestBody:
944 description: The event data 584 description: The event data
945 content: 585 content:
946 application/json;charset=utf-8: 586 application/json;charset=utf-8:
947 schema: 587 schema:
948 $ref: '#/components/schemas/ClearingTicketStatusChangeEvent' 588 $ref: '#/components/schemas/ClearingTicketStatusChangeEvent'
949 required: true 589 required: true
950 responses: 590 responses:
951 '200': 591 '200':
952 description: OK - Notified 592 description: OK - Notified
953 content: {} 593 content: {}
954 '400':
955 description: Bad Request
956 content:
957 application/json;charset=utf-8:
958 schema:
959 $ref: '#/components/schemas/Error'
960 '401':
961 description: Unauthorized
962 content:
963 application/json;charset=utf-8:
964 schema:
965 $ref: '#/components/schemas/Error'
966 '403':
967 description: Forbidden
968 content:
969 application/json;charset=utf-8:
970 schema:
971 $ref: '#/components/schemas/Error'
972 '404':
973 description: Not Found
974 content:
975 application/json;charset=utf-8:
976 schema:
977 $ref: '#/components/schemas/Error'
978 '405':
979 description: Method Not allowed
980 content:
981 application/json;charset=utf-8:
982 schema:
983 $ref: '#/components/schemas/Error'
984 '500':
985 description: Internal Server Error
986 content:
987 application/json;charset=utf-8:
988 schema:
989 $ref: '#/components/schemas/Error'
990 x-codegen-request-body-name: data 594 x-codegen-request-body-name: data
991 595
992 /listener/troubleTicketDataChangeEvent: 596 /listener/troubleTicketDataChangeEvent:
993 post: 597 post:
994 tags: 598 tags:
995 - NotificationListener 599 - NotificationListener
996 summary: Client listener for entity ClearingTicketDataChangeEvent 600 summary: Client listener for entity ClearingTicketDataChangeEvent
997 description: Client listener for receiving the notification ClearingTicketDataChangeEvent 601 description: Client listener for receiving the notification ClearingTicketDataChangeEvent
998 operationId: listenToDataChangeEvent 602 operationId: listenToDataChangeEvent
999 requestBody: 603 requestBody:
1000 description: The event data 604 description: The event data
1001 content: 605 content:
1002 application/json;charset=utf-8: 606 application/json;charset=utf-8:
1003 schema: 607 schema:
1004 $ref: '#/components/schemas/ClearingTicketDataChangeEvent' 608 $ref: '#/components/schemas/ClearingTicketDataChangeEvent'
1005 required: true 609 required: true
1006 responses: 610 responses:
1007 '200': 611 '200':
1008 description: OK - Notified 612 description: OK - Notified
1009 content: {} 613 content: {}
1010 '400':
1011 description: Bad Request
1012 content:
1013 application/json;charset=utf-8:
1014 schema:
1015 $ref: '#/components/schemas/Error'
1016 '401':
1017 description: Unauthorized
1018 content:
1019 application/json;charset=utf-8:
1020 schema:
1021 $ref: '#/components/schemas/Error'
1022 '403':
1023 description: Forbidden
1024 content:
1025 application/json;charset=utf-8:
1026 schema:
1027 $ref: '#/components/schemas/Error'
1028 '404':
1029 description: Not Found
1030 content:
1031 application/json;charset=utf-8:
1032 schema:
1033 $ref: '#/components/schemas/Error'
1034 '405':
1035 description: Method Not allowed
1036 content:
1037 application/json;charset=utf-8:
1038 schema:
1039 $ref: '#/components/schemas/Error'
1040 '500':
1041 description: Internal Server Error
1042 content:
1043 application/json;charset=utf-8:
1044 schema:
1045 $ref: '#/components/schemas/Error'
1046 x-codegen-request-body-name: data 614 x-codegen-request-body-name: data
1047 615
1048 /listener/troubleTicketResolvedEvent: 616 /listener/troubleTicketResolvedEvent:
1049 post: 617 post:
1050 tags: 618 tags:
1051 - NotificationListener 619 - NotificationListener
1052 summary: Client listener for entity ClearingTicketResolvedEvent 620 summary: Client listener for entity ClearingTicketResolvedEvent
1053 description: Client listener for receiving the notification ClearingTicketResolvedEvent 621 description: Client listener for receiving the notification ClearingTicketResolvedEvent
1054 operationId: listenToResolvedEvent 622 operationId: listenToResolvedEvent
1055 requestBody: 623 requestBody:
1056 description: The event data 624 description: The event data
1057 content: 625 content:
1058 application/json;charset=utf-8: 626 application/json;charset=utf-8:
1059 schema: 627 schema:
1060 $ref: '#/components/schemas/ClearingTicketResolvedEvent' 628 $ref: '#/components/schemas/ClearingTicketResolvedEvent'
1061 required: true 629 required: true
1062 responses: 630 responses:
1063 '200': 631 '200':
1064 description: OK - Notified 632 description: OK - Notified
1065 content: {} 633 content: {}
1066 '400':
1067 description: Bad Request
1068 content:
1069 application/json;charset=utf-8:
1070 schema:
1071 $ref: '#/components/schemas/Error'
1072 '401':
1073 description: Unauthorized
1074 content:
1075 application/json;charset=utf-8:
1076 schema:
1077 $ref: '#/components/schemas/Error'
1078 '403':
1079 description: Forbidden
1080 content:
1081 application/json;charset=utf-8:
1082 schema:
1083 $ref: '#/components/schemas/Error'
1084 '404':
1085 description: Not Found
1086 content:
1087 application/json;charset=utf-8:
1088 schema:
1089 $ref: '#/components/schemas/Error'
1090 '405':
1091 description: Method Not allowed
1092 content:
1093 application/json;charset=utf-8:
1094 schema:
1095 $ref: '#/components/schemas/Error'
1096 '500':
1097 description: Internal Server Error
1098 content:
1099 application/json;charset=utf-8:
1100 schema:
1101 $ref: '#/components/schemas/Error'
1102 x-codegen-request-body-name: data 634 x-codegen-request-body-name: data
1103 635
1104 /listener/troubleTicketSeverityChangeEvent: 636 /listener/troubleTicketSeverityChangeEvent:
1105 post: 637 post:
1106 tags: 638 tags:
1107 - NotificationListener 639 - NotificationListener
1108 summary: Client listener for entity ClearingTicketSeverityhangeEvent 640 summary: Client listener for entity ClearingTicketSeverityhangeEvent
1109 description: Client listener for receiving the notification ClearingTicketSeverityChangeEvent 641 description: Client listener for receiving the notification ClearingTicketSeverityChangeEvent
1110 operationId: listenToSeverityChangeEvent 642 operationId: listenToSeverityChangeEvent
1111 requestBody: 643 requestBody:
1112 description: The event data 644 description: The event data
1113 content: 645 content:
1114 application/json;charset=utf-8: 646 application/json;charset=utf-8:
1115 schema: 647 schema:
1116 $ref: '#/components/schemas/ClearingTicketSeverityChangeEvent' 648 $ref: '#/components/schemas/ClearingTicketSeverityChangeEvent'
1117 required: true 649 required: true
1118 responses: 650 responses:
1119 '200': 651 '200':
1120 description: OK - Notified 652 description: OK - Notified
1121 content: {} 653 content: {}
1122 '400': 654 '400':
1123 description: Bad Request 655 description: Bad Request
1124 content: 656 content:
1125 application/json;charset=utf-8: 657 application/json;charset=utf-8:
1126 schema: 658 schema:
1127 $ref: '#/components/schemas/Error' 659 $ref: '#/components/schemas/Error'
1128 '401':
1129 description: Unauthorized
1130 content:
1131 application/json;charset=utf-8:
1132 schema:
1133 $ref: '#/components/schemas/Error'
1134 '403':
1135 description: Forbidden
1136 content:
1137 application/json;charset=utf-8:
1138 schema:
1139 $ref: '#/components/schemas/Error'
1140 '404':
1141 description: Not Found
1142 content:
1143 application/json;charset=utf-8:
1144 schema:
1145 $ref: '#/components/schemas/Error'
1146 '405':
1147 description: Method Not allowed
1148 content:
1149 application/json;charset=utf-8:
1150 schema:
1151 $ref: '#/components/schemas/Error'
1152 '500':
1153 description: Internal Server Error
1154 content:
1155 application/json;charset=utf-8:
1156 schema:
1157 $ref: '#/components/schemas/Error'
1158 x-codegen-request-body-name: data 660 x-codegen-request-body-name: data
1159 661
1160 /listener/troubleTicketNoteAddEvent: 662 /listener/troubleTicketNoteAddEvent:
1161 post: 663 post:
1162 tags: 664 tags:
1163 - NotificationListener 665 - NotificationListener
1164 summary: Client listener for entity ClearingTicketNoteAddEvent 666 summary: Client listener for entity ClearingTicketNoteAddEvent
1165 description: Listener for receiving the notification troubleTicketNoteAddEvent 667 description: Listener for receiving the notification troubleTicketNoteAddEvent
1166 operationId: listenToNoteAddEvent 668 operationId: listenToNoteAddEvent
1167 requestBody: 669 requestBody:
1168 description: The event data 670 description: The event data
1169 content: 671 content:
1170 application/json;charset=utf-8: 672 application/json;charset=utf-8:
1171 schema: 673 schema:
1172 $ref: '#/components/schemas/ClearingTicketNoteAddEvent' 674 $ref: '#/components/schemas/ClearingTicketNoteAddEvent'
1173 required: true 675 required: true
1174 responses: 676 responses:
1175 '200': 677 '200':
1176 description: OK - Notified 678 description: OK - Notified
1177 content: {} 679 content: {}
1178 '400':
1179 description: Bad Request
1180 content:
1181 application/json;charset=utf-8:
1182 schema:
1183 $ref: '#/components/schemas/Error'
1184 '401':
1185 description: Unauthorized
1186 content:
1187 application/json;charset=utf-8:
1188 schema:
1189 $ref: '#/components/schemas/Error'
1190 '403':
1191 description: Forbidden
1192 content:
1193 application/json;charset=utf-8:
1194 schema:
1195 $ref: '#/components/schemas/Error'
1196 '404':
1197 description: Not Found
1198 content:
1199 application/json;charset=utf-8:
1200 schema:
1201 $ref: '#/components/schemas/Error'
1202 '405':
1203 description: Method Not allowed
1204 content:
1205 application/json;charset=utf-8:
1206 schema:
1207 $ref: '#/components/schemas/Error'
1208 '500':
1209 description: Internal Server Error
1210 content:
1211 application/json;charset=utf-8:
1212 schema:
1213 $ref: '#/components/schemas/Error'
1214 x-codegen-request-body-name: data 680 x-codegen-request-body-name: data
1215 681
1216 components: 682 components:
1217 securitySchemes: 683 securitySchemes:
1218 basicAuth: 684 basicAuth:
1219 type: http 685 type: http
1220 scheme: basic 686 scheme: basic
1221 bearer: 687 bearer:
1222 type: http 688 type: http
1223 scheme: bearer 689 scheme: bearer
1224 690
1225 schemas: 691 schemas:
1226 692
1227 ClearingTicket: 693 ClearingTicket:
1228 type: object 694 type: object
1229 description: A clearing ticket is a record of an issue that is created, tracked, and managed by the clearing platform. 695 description: A clearing ticket is a record of an issue that is created, tracked, and managed by the clearing platform.
1230 required: 696 required:
1231 - description 697 - description
1232 - severity 698 - severity
1233 - ticketType 699 - ticketType
1234 - originator 700 - originator
1235 - processor 701 - processor
1236 - externalId 702 - externalId
1237 703
1238 properties: 704 properties:
1239 id: 705 id:
1240 type: string 706 type: string
1241 description: Unique identifier of the clearing ticket. MUST be a globally unique identifier (GUID) as specified in RFC 4122. This id is assigned by the server (entity that requests are sent to). 707 description: Unique identifier of the clearing ticket. MUST be a globally unique identifier (GUID) as specified in RFC 4122. This id is assigned by the server (entity that requests are sent to).
1242 creationDate: 708 creationDate:
1243 type: string 709 type: string
1244 description: The date and time the clearing ticket was created 710 description: The date and time the clearing ticket was created
1245 format: date-time 711 format: date-time
1246 lastUpdate: 712 lastUpdate:
1247 type: string 713 type: string
1248 description: The date and time the clearing ticked was last updated 714 description: The date and time the clearing ticked was last updated
1249 format: date-time 715 format: date-time
1250 description: 716 description:
1251 type: string 717 type: string
1252 description: Description of the trouble or issue. Should be set to the clearing scenario’s descriptive text. 718 description: Description of the trouble or issue. Should be set to the clearing scenario’s descriptive text.
1253 originator: 719 originator:
1254 type: string 720 type: string
1255 description: Id of the carrier, who initially originated the clearing ticket. 721 description: Id of the carrier, who initially originated the clearing ticket.
1256 processor: 722 processor:
1257 type: string 723 type: string
1258 description: Id of the carrier, who should process the clearing ticket. 724 description: Id of the carrier, who should process the clearing ticket.
1259 externalId: 725 externalId:
1260 type: string 726 type: string
1261 description: Identification for this clearing ticket assigned by the originator. This id shall be forwarded to all participating systems. It is used to identify a clearing ticket in external communication. 727 description: Identification for this clearing ticket assigned by the originator. This id shall be forwarded to all participating systems. It is used to identify a clearing ticket in external communication.
1262 severity: 728 severity:
1263 $ref: '#/components/schemas/SeverityType' 729 $ref: '#/components/schemas/SeverityType'
1264 description: "The severity of the issue as defined by the AH4Clearing. The allowed values (enum) are: regular, escalated, critical, date. When date is used, a requestedResolutioDate must be present." 730 description: "The severity of the issue as defined by the AH4Clearing. The allowed values (enum) are: regular, critical, escalated."
731 severityChangeReason:
732 type: string
733 description: The reason for a severity change. Required as soon as severity is no longer regular.
1265 requestedResolutionDate: 734 requestedResolutionDate:
1266 type: string 735 type: string
1267 description: The resolution date requested by the user. The AH4Clearings set rules how to set this parameter. 736 description: The resolution date requested by the user. The AH4Clearings set rules how to set this parameter.
1268 format: date 737 format: date
1269 ticketType: 738 ticketType:
1270 type: string 739 type: string
1271 description: The id of the clearing scenario 740 description: The id of the clearing scenario
1272 resolutionDate: 741 resolutionDate:
1273 type: string 742 type: string
1274 description: A date time (DateTime). The date and time the trouble ticket was resolved. 743 description: A date time (DateTime). The date and time the trouble ticket was resolved.
1275 format: date-time 744 format: date-time
1276 resolveAttachment: 745 resolveAttachment:
1277 type: array 746 type: array
1278 description: Attachments for the state transition -> resolved 747 description: Attachments for the state transition -> resolved
1279 items: 748 items:
1280 $ref: '#/components/schemas/Attachment' 749 $ref: '#/components/schemas/Attachment'
1281 resolvedSuccessfully: 750 resolvedSuccessfully:
1282 type: boolean 751 type: boolean
1283 description: When the processor resolves an issue this parameter must be set to indicate if the clearing ticket has been successfully processed as requested. 752 description: When the processor resolves an issue this parameter must be set to indicate if the clearing ticket has been successfully processed as requested.
1284 status: 753 status:
1285 description: The current status of the clearing ticket. 754 description: The current status of the clearing ticket.
1286 $ref: '#/components/schemas/StatusChange' 755 $ref: '#/components/schemas/StatusChange'
1287 statusChange: 756 statusChange:
1288 type: array 757 type: array
1289 description: The status change history that is associated to the ticket. Populated by the server 758 description: The status change history that is associated to the ticket. Populated by the server
1290 items: 759 items:
1291 $ref: '#/components/schemas/StatusChange' 760 $ref: '#/components/schemas/StatusChange'
1292 note: 761 note:
1293 type: array 762 type: array
1294 description: The note(s) that are associated to the ticket. 763 description: The note(s) that are associated to the ticket.
1295 items: 764 items:
1296 $ref: '#/components/schemas/Note' 765 $ref: '#/components/schemas/Note'
1297 clearingData: 766 clearingData:
1298 description: The data relevant for the clearing case. 767 description: The data relevant for the clearing case.
1299 $ref: '#/components/schemas/ClearingData' 768 $ref: '#/components/schemas/ClearingData'
1300 troubleTicketRelationship: 769 troubleTicketRelationship:
1301 type: array 770 type: array
1302 description: A list of trouble ticket relationships (TroubleTicketRelationship []). Represents a relationship between trouble tickets. 771 description: A list of trouble ticket relationships (TroubleTicketRelationship []). Represents a relationship between trouble tickets.
1303 items: 772 items:
1304 $ref: '#/components/schemas/TroubleTicketRelationship' 773 $ref: '#/components/schemas/TroubleTicketRelationship'
1305 href: 774 href:
1306 description: Hyperlink, a reference to the clearing ticket entity (relative URL) 775 description: Hyperlink, a reference to the clearing ticket entity (relative URL)
1307 type: string 776 type: string
1308 "@type": 777 "@type":
1309 description: "the type of this entity: ClearingTicket" 778 description: "the type of this entity: ClearingTicket"
1310 type: string 779 type: string
1311 "@baseType": 780 "@baseType":
1312 description: "the base type of this entity: TroubleTicket" 781 description: "the base type of this entity: TroubleTicket"
1313 type: string 782 type: string
1314 783
1315 Error: 784 Error:
1316 required: 785 required:
1317 - code 786 - code
1318 - reason 787 - reason
1319 type: object 788 type: object
1320 properties: 789 properties:
1321 code: 790 code:
1322 type: string 791 type: string
1323 description: Application relevant detail, defined in the API or a common 792 description: Application relevant detail, defined in the API or a common
1324 list. 793 list.
1325 reason: 794 reason:
1326 type: string 795 type: string
1327 description: Explanation of the reason for the error which can be shown 796 description: Explanation of the reason for the error which can be shown
1328 to a client user. 797 to a client user.
1329 description: Used when an API throws an Error, typically with a HTTP error response-code 798 description: Used when an API throws an Error, typically with a HTTP error response-code
1330 (3xx, 4xx, 5xx) 799 (3xx, 4xx, 5xx)
1331 800
1332 Note: 801 Note:
1333 type: object 802 type: object
1334 description: A note that is associated to the ticket. 803 description: A note that is associated to the ticket.
1335 properties: 804 properties:
1336 role: 805 role:
1337 type: string 806 type: string
1338 description: |- 807 description: |-
1339 The role of this note 808 The role of this note
1340 - 'empty' for regular notes. 809 - 'empty' for regular notes.
1341 - 'system message' for notes sent by the platform 810 - 'system message' for notes sent by the platform
1342 - 'severityChangeReason' for notes keeping the reason of a recent severity change
1343 author: 811 author:
1344 type: string 812 type: string
1345 description: Author of the note = ItuCarrier Id. If there is a need to mention the real author (person) if necessary this shall be mentioned in the text of the note. 813 description: Author of the note = ItuCarrier Id. If there is a need to mention the real author (person) if necessary this shall be mentioned in the text of the note.
1346 date: 814 date:
1347 type: string 815 type: string
1348 description: Date and time when the note was added to the ticket. 816 description: Date and time when the note was added to the ticket.
1349 format: date-time 817 format: date-time
1350 text: 818 text:
1351 type: string 819 type: string
1352 description: Text of the note - human readable. 820 description: Text of the note - human readable.
1353 821
1354 Severity: 822 Severity:
1355 type: object 823 type: object
1356 description: The new severity to be set 824 description: The new severity to be set
1357 properties: 825 properties:
1358 severity: 826 severity:
1359 $ref: '#/components/schemas/SeverityType' 827 $ref: '#/components/schemas/SeverityType'
1360 description: The new severity to be set 828 description: The new severity to be set
1361 requestedResolutionDate: 829 requestedResolutionDate:
1362 type: string 830 type: string
1363 format: date 831 format: date
1364 description: The new requested resolution date. Only when needed for given severity. 832 description: The new requested resolution date. Only when needed for given severity.
1365 bnetzaId: 833 bnetzaId:
1366 type: string 834 type: string
1367 description: Case id of 'Bundesnetzagentur' 835 description: Case id of 'Bundesnetzagentur'
1368 reason: 836 reason:
1369 type: string 837 type: string
1370 description: Reason for the severity change. 838 description: Reason for the severity change.
1371 SeverityType: 839 SeverityType:
1372 type: string 840 type: string
1373 description: The severity of the clearing ticket. Severity is one of the following. 841 description: The severity of the clearing ticket. Severity is one of the following.
1374 enum: 842 enum:
1375 - regular 843 - regular
1376 - escalated 844 - escalated
1377 - critical 845 - critical
1378 - date
1379 846
1380 StatusChange: 847 StatusChange:
1381 type: object 848 type: object
1382 description: Holds the status, reason and associated date the status changed, populated by the server. 849 description: Holds the status, reason and associated date the status changed, populated by the server.
1383 properties: 850 properties:
1384 changeDate: 851 changeDate:
1385 type: string 852 type: string
1386 description: The date and time the status changed. 853 description: The date and time the status changed.
1387 format: date-time 854 format: date-time
1388 changeReason: 855 changeReason:
1389 type: string 856 type: string
1390 description: The reason for changing the status. 857 description: The reason for changing the status.
1391 status: 858 status:
1392 $ref: '#/components/schemas/StatusType' 859 $ref: '#/components/schemas/StatusType'
1393 description: The status of the clearing ticket. 860 description: The status of the clearing ticket.
1394 861
1395 StatusChangeResolved: 862 StatusChangeResolved:
1396 # Combines the main `StatusChange`` schema with `Resolve`-specific properties 863 # Combines the main `StatusChange`` schema with `Resolve`-specific properties
1397 allOf: 864 allOf:
1398 - $ref: '#/components/schemas/StatusChange' 865 - $ref: '#/components/schemas/StatusChange'
1399 - type: object 866 - type: object
1400 properties: 867 properties:
1401 resolveAttachment: 868 resolveAttachment:
1402 type: array 869 type: array
1403 description: Attachments for the state transition -> resolved 870 description: Attachments for the state transition -> resolved
1404 items: 871 items:
1405 $ref: '#/components/schemas/Attachment' 872 $ref: '#/components/schemas/Attachment'
1406 resolvedSuccessfully: 873 resolvedSuccessfully:
1407 type: boolean 874 type: boolean
1408 description: When the processor resolves an issue this parameter must be set to indicate if the clearing ticket has been successfully processed as requested. 875 description: When the processor resolves an issue this parameter must be set to indicate if the clearing ticket has been successfully processed as requested.
1409 876
1410 StatusType: 877 StatusType:
1411 type: string 878 type: string
1412 description: The current status of the clearing ticket. Status is one of the following. 879 description: The current status of the clearing ticket. Status is one of the following.
1413 enum: 880 enum:
1414 - initial
1415 - acknowledged 881 - acknowledged
1416 - rejected
1417 - pending 882 - pending
1418 - held 883 - held
1419 - inProgress 884 - inProgress
1420 - cancelled 885 - cancelled
1421 - closed 886 - closed
1422 - resolved 887 - resolved
1423 - final 888 - final
1424 889
1425 ClearingData: 890 ClearingData:
1426 type: object 891 type: object
1427 description: The data relevant for the clearing case. 892 description: The data relevant for the clearing case.
1428 properties: 893 properties:
1429 contractNumber: 894 contractNumber:
1430 $ref: '#/components/schemas/ExternalIdentifier' 895 $ref: '#/components/schemas/ExternalIdentifier'
1431 description: | 896 description: |
1432 Expected externalIdentifierTypes are: 897 Expected externalIdentifierTypes are:
1433 * __witaContractNumber:__ WITA contract number, only provided if relevant to solve the clearing ticket. 898 * __witaContractNumber:__ WITA contract number, only provided if relevant to solve the clearing ticket.
1434 * __spriContractNumber:__ SPRI contract number, only provided if relevant to solve the clearing ticket. 899 * __spriContractNumber:__ SPRI contract number, only provided if relevant to solve the clearing ticket.
1435 * __xyzContractNumber:__ Contract number if neither WITA nor S/PRI e.g. voice provider. 900 * __xyzContractNumber:__ Contract number if neither WITA nor S/PRI e.g. voice provider.
1436 901
1437 externalIdentifier: 902 externalIdentifier:
1438 description: | 903 description: |
1439 Expected externalIdentifierTypes are: 904 Expected externalIdentifierTypes are:
1440 * __externalOrderId:__ External Order Id of the order that shall be cleared. This may be the 'externe Auftragsnummer' of the WBCI, WITA, S/PRI or another proprietry API. 905 * __externalOrderId:__ External Order Id of the order that shall be cleared. This may be the 'externe Auftragsnummer' of the WBCI, WITA, S/PRI or another proprietry API.
1441 * __lineID:__ Id assigned by the supplier for the service. example: '1234567890' 906 * __lineID:__ Id assigned by the supplier for the service. example: '1234567890'
1442 * __prenegotiationId:__ WBCI ID that is associated with the order to be cleared. 907 * __prenegotiationId:__ WBCI ID that is associated with the order to be cleared.
1443 * __prenegotiationChangeId:__ WBCI ID that is associated with the order to be cleared. 908 * __prenegotiationChangeId:__ WBCI ID that is associated with the order to be cleared.
1444 * __externalOrderIdServiceApi:__ External ID used to send the order to the service API . 909 * __externalOrderIdServiceApi:__ External ID used to send the order to the service API .
1445 * __externalOrderIdTroubleTicketApi:__ External ID used to send the order to ESS. 910 * __externalOrderIdTroubleTicketApi:__ External ID used to send the order to ESS.
1446 * __technicalLineIdentifier:__ Technical line identification assigned by the network owner to identify the physical line. 911 * __technicalLineIdentifier:__ Technical line identification assigned by the network owner to identify the physical line.
1447 * __bnetzaId__: Case id of 'Bundesnetzagentur' 912 * __bnetzaId__: Case id of 'Bundesnetzagentur'
1448 * __homeId__: Used to identify a fibre socket.' 913 * __homeId__: Used to identify a fibre socket.'
1449 type: array 914 type: array
1450 items: 915 items:
1451 $ref: '#/components/schemas/ExternalIdentifier' 916 $ref: '#/components/schemas/ExternalIdentifier'
1452 ndc: 917 ndc:
1453 type: string 918 type: string
1454 description: national destination code. 919 description: national destination code.
1455 phone: 920 phone:
1456 type: array 921 type: array
1457 items: 922 items:
1458 $ref: '#/components/schemas/Phone' 923 $ref: '#/components/schemas/Phone'
1459 customer: 924 customer:
1460 $ref: '#/components/schemas/Customer' 925 $ref: '#/components/schemas/Customer'
1461 address: 926 address:
1462 $ref: '#/components/schemas/Address' 927 $ref: '#/components/schemas/Address'
1463 requestedDate: 928 requestedDate:
1464 type: string 929 type: string
1465 description: Date requested by the end-customer ( KWT = Kundenwunschtermin). 930 description: Date requested by the end-customer ( KWT = Kundenwunschtermin).
1466 format: date 931 format: date
1467 confirmedDate: 932 confirmedDate:
1468 type: string 933 type: string
1469 description: Delivery date as confirmed by the supplier (VLT = Verbindlicher Liefertermin). In WITA or S/PRI environment this date is sent in the latest ABM message. 934 description: Delivery date as confirmed by the supplier (VLT = Verbindlicher Liefertermin). In WITA or S/PRI environment this date is sent in the latest ABM message.
1470 format: date 935 format: date
1471 agreedSwitchDate: 936 agreedSwitchDate:
1472 type: string 937 type: string
1473 description: Date as agreed between the EKPabg and the EKPauf in pre-negotiation (WBCI). 938 description: Date as agreed between the EKPabg and the EKPauf in pre-negotiation (WBCI).
1474 format: date 939 format: date
1475 portingDate: 940 portingDate:
1476 type: string 941 type: string
1477 description: "Date when the phone numbers are ported as used by PDA. (PDA = Portings-Daten-Austausch. Intended for Weiterversorgung)" 942 description: "Date when the phone numbers are ported as used by PDA. (PDA = Portings-Daten-Austausch. Intended for Weiterversorgung)"
1478 format: date 943 format: date
1479 prolongationDate: 944 prolongationDate:
1480 type: string 945 type: string
1481 description: Date until when the prolongation shall be active. 946 description: Date until when the prolongation shall be active.
1482 format: date 947 format: date
1483 prolongationCompleted: 948 prolongationCompleted:
1484 type: string 949 type: string
1485 description: Date when the prolongation has been stopped. 950 description: Date when the prolongation has been stopped.
1486 format: date 951 format: date
1487 prolongationChange: 952 prolongationChange:
1488 type: string 953 type: string
1489 description: Reason for the change of prolongation, should be selected from a list of pre-assigned values or might be any text. 954 description: Reason for the change of prolongation, should be selected from a list of pre-assigned values or might be any text.
1490 initialSwitchDate: 955 initialSwitchDate:
1491 type: string 956 type: string
1492 description: Latest agreed switching date before the prolongation. 957 description: Latest agreed switching date before the prolongation.
1493 format: date 958 format: date
1494 troubleTicketToBeClearedCreationDate: 959 troubleTicketToBeClearedCreationDate:
1495 type: string 960 type: string
1496 description: Date when the trouble ticket was created (only used for trouble tickets). 961 description: Date when the trouble ticket was created (only used for trouble tickets).
1497 format: date 962 format: date
1498 pkiAuf: 963 pkiAuf:
1499 type: string 964 type: string
1500 description: Id of the new voice carrier (Portierungskennungs-Inhaber aufnehmend) e.g. D123 Portierungskennungen are assigned by Bundenetzagentur and are not identical to the ItuCarrier Id. 965 description: Id of the new voice carrier (Portierungskennungs-Inhaber aufnehmend) e.g. D123 Portierungskennungen are assigned by Bundenetzagentur and are not identical to the ItuCarrier Id.
1501 pkiAbg: 966 pkiAbg:
1502 type: string 967 type: string
1503 description: PKI id of the old voice carrier (Portierungskennungs-Inhaber abgebend). Portierungskennungen are assigned by Bundenetzagentur. 968 description: PKI id of the old voice carrier (Portierungskennungs-Inhaber abgebend). Portierungskennungen are assigned by Bundenetzagentur.
1504 ekpAuf: 969 ekpAuf:
1505 type: string 970 type: string
1506 description: End-customer contract holder new (Endkundenvertragspartner aufnehmend) ItuCarrier Id 971 description: End-customer contract holder new (Endkundenvertragspartner aufnehmend) ItuCarrier Id
1507 ekpAbg: 972 ekpAbg:
1508 type: string 973 type: string
1509 description: End-customer contract holder old (Endkundenvertragspartner abgebend) ItuCarrier Id 974 description: End-customer contract holder old (Endkundenvertragspartner abgebend) ItuCarrier Id
1510 nga: 975 nga:
1511 type: string 976 type: string
1512 description: "Next Generation Access “Betreiber”. ITU-Carrier Id" 977 description: "Next Generation Access “Betreiber”. ITU-Carrier Id"
1513 additionalInformation: 978 additionalInformation:
1514 type: string 979 type: string
1515 description: "Additional information required for solving this issue. This information shall be human readable" 980 description: "Additional information required for solving this issue. This information shall be human readable"
1516 troubleTicketRequest: 981 troubleTicketRequest:
1517 $ref: '#/components/schemas/TroubleTicketRequest' 982 $ref: '#/components/schemas/TroubleTicketRequest'
1518 error: 983 error:
1519 $ref: '#/components/schemas/ClearingDataError' 984 $ref: '#/components/schemas/ClearingDataError'
1520 testCall: 985 testCall:
1521 $ref: '#/components/schemas/TestCall' 986 $ref: '#/components/schemas/TestCall'
1522 specialAgreements: 987 specialAgreements:
1523 type: string 988 type: string
1524 description: Any special agreements between the two partners that are important for this clearing ticket e.g. project IDs 989 description: Any special agreements between the two partners that are important for this clearing ticket e.g. project IDs
1525 attachment: 990 attachment:
1526 type: array 991 type: array
1527 description: Attachments for clearing scenario, e.g. contract, phone number lists 992 description: Attachments for clearing scenario, e.g. contract, phone number lists
1528 items: 993 items:
1529 $ref: '#/components/schemas/Attachment' 994 $ref: '#/components/schemas/Attachment'
1530 995
1531 ExternalIdentifier: 996 ExternalIdentifier:
1532 type: object 997 type: object
1533 description: External reference in other system 998 description: External reference in other system
1534 properties: 999 properties:
1535 externalIdentifierType: 1000 externalIdentifierType:
1536 type: string 1001 type: string
1537 description: Type of the external identifier 1002 description: Type of the external identifier
1538 id: 1003 id:
1539 type: string 1004 type: string
1540 description: Id of the external identifier 1005 description: Id of the external identifier
1541 '@type': 1006 '@type':
1542 type: string 1007 type: string
1543 description: "Constant: ExternalIdentifier" 1008 description: "Constant: ExternalIdentifier"
1544 1009
1545 Phone: 1010 Phone:
1546 type: object 1011 type: object
1547 description: Struct to carry the phone number in E.164 format. 1012 description: Struct to carry the phone number in E.164 format.
1548 properties: 1013 properties:
1549 ndc: 1014 ndc:
1550 type: string 1015 type: string
1551 description: The National Destination Code part of this phone number without leading “0”. ()Vorwahl) e.g. 89, 5241,30. For details refer to ITU-T E.101 1016 description: The National Destination Code part of this phone number without leading “0”. ()Vorwahl) e.g. 89, 5241,30. For details refer to ITU-T E.101
1552 sn: 1017 sn:
1553 type: string 1018 type: string
1554 description: The Subscriber number part of this phone number. (Hauptwahl) Either the sn or a block has to be present. For details refer to ITU-T E.101 1019 description: The Subscriber number part of this phone number. (Hauptwahl) Either the sn or a block has to be present. For details refer to ITU-T E.101
1555 blockPrefix: 1020 blockPrefix:
1556 type: string 1021 type: string
1557 description: Prefix of the number block e.g. 181 1022 description: Prefix of the number block e.g. 181
1558 blockStart: 1023 blockStart:
1559 type: string 1024 type: string
1560 description: First number in the number block e.g. 000 1025 description: First number in the number block e.g. 000
1561 blockEnd: 1026 blockEnd:
1562 type: string 1027 type: string
1563 description: Last number in the number block e.g. 999 1028 description: Last number in the number block e.g. 999
1564 1029
1565 Customer: 1030 Customer:
1566 type: object 1031 type: object
1567 description: Structure to carry end-customer data. 1032 description: Structure to carry end-customer data.
1568 properties: 1033 properties:
1569 individual: 1034 individual:
1570 $ref: '#/components/schemas/CustomerIndividual' 1035 $ref: '#/components/schemas/CustomerIndividual'
1571 organization: 1036 organization:
1572 $ref: '#/components/schemas/CustomerOrganization' 1037 $ref: '#/components/schemas/CustomerOrganization'
1573 1038
1574 CustomerIndividual: 1039 CustomerIndividual:
1575 type: object 1040 type: object
1576 description: "The individual customer as used by the original order." 1041 description: "The individual customer as used by the original order."
1577 properties: 1042 properties:
1578 givenName: 1043 givenName:
1579 type: string 1044 type: string
1580 description: Givenname of the customer, used to identify the customer associated with this clearing as used in the original request. 1045 description: Givenname of the customer, used to identify the customer associated with this clearing as used in the original request.
1581 familyName: 1046 familyName:
1582 type: string 1047 type: string
1583 description: Familyname of the customer, used to identify the customer associated with this clearing as used in the original request. 1048 description: Familyname of the customer, used to identify the customer associated with this clearing as used in the original request.
1584 "@type": 1049 "@type":
1585 type: string 1050 type: string
1586 description: "Constant: Individual" 1051 description: "Constant: Individual"
1587 1052
1588 CustomerOrganization: 1053 CustomerOrganization:
1589 type: object 1054 type: object
1590 description: "The organization customer as used by the original order." 1055 description: "The organization customer as used by the original order."
1591 properties: 1056 properties:
1592 tradingName: 1057 tradingName:
1593 type: string 1058 type: string
1594 description: The company name of the customer, used to identify the customer associated with this clearing, as used in the original request. 1059 description: The company name of the customer, used to identify the customer associated with this clearing, as used in the original request.
1595 "@type": 1060 "@type":
1596 type: string 1061 type: string
1597 description: "Constant: Organization" 1062 description: "Constant: Organization"
1598 1063
1599 Address: 1064 Address:
1600 type: object 1065 type: object
1601 description: Structure containing the physical address of the line. 1066 description: Structure containing the physical address of the line.
1602 properties: 1067 properties:
1603 streetName: 1068 streetName:
1604 type: string 1069 type: string
1605 description: Name of the street. 1070 description: Name of the street.
1606 streetNr: 1071 streetNr:
1607 type: string 1072 type: string
1608 description: Number identifying a specific property on a public street. 1073 description: Number identifying a specific property on a public street.
1609 streetNrSuffix: 1074 streetNrSuffix:
1610 type: string 1075 type: string
1611 description: a suffix for the housenumber. e.g. b or -35 1076 description: a suffix for the housenumber. e.g. b or -35
1612 postcode: 1077 postcode:
1613 type: string 1078 type: string
1614 description: Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as postcode). 1079 description: Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as postcode).
1615 city: 1080 city:
1616 type: string 1081 type: string
1617 description: City that the address is in. 1082 description: City that the address is in.
1618 locality: 1083 locality:
1619 type: string 1084 type: string
1620 description: An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature. A suburb, a bounded locality within a city, town or shire principally of urban character. (Ortsteil) 1085 description: An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature. A suburb, a bounded locality within a city, town or shire principally of urban character. (Ortsteil)
1621 "@type": 1086 "@type":
1622 type: string 1087 type: string
1623 description: "Constant: GeographicAddress" 1088 description: "Constant: GeographicAddress"
1624 1089
1625 TroubleTicketRequest: 1090 TroubleTicketRequest:
1626 type: object 1091 type: object
1627 description: New date and time for an appointment at the end customer’s site. 1092 description: New date and time for an appointment at the end customer’s site.
1628 properties: 1093 properties:
1629 validFor: 1094 validFor:
1630 $ref: '#/components/schemas/TroubleTicketRequestValidFor' 1095 $ref: '#/components/schemas/TroubleTicketRequestValidFor'
1631 category: 1096 category:
1632 type: string 1097 type: string
1633 description: "Constant: On-Site" 1098 description: "Constant: On-Site"
1634 "@type": 1099 "@type":
1635 type: string 1100 type: string
1636 description: "Constant Appointment" 1101 description: "Constant Appointment"
1637 1102
1638 TroubleTicketRequestValidFor: 1103 TroubleTicketRequestValidFor:
1639 type: object 1104 type: object
1640 properties: 1105 properties:
1641 startDateTime: 1106 startDateTime:
1642 type: string 1107 type: string
1643 description: "Start date and time for the appointment." 1108 description: "Start date and time for the appointment."
1644 format: date-time 1109 format: date-time
1645 endDateTime: 1110 endDateTime:
1646 type: string 1111 type: string
1647 description: "End date and time for the appointment." 1112 description: "End date and time for the appointment."
1648 format: date-time 1113 format: date-time
1649 "@type": 1114 "@type":
1650 type: string 1115 type: string
1651 description: "Constant TroubleTicketRequestValidFor" 1116 description: "Constant TroubleTicketRequestValidFor"
1652 1117
1653 ClearingDataError: 1118 ClearingDataError:
1654 type: object 1119 type: object
1655 description: Error code and text as transmitted in the original response that shall be cleared. 1120 description: Error code and text as transmitted in the original response that shall be cleared.
1656 properties: 1121 properties:
1657 code: 1122 code:
1658 type: string 1123 type: string
1659 description: Message code provided by the supplier that caused this clearing (Meldungscode) 1124 description: Message code provided by the supplier that caused this clearing (Meldungscode)
1660 text: 1125 text:
1661 type: string 1126 type: string
1662 description: Message text provided by supplier that caused this clearing (Meldungstext). 1127 description: Message text provided by supplier that caused this clearing (Meldungstext).
1663 1128
1664 TestCall: 1129 TestCall:
1665 type: object 1130 type: object
1666 properties: 1131 properties:
1667 source: 1132 source:
1668 type: string 1133 type: string
1669 description: Originating number used for testcall. 1134 description: Originating number used for testcall.
1670 destination: 1135 destination:
1671 type: string 1136 type: string
1672 description: Destination number used for testcall. 1137 description: Destination number used for testcall.
1673 timestamp: 1138 timestamp:
1674 type: string 1139 type: string
1675 description: Date and time the testcall was started. 1140 description: Date and time the testcall was started.
1676 format: date-time 1141 format: date-time
1677 statusCode: 1142 statusCode:
1678 type: string 1143 type: string
1679 description: The release code provided by the switch for the testcall. 1144 description: The release code provided by the switch for the testcall.
1680 1145
1681 TroubleTicketRelationship: 1146 TroubleTicketRelationship:
1682 type: object 1147 type: object
1683 properties: 1148 properties:
1684 id: 1149 id:
1685 type: string 1150 type: string
1686 description: Unique identifier of the Trouble Ticket 1151 description: Unique identifier of the Trouble Ticket
1687 href: 1152 href:
1688 type: string 1153 type: string
1689 description: Reference of the Trouble Ticket 1154 description: Reference of the Trouble Ticket
1690 name: 1155 name:
1691 type: string 1156 type: string
1692 description: Name of the Trouble Ticket 1157 description: Name of the Trouble Ticket
1693 relationshipType: 1158 relationshipType:
1694 type: string 1159 type: string
1695 description: Type of the Trouble Ticket relationship. 1160 description: Type of the Trouble Ticket relationship.
1696 '@type': 1161 '@type':
1697 type: string 1162 type: string
1698 description: "Constant: TroubleTicketRelationship" 1163 description: "Constant: TroubleTicketRelationship"
1699 description: Represents a relationship between trouble Trouble Tickets 1164 description: Represents a relationship between trouble Trouble Tickets
1700 1165
1701 Attachment: 1166 Attachment:
1702 type: object 1167 type: object
1703 description: An attachment, content not embedded but referenced by an URL 1168 description: An attachment, content not embedded but referenced by an URL
1704 properties: 1169 properties:
1705 id: 1170 id:
1706 type: string 1171 type: string
1707 description: The unique id of the attachment 1172 description: The unique id of the attachment
1708 name: 1173 name:
1709 type: string 1174 type: string
1710 description: The (file)name of the attachment 1175 description: The (file)name of the attachment
1711 role: 1176 role:
1712 type: string 1177 type: string
1713 description: The role of the attachment 1178 description: The role of the attachment
1714 mimeType: 1179 mimeType:
1715 type: string 1180 type: string
1716 description: Attachment mime type such as extension file for video, picture and document 1181 description: Attachment mime type such as extension file for video, picture and document
1717 href: 1182 href:
1718 type: string 1183 type: string
1719 description: Reference of the Attachment. 1184 description: Reference of the Attachment.
1720 size: 1185 size:
1721 type: integer 1186 type: integer
1722 description: The size of the attachment in bytes. 1187 description: The size of the attachment in bytes.
1723 1188
1724 ClearingTicketCreateEvent: 1189 ClearingTicketCreateEvent:
1725 type: object 1190 type: object
1726 description: The notification for a clearing ticket creation. 1191 description: The notification for a clearing ticket creation.
1727 properties: 1192 properties:
1728 eventTime: 1193 eventTime:
1729 type: string 1194 type: string
1730 format: date-time 1195 format: date-time
1731 description: Time of the event occurrence. 1196 description: Time of the event occurrence.
1732 clearingTicket: 1197 clearingTicket:
1733 $ref: '#/components/schemas/ClearingTicket' 1198 $ref: '#/components/schemas/ClearingTicket'
1734 "@type": 1199 "@type":
1735 description: "the type of this entity: ClearingTicketCreateEvent" 1200 description: "the type of this entity: ClearingTicketCreateEvent"
1736 type: string 1201 type: string
1737 1202
1738 ClearingTicketDataChangeEvent: 1203 ClearingTicketDataChangeEvent:
1739 type: object 1204 type: object
1740 description: The notification for a clearing ticket data change. 1205 description: The notification for a clearing ticket data change.
1741 properties: 1206 properties:
1742 eventTime: 1207 eventTime:
1743 type: string 1208 type: string
1744 format: date-time 1209 format: date-time
1745 data: 1210 data:
1746 $ref: '#/components/schemas/ClearingData' 1211 $ref: '#/components/schemas/ClearingData'
1747 clearingTicket: 1212 clearingTicket:
1748 $ref: '#/components/schemas/ClearingTicket' 1213 $ref: '#/components/schemas/ClearingTicket'
1749 "@type": 1214 "@type":
1750 description: "the type of this entity: ClearingTicketDataChangeEvent" 1215 description: "the type of this entity: ClearingTicketDataChangeEvent"
1751 type: string 1216 type: string
1752 1217
1753 ClearingTicketStatusChangeEvent: 1218 ClearingTicketStatusChangeEvent:
1754 type: object 1219 type: object
1755 description: The notification for a clearing ticket status change. 1220 description: The notification for a clearing ticket status change.
1756 properties: 1221 properties:
1757 eventTime: 1222 eventTime:
1758 type: string 1223 type: string
1759 format: date-time 1224 format: date-time
1760 status: 1225 status:
1761 $ref: '#/components/schemas/StatusChange' 1226 $ref: '#/components/schemas/StatusChange'
1762 clearingTicket: 1227 clearingTicket:
1763 $ref: '#/components/schemas/ClearingTicket' 1228 $ref: '#/components/schemas/ClearingTicket'
1764 "@type": 1229 "@type":
1765 description: "the type of this entity: ClearingTicketStatusChangeEvent" 1230 description: "the type of this entity: ClearingTicketStatusChangeEvent"
1766 type: string 1231 type: string
1767 1232
1768 ClearingTicketResolvedEvent: 1233 ClearingTicketResolvedEvent:
1769 type: object 1234 type: object
1770 description: The notification for a clearing ticketstatus resolution. 1235 description: The notification for a clearing ticketstatus resolution.
1771 properties: 1236 properties:
1772 eventTime: 1237 eventTime:
1773 type: string 1238 type: string
1774 format: date-time 1239 format: date-time
1775 resolved: 1240 resolved:
1776 $ref: '#/components/schemas/StatusChangeResolved' 1241 $ref: '#/components/schemas/StatusChangeResolved'
1777 clearingTicket: 1242 clearingTicket:
1778 $ref: '#/components/schemas/ClearingTicket' 1243 $ref: '#/components/schemas/ClearingTicket'
1779 "@type": 1244 "@type":
1780 description: "the type of this entity: ClearingTicketResolvedEvent" 1245 description: "the type of this entity: ClearingTicketResolvedEvent"
1781 type: string 1246 type: string
1782 1247
1783 ClearingTicketSeverityChangeEvent: 1248 ClearingTicketSeverityChangeEvent:
1784 type: object 1249 type: object
1785 description: The notification for a clearing ticket severity change. 1250 description: The notification for a clearing ticket severity change.
1786 properties: 1251 properties:
1787 eventTime: 1252 eventTime:
1788 type: string 1253 type: string
1789 format: date-time 1254 format: date-time
1790 severity: 1255 severity:
1791 $ref: '#/components/schemas/Severity' 1256 $ref: '#/components/schemas/Severity'
1792 clearingTicket: 1257 clearingTicket:
1793 $ref: '#/components/schemas/ClearingTicket' 1258 $ref: '#/components/schemas/ClearingTicket'
1794 "@type": 1259 "@type":
1795 description: "the type of this entity: ClearingTicketSeverityChangeEvent" 1260 description: "the type of this entity: ClearingTicketSeverityChangeEvent"
1796 type: string 1261 type: string
1797 1262
1798 ClearingTicketNoteAddEvent: 1263 ClearingTicketNoteAddEvent:
1799 type: object 1264 type: object
1800 description: The notification for a new note for the clearing ticket. 1265 description: The notification for a new note for the clearing ticket.
1801 properties: 1266 properties:
1802 eventTime: 1267 eventTime:
1803 type: string 1268 type: string
1804 format: date-time 1269 format: date-time
1805 note: 1270 note:
1806 $ref: '#/components/schemas/Note' 1271 $ref: '#/components/schemas/Note'
1807 clearingTicket: 1272 clearingTicket:
1808 $ref: '#/components/schemas/ClearingTicket' 1273 $ref: '#/components/schemas/ClearingTicket'
1809 "@type": 1274 "@type":
1810 description: "the type of this entity: ClearingTicketNoteAddEvent" 1275 description: "the type of this entity: ClearingTicketNoteAddEvent"
1811 type: string 1276 type: string
1812 1277
1813 Organization: 1278 Organization:
1814 type: object 1279 type: object
1815 description: Organization (ItuCarrier) 1280 description: Organization (ItuCarrier)
1816 required: 1281 required:
1817 - id 1282 - id
1818 properties: 1283 properties:
1819 id: 1284 id:
1820 type: string 1285 type: string
1821 description: Unique identifier of the ItuCarrier - DEU.XXXXX 1286 description: Unique identifier of the ItuCarrier - DEU.XXXXX
1822 tradingName: 1287 tradingName:
1823 type: string 1288 type: string
1824 description: Name that the organization (unit) trades under 1289 description: Name that the organization (unit) trades under
1825 organizationType: 1290 organizationType:
1826 type: string 1291 type: string
1827 description: "the type of this organization: ItuCarrier" 1292 description: "the type of this organization: ItuCarrier"
1828 href: 1293 href:
1829 description: Hyperlink, a reference to the ItuCarrier Organization entity 1294 description: Hyperlink, a reference to the ItuCarrier Organization entity
1830 type: string 1295 type: string
1831 "@type": 1296 "@type":
1832 description: "the type of this entity: Organization" 1297 description: "the type of this entity: Organization"
1833 type: string 1298 type: string
Ruleset: _Default_ | Mode: All | Tab: 8