forked from before-interop/E-Intervention
-
Notifications
You must be signed in to change notification settings - Fork 0
/
E-Intervention-v1.0.0.swagger.json
527 lines (527 loc) · 13.9 KB
/
E-Intervention-v1.0.0.swagger.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
{
"swagger": "2.0",
"info": {
"description": "Spécification des ressources qui devront être exposées par les différents acteurs impliqués par le protocole E-Intervention.",
"version": "1.0.0",
"title": "E-Intervention"
},
"host": "serverRoot",
"basePath": "/v1",
"tags": [
{
"name": "client",
"description": "Opérations liées aux clients"
},
{
"name": "intervention",
"description": "Opérations liées aux interventions"
}
],
"schemes": [
"https"
],
"paths": {
"/client_HS_OC_Par_Inter": {
"post": {
"tags": [
"client"
],
"summary": "Flux 3 - Flux de déclaration des lignes impactées des OC vers l’OI (facultatif)",
"description": "Opération permettant à l'opérateur commercial de déclarer des clients HS auprès de l'OI",
"operationId": "notifier_Clients_HS_OC",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Liste des clients coupés lors d'une intervention donnée pour un opérateur commercial donné",
"required": true,
"schema": {
"$ref": "#/definitions/client_HS_OC_Par_Inter"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/reponse_Client_HS_OC_Par_Inter"
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Référence refIntervOI inconnue"
},
"405": {
"description": "Validation exception"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api_auth": [
"write:clients"
]
}
]
}
},
"/intervention_DO": {
"post": {
"tags": [
"intervention"
],
"summary": "Flux 1 - Flux de déclaration d’intervention du DO vers l’OI",
"description": "Opération permettant au DO de créer et mettre à jour une intervention chez l’OI",
"operationId": "declarer_Intervention_DO",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Objet intervention à déclarer chez l'OI",
"required": true,
"schema": {
"$ref": "#/definitions/intervention_DO"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/reponse_Intervention_DO"
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"405": {
"description": "Validation exception"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api_auth": [
"write:interventions"
]
}
]
}
},
"/intervention_OI": {
"post": {
"tags": [
"intervention"
],
"summary": "Flux 2 - Flux de déclaration d’intervention de l’OI vers les OC présents sur le PM",
"description": "Opération permettant à l'OI de créer et mettre à jour une intervention chez l’OC",
"operationId": "declarer_Intervention_OI",
"consumes": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Objet intervention à déclarer chez l'OC",
"required": true,
"schema": {
"$ref": "#/definitions/intervention_OI"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/reponse_Intervention_OI"
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"405": {
"description": "Validation exception"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api_auth": [
"write:interventions"
]
}
]
}
}
},
"securityDefinitions": {
"api_auth": {
"type": "oauth2",
"authorizationUrl": "http://serverRoot/oauth/dialog",
"flow": "implicit",
"scopes": {
"write:clients": "Ecrire des infos clients",
"write:interventions": "Ecrire des infos interventions"
}
}
},
"definitions": {
"client_HS_OC_Par_Inter": {
"type": "object",
"required": [
"Code_OC_impacte",
"Ref_Interv_OI"
],
"properties": {
"Code_OC_impacte": {
"type": "string",
"maxLength": 4,
"description": "Code opérateur Interop de celui ayant des clients impactés\n"
},
"Ref_Interv_OI": {
"type": "string",
"maxLength": 50,
"description": "Référence d’intervention unique produite par l'OI\n"
},
"Liste_Clients_HS": {
"type": "array",
"items": {
"$ref": "#/definitions/client_HS_OC"
}
}
},
"xml": {
"name": "client_HS_OC_Par_Inter"
}
},
"client_HS_OC": {
"type": "object",
"description": "Conditionnel : au moins 1 client KO Liste des routes optiques de chaque client HS au PM dont l'heure de coupure est comprise dans l'intervalle\n",
"required": [
"PTO",
"PBO",
"Tube",
"Fibre",
"Position_PM_Module_OI",
"HMS_Coupure"
],
"properties": {
"PTO": {
"type": "string",
"maxLength": 50
},
"PBO": {
"type": "string",
"maxLength": 50
},
"Tube": {
"type": "string",
"maxLength": 50
},
"Fibre": {
"type": "string",
"maxLength": 50
},
"Position_PM_Module_OI": {
"type": "string",
"maxLength": 100
},
"HMS_Coupure": {
"type": "string",
"format": "date-time",
"description": "Date/heure de début de coupure pour le client (format selon la norme ISO 8601) \n"
}
},
"xml": {
"name": "client_HS_OC"
}
},
"intervention_DO": {
"type": "object",
"required": [
"Code_DO",
"Code_OI",
"Ref_Interv_DO",
"PM",
"Nature_PBO_PTO",
"Debut_Inter"
],
"properties": {
"Code_DO": {
"type": "string",
"maxLength": 4,
"description": "Code opérateur Interop du donneur d'ordre\n"
},
"Code_OI": {
"type": "string",
"maxLength": 4,
"description": "Code opérateur Interop de l'opérateur d'infrastructure\n"
},
"Ref_Interv_DO": {
"type": "string",
"maxLength": 50,
"description": "Référence d'intervention unique produite par le donneur d'ordre et identique sur M1 et M3\n"
},
"PM": {
"type": "string",
"maxLength": 50,
"description": "Référence réglementaire du PM (ex: FI-XXXXX-XXXX)\n"
},
"Nature_PBO_PTO": {
"type": "array",
"items": {
"$ref": "#/definitions/nature_PBO_PTO"
}
},
"Debut_Inter": {
"type": "string",
"format": "date-time",
"description": "Date/heure de début réel d'intervention (format selon la norme ISO 8601)\n"
},
"Fin_Inter": {
"type": "string",
"format": "date-time",
"description": "Valeur NULL si M1 Date/heure de fin réel d'intervention si M3 (format selon la norme ISO 8601)\n"
}
},
"xml": {
"name": "intervention_DO"
}
},
"intervention_OI": {
"type": "object",
"required": [
"Code_OI",
"Ref_Interv_OI",
"PM",
"Debut_Inter"
],
"properties": {
"Code_OI": {
"type": "string",
"maxLength": 4,
"description": "Code opérateur Interop de l'opérateur d'infrastructure\n"
},
"Ref_Interv_OI": {
"type": "string",
"maxLength": 50,
"description": "Référence d’intervention unique produite par l’OI dans R M1/R M3\n"
},
"PM": {
"type": "string",
"maxLength": 50,
"description": "Référence réglementaire du PM (ex: FI-XXXXX-XXXX)\n"
},
"PBO": {
"type": "array",
"items": {
"$ref": "#/definitions/PBO"
}
},
"Debut_Inter": {
"type": "string",
"format": "date-time",
"description": "Date/heure de début réel d'intervention (format selon la norme ISO 8601)\n"
},
"Fin_Inter": {
"type": "string",
"format": "date-time",
"description": "Valeur NULL si M2 Date/heure de fin réel d'intervention si M4 (format selon la norme ISO 8601)\n"
}
},
"xml": {
"name": "intervention_OI"
}
},
"nature_PBO_PTO": {
"type": "object",
"required": [
"nature"
],
"properties": {
"nature": {
"type": "integer",
"format": "int32",
"enum": [
1,
2,
3,
4,
5,
6
],
"description": "Nature finale de l'intervention, valeurs possibles : 1 = RACC PTO à construire 2 = RACC PTO existante 3 = RACC hotline 4 = SAV OC 5 = SAV OI 6 = NON FOURNIE (valeur possible permettant de rendre facultatif la fourniture de l'information)\n"
},
"PBO": {
"type": "string",
"maxLength": 50,
"description": "Référence PBO (Ex: PTXXXXXXX) si disponible\n"
},
"PTO": {
"type": "string",
"maxLength": 50,
"description": "Référence PTO (Ex: FI-YYYY-YYYY) si disponible\n"
}
},
"xml": {
"name": "nature_PBO_PTO"
}
},
"PBO": {
"type": "object",
"properties": {
"PBO": {
"type": "string",
"maxLength": 50,
"description": "Référence du PBO (ex: PTXXXXXXX) si fourni par le DO\n"
}
},
"xml": {
"name": "PBO"
}
},
"reponse_Client_HS_OC_Par_Inter": {
"type": "object",
"required": [
"Code_Reponse",
"Libelle_Reponse"
],
"properties": {
"Code_Reponse": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3
],
"description": "0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si REF_INTERV_OI_INCONNUE\n"
},
"Libelle_Reponse": {
"type": "string",
"enum": [
"OK",
"CHAMPS_NON_RENSEIGNE",
"MAUVAIS_FORMAT",
"REF_INTERV_OI_INCONNUE"
]
}
}
},
"reponse_Intervention_DO": {
"type": "object",
"required": [
"Code_Reponse",
"Libelle_Reponse"
],
"properties": {
"Code_Reponse": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3,
4
],
"description": "0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si CODE_OI_INCONNU 4 si PM_INCONNU\n"
},
"Libelle_Reponse": {
"type": "string",
"enum": [
"OK",
"CHAMPS_NON_RENSEIGNE",
"MAUVAIS_FORMAT",
"CODE_OI_INCONNU",
"PM_INCONNU"
]
},
"Ref_Interv_OI": {
"type": "string",
"maxLength": 50,
"description": "Conditionnel: si Libelle_Reponse = OK Référence d'intervention unique produite par l'opérateur d'infrastructure\n"
}
}
},
"reponse_Intervention_OI": {
"type": "object",
"required": [
"Code_Reponse",
"Libelle_Reponse"
],
"properties": {
"Code_Reponse": {
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3
],
"description": "0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si CODE_OI_INCONNU 4 si PM_INCONNU\n"
},
"Libelle_Reponse": {
"type": "string",
"enum": [
"OK",
"CHAMPS_NON_RENSEIGNE",
"MAUVAIS_FORMAT",
"CODE_OI_INCONNU",
"PM_INCONNU"
]
}
}
}
},
"externalDocs": {
"description": "Groupe Interop'Fibre",
"url": "https://www.interop-fibre.fr/"
}
}