-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathopenapi.yaml
1327 lines (1183 loc) · 50.7 KB
/
openapi.yaml
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
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: AnomalieAdresse API
version: 2.0.0
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
description: |
## Workflow
## Types de signalement
## Pagination
Les listes de ressources sont paginées.
* La valeur par défaut d'une page est `limit=50` et `offset=0`.
* La valeur maximale de `limit` est `100`.
## Dépendances
Cette API utilise une architecture proxyfié pour la gestion des dépendances.
* [TroubleTicket](https://before-interop.github.io/common/v1/?urls.primaryName=TroubleTicket)
* [Attachment](https://before-interop.github.io/common/v1/?urls.primaryName=Attachment)
* [Note](https://before-interop.github.io/common/v1/?urls.primaryName=Note)
* [Event](https://before-interop.github.io/common/v1/?urls.primaryName=Event)
[Décision Arcep n° 2020-1432]: https://www.arcep.fr/uploads/tx_gsavis/20-1432.pdf
[L33-1]: https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000047293234
[L33-6]: https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000037671945
servers:
- url: "{protocol}://{host}:{port}{basePath}"
variables:
protocol:
enum:
- https
- http
default: https
host:
default: localhost
port:
default: "8080"
basePath:
default: /api/v2
tags:
- name: TroubleTicket
description: TroubleTicket management
- name: Note
description: Note management
- name: Attachment
description: Attachment management
- name: Event
description: Event management
- name: OI
description: OI endpoints
- name: OC
description: OC endpoints
paths:
/anomalie-adresse:
get:
operationId: getAllAnomalieAdresses
tags:
- TroubleTicket
- OI
summary: Get all trouble tickets
description: Get all trouble tickets
parameters: &searchAndPaginateParameters
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/parameters/limit
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/parameters/offset
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/parameters/sort
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/fields.openapi.yaml#/components/parameters/fields
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/filters.openapi.yaml#/components/parameters/filters
responses:
"200":
description: The list of trouble tickets
headers:
X-Total-Count:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/headers/X-Total-Count
X-Result-Count:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/headers/X-Result-Count
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/AnomalieAdresseBase"
"400": &response400
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/Error-400
description: |
**Bad Request**
This error occurs when a query parameter or the body is invalid.
* The `reason` field of the error response can contain information about the error.
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
head:
tags:
- TroubleTicket
- OI
operationId: countAnomalieAdresses
summary: Count the number of trouble tickets
description: Count the number of trouble tickets matching the given criteria.
parameters:
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/filters.openapi.yaml#/components/parameters/filters
responses:
"200":
description: The number of trouble tickets.
headers:
X-Total-Count:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/headers/X-Total-Count
"400": *response400
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
post:
tags:
- TroubleTicket
- OI
operationId: createAnomalieAdresse
summary: Create a trouble ticket
description: Create a trouble ticket
requestBody:
description: The trouble ticket to create
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AnomalieAdresseBase"
responses:
"201": &troubleTicket201
description: The trouble ticket
content:
application/json:
schema:
$ref: "#/components/schemas/AnomalieAdresseBase"
headers:
ETag:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/update.openapi.yaml#/components/headers/ETag
"400": *response400
"403": &response403
description: |
**Forbidden**
Le serveur a compris la requête, mais refuse de l'exécuter car le client n'a pas respecté le processus de création ou de mise à jour.
Exemple: passage du status `ACKNOWLEDGED` à `RESOLVED` sans passer par le status `IN_PROGRESS`.
* Le champ `reason` de la réponse d'erreur doit contenir la liste des tickets en conflit séparés par des virgules.
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
/anomalie-adresse/{AnomalieAdresseId}:
parameters:
- $ref: "#/components/parameters/anomalieAdresseId"
get:
tags:
- TroubleTicket
- OI
operationId: getAnomalieAdresse
summary: Get a trouble ticket
description: Get a trouble ticket
parameters:
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/fields.openapi.yaml#/components/parameters/fields
responses:
"200":
description: The trouble ticket
content:
application/json:
schema:
$ref: "#/components/schemas/AnomalieAdresseBase"
headers:
ETag:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/update.openapi.yaml#/components/headers/ETag
"404": &response404
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/Error-404
description: |
**Not Found**
This error occurs when the resource does not exist or is not visible by the user.
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
put:
tags:
- TroubleTicket
- OI
operationId: updateAnomalieAdresse
summary: Update a trouble ticket
description: Update a trouble ticket
requestBody:
description: The trouble ticket to update
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AnomalieAdresseBase"
parameters:
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/update.openapi.yaml#/components/parameters/If-Match
responses:
"200": *troubleTicket201
"400": *response400
"403": *response403
"404": *response404
"412":
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/Error-412
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
patch:
tags:
- TroubleTicket
- OI
operationId: partialUpdateAnomalieAdresse
summary: Partially update a trouble ticket
description: Partially update a trouble ticket
requestBody:
description: The trouble ticket to update
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AnomalieAdresseBase"
parameters:
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/update.openapi.yaml#/components/parameters/If-Match
responses:
"200": *troubleTicket201
"400": *response400
"403": *response403
"404": *response404
"412":
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/Error-412
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
/anomalie-adresse/{AnomalieAdresseId}/note:
parameters:
- $ref: "#/components/parameters/anomalieAdresseId"
get:
tags:
- Note
- OI
operationId: getAnomalieAdresseNotes
summary: Get all notes of a trouble ticket
description: Get all notes of a trouble ticket
parameters: *searchAndPaginateParameters
responses:
"200":
description: The list of notes
headers:
X-Total-Count:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/headers/X-Total-Count
X-Result-Count:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/headers/X-Result-Count
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Note"
"400": *response400
"404": *response404
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
head:
tags:
- Note
- OI
operationId: countAnomalieAdresseNotes
summary: Count the number of notes of a trouble ticket
description: Count the number of notes of a trouble ticket matching the given criteria.
parameters:
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/filters.openapi.yaml#/components/parameters/filters
responses:
"200":
description: The number of notes
headers:
X-Total-Count:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/headers/X-Total-Count
"400": *response400
"404": *response404
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
post:
tags:
- Note
- OI
operationId: createAnomalieAdresseNote
summary: Create a note for a trouble ticket
description: Create a note for a trouble ticket
requestBody:
description: The note to create
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Note"
responses:
"201":
description: The created note
content:
application/json:
schema:
$ref: "#/components/schemas/Note"
headers:
ETag:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/update.openapi.yaml#/components/headers/ETag
"400": *response400
"404": *response404
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
/anomalie-adresse/{AnomalieAdresseId}/attachment:
parameters:
- $ref: "#/components/parameters/anomalieAdresseId"
get:
tags:
- Attachment
- OI
operationId: getAnomalieAdresseAttachments
summary: Get all attachments of a trouble ticket
description: Get all attachments of a trouble ticket
parameters: *searchAndPaginateParameters
responses:
"200":
description: The list of attachments
headers:
X-Total-Count:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/headers/X-Total-Count
X-Result-Count:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/headers/X-Result-Count
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Attachment"
"400": *response400
"404": *response404
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
head:
tags:
- Attachment
- OI
operationId: countAnomalieAdresseAttachments
summary: Count the number of attachments of a trouble ticket
description: Count the number of attachments of a trouble ticket matching the given criteria.
parameters:
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/filters.openapi.yaml#/components/parameters/filters
responses:
"200":
description: The number of attachments
headers:
X-Total-Count:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/headers/X-Total-Count
"400": *response400
"404": *response404
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
post:
tags:
- Attachment
- OI
operationId: createAnomalieAdresseAttachment
summary: Create an attachment for a trouble ticket
description: Create an attachment for a trouble ticket
requestBody:
description: The attachment to create
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
description: The file to upload
attachment:
$ref: "#/components/schemas/Attachment"
responses:
"201":
description: The created attachment
content:
application/json:
schema:
$ref: "#/components/schemas/Attachment"
headers:
ETag:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/update.openapi.yaml#/components/headers/ETag
"400": *response400
"404": *response404
"413":
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/Error-413
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
/anomalie-adresse/{AnomalieAdresseId}/attachment/{AttachmentId}/content:
parameters:
- $ref: "#/components/parameters/anomalieAdresseId"
- $ref: "#/components/parameters/attachmentId"
get:
tags:
- Attachment
- OI
operationId: downloadAnomalieAdresseAttachment
summary: Download an attachment of a trouble ticket
description: Download an attachment of a trouble ticket
parameters:
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/tools/attachment/attachment.openapi.yaml#/components/parameters/If-Match
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/tools/attachment/attachment.openapi.yaml#/components/parameters/If-None-Match
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/tools/attachment/attachment.openapi.yaml#/components/parameters/If-Modified-Since
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/tools/attachment/attachment.openapi.yaml#/components/parameters/If-Unmodified-Since
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/tools/attachment/attachment.openapi.yaml#/components/parameters/Range
responses:
"200":
description: The content of the attachment
content:
application/octet-stream:
schema:
format: binary
type: string
"404": *response404
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
"412":
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/Error-412
/anomalie-adresse/event:
get:
tags:
- Event
- OI
operationId: getAnomalieAdresseEvents
summary: Get all events of all trouble tickets
description: Get all events of all trouble tickets
parameters: *searchAndPaginateParameters
responses:
"200":
description: The list of events
headers:
X-Total-Count:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/headers/X-Total-Count
X-Result-Count:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/headers/X-Result-Count
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Event"
"400": *response400
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
head:
tags:
- Event
- OI
operationId: countAnomalieAdresseEvents
summary: Count the number of events of all trouble tickets
description: Count the number of events of all trouble tickets matching the given criteria.
parameters:
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/filters.openapi.yaml#/components/parameters/filters
responses:
"200":
description: The number of events
headers:
X-Total-Count:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/utils/paginate.openapi.yaml#/components/headers/X-Total-Count
"400": *response400
default:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/default
post:
tags:
- Event
- OC
operationId: receiveAnomalieAdresseEvent
summary: Receive an event for a trouble ticket
description: Receive an event for a trouble ticket
requestBody:
description: The event to receive
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Event"
responses:
"200":
description: The event has been received
content:
application/json:
schema:
type: object
additionalProperties: true
"204":
description: The event has been received
default:
description: |
L'événement a été reçu avec succès.
La réponse n'a pas l'obligation de contenir un body.
Si l'OC retourne un body, celui-ci pourra être enregistré dans le journal de l'OI.
"400": *response400
"403": *response403
"404": *response404
"500":
description: |
**Internal Server Error**
This error occurs when the server encountered an unexpected condition that prevented it from fulfilling the request.
* The `reason` field of the error response can contain information about the error.
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/responses/errors.openapi.yaml#/components/responses/Error-500
"501":
description: |
**Not Implemented**
This error occurs when the server does not support the functionality required to fulfill the request.
* The `reason` field of the error response can contain information about the error.
components:
parameters:
anomalieAdresseId:
name: AnomalieAdresseId
in: path
description: The id of the trouble ticket
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426614174000
attachmentId:
name: AttachmentId
in: path
description: The id of the attachment
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426614174000
schemas:
AnomalieAdresseBase:
allOf:
- $ref: https://raw.githubusercontent.com/before-interop/common/v1/common/schemas/TroubleTicket.openapi.yaml#/components/schemas/TroubleTicket
- discriminator:
propertyName: "@type"
mapping:
AnomalieAdresse.creation: "#/components/schemas/AnomalieAdresseCreation"
AnomalieAdresse.newBuilding: "#/components/schemas/AnomalieAdresseNewBuilding"
AnomalieAdresse.modification: "#/components/schemas/AnomalieAdresseUpdateImb"
AnomalieAdresse.nbLogements: "#/components/schemas/AnomalieAdresseUpdateNbLogements"
required:
- code_oi
- code_oc
- "@type"
properties:
id:
type: string
format: uuid
readOnly: true
"@baseType":
type: string
default: "AnomalieAdresse"
"@type":
type: string
readOnly: false
example: AnomalieAdresse.creation
description: |
Type de ticket.
Les valeurs possibles sont:
* `AnomalieAdresse.creation`: "#/components/schemas/AnomalieAdresseCreation"
* `AnomalieAdresse.newBuilding`: "#/components/schemas/AnomalieAdresseNewBuilding"
* `AnomalieAdresse.modification`: "#/components/schemas/AnomalieAdresseUpdateImb"
* `AnomalieAdresse.nbLogements`: "#/components/schemas/AnomalieAdresseUpdateNbLogements"
relatedEntity:
type: object
description: "An entity that is related to the ticket such as a bill,\
\ a product, etc. The entity against which the ticket is associated.
\ this property has to be overriden in child classes"
status:
description: |
Le status du ticket.
Les valeurs possibles sont:
* `ACKNOWLEDGED`: Le ticket peut être traité par l'OI.
Ce status est positionné lorsque la création du ticket est terminée.
* `IN_PROGRESS`: Qualification du ticket par l'OI (cas simple ou complexe).
* `PENDING`: Le ticket est en attente d'une action de l'OC.
L'OI a besoin d'informations complémentaires pour traiter le ticket.
* `RESOLVED`: Le ticket est résolu et en attente de validation par l'OC.
* `CLOSED`: Cloture du ticket par l'OI ou l'OC.
* `REJECTED`: Le ticket est rejeté par l'OC.
* `CANCELED`: Le ticket est annulé par l'OC.
**Notes:**
* Le changement de status peut être accompagné d'une raison dans `statusChangeReason`.
* Le changement de status peut être accompagné d'une description dans `statusChangeDetails`.
default: ACKNOWLEDGED
enum:
- ACKNOWLEDGED
- IN_PROGRESS
- PENDING
- RESOLVED
- CLOSED
- REJECTED
- CANCELED
acknowledgedDuration:
type: integer
readOnly: true
description: Temps cumulé du ticket dans le status `ACKNOWLEDGED`.
totalInProgressDuration:
type: integer
readOnly: true
description: Temps cumulé du ticket dans le status `IN_PROGRESS`.
totalPendingDuration:
type: integer
readOnly: true
description: Temps cumulé du ticket dans le status `PENDING`.
totalDuration:
type: integer
readOnly: true
description: Temps cumulé du ticket dans les status `ACKNOWLEDGED` et `IN_PROGRESS`.
resolvedToAcknowledgedDuration:
type: integer
readOnly: true
description: Temps cumulé du ticket dans les status `RESOLVED` avant le passage à `ACKNOWLEDGED`.
resolvedToClosedDuration:
type: integer
readOnly: true
description: Temps cumulé du ticket dans les status `RESOLVED` avant le passage à `CLOSED`.
expectedResolutionDate:
description: The expected resolution date
determined by the trouble ticket system.
type: string
format: date-time
nullable: true
readOnly: true
statusChangeReason:
enum:
- ALREADY_RESOLVED
- DELAY_ANSWER_EXPIRED
- DELAY_VALIDATION_EXPIRED
- DUPLICATE
- INFORMATION_PROVIDED
- INVALID
- OTHER
- REQUALIFIED
- RESOLUTION_ACCEPTED
- RESOLUTION_REFUSED
- RESOLVED
- UNKNOWN_RESOURCE
- UNKNOWN_ZONE
- UNRESOLVABLE
- WAITING_INFORMATION
priority:
readOnly: false
type: string
enum:
- LOW
- MEDIUM
- HIGH
default: LOW
complexity:
type: string
readOnly: true
enum:
- SIMPLE
- COMPLEX
- MASSE
description: |
Complexité du ticket.
La valeur est renseignée par l'OI lors du passage à l'état `IN_PROGRESS`.
Les valeurs possibles sont:
* `SIMPLE`: cas ne nécessitant pas d'intervention sur le terrain,
pas d'intervention sur le réseau ou de réalignement de référentiels.
* `COMPLEX`: cas qui n'est pas un cas simple.
* `MASSE`: cas qui concerne les anomalies en masse.
code_oi: # Code ARCEP de l'OI.
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/schemas/Interop.openapi.yaml#/components/schemas/CodeOperateurArcep
code_oc: # Code ARCEP de l'OC.
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/schemas/Interop.openapi.yaml#/components/schemas/CodeOperateurArcep
externalId:
description: Référence interne du ticket de l'OC.
type: string
ticketType:
description: |
Types de ticket.
Les valeurs possibles sont:
* `CUSTOMER_REQUEST`: Ticket créé par l'OC suite à une demande client final
qui souhaite passer commande.
* `OC_REQUEST`: Ticket créé par l'OC sans demande client final.
La valeur est renseignée par l'OC à la création du ticket.
default: OC_REQUEST
enum:
- OC_REQUEST
- CUSTOMER_REQUEST
siren:
type: string
description: Numéro SIREN de l'entreprise cliente.
siret:
type: string
description: Numéro SIRET de l'entreprise cliente.
zone:
type: string
enum:
- ZTD
- ZMD
readOnly: true
description: |
Zone de traitement du ticket.
La valeur est renseignée par l'OI lors de la qualification du ticket
et du passage au status `IN_PROGRESS`.
AnomalieAdresseCreation:
description: |
*AnomalieAdresseCreation* permet la création d'une adresse inexistante dans l'IPE
ou d'une immeuble neuf.
Dans la mesure du possible, l'OC doit fournir les informations suivantes:
* Quadrulet (`code_rivoli`, `code_insee`, `streetNr`, `streetNrSuffix`)
* `code_hexacle`
* `code_ban`
* N-uplet (`postcode`, `city`, `streetName`)
Pour les immeubles neufs, l'OC peut fournir les informations suivantes
sur le bailleur et le promoteur immobilier grâce aux champs `realEstateLessor` et `realEstateDeveloper`.
allOf:
- $ref: "#/components/schemas/AnomalieAdresseBase"
- required:
- building
properties:
relatedEntity:
type: array
items:
$ref: "#/components/schemas/RelatedBuilding"
building:
$ref: "#/components/schemas/AnomalieAdresseCreationBuilding"
AnomalieAdresseCreationBuilding:
allOf:
- $ref: "#/components/schemas/Building"
required:
- address
- geographicLocation
- newConstruction
- type
AnomalieAdresseNewBuilding:
description: |
*AnomalieAdresseNewBuilding* permet de rajouter un nouveau bâtiment à une adresse existante dans l'IPE.
allOf:
- $ref: "#/components/schemas/AnomalieAdresseBase"
- required:
- building
- relatedEntity
properties:
relatedEntity:
type: array
minItems: 1
maxItems: 1
items:
$ref: "#/components/schemas/RelatedBuilding"
building:
$ref: "#/components/schemas/AnomalieAdresseNewBuildingBuilding"
AnomalieAdresseNewBuildingBuilding:
allOf:
- $ref: "#/components/schemas/Building"
- required:
- name
- geographicLocation
- newConstruction
- type
AnomalieAdresseUpdate:
allOf:
- $ref: "#/components/schemas/AnomalieAdresseBase"
- properties:
"@baseType":
type: string
default: "AnomalieAdresseUpdate"
sizeRefs:
type: integer
description: |
Nombre d'immeubles cibles de l'anomalie.
La valeur est renseignée par l'OI à la création du ticket.
Elle est égale à la taille du tableau `relatedEntity`.
Elle permet de rechercher plus efficacement les anomalies
et de facilement différencier les traitement unitaires et en masse.
readOnly: true
AnomalieAdresseUpdateImb:
description: |
*AnomalieAdresseUpdateImb* est une anomalie de type `AnomalieAdresseUpdate`
qui permet de mettre à jour un des attributs en masse d'un ou plusieurs immeubles.
allOf:
- $ref: "#/components/schemas/AnomalieAdresseUpdate"
- required:
- issues
- relatedEntity
properties:
relatedEntity:
description: |
Liste des immeubles cibles de l'anomalie.
Si cette liste est supérieure à 1, alors l'OI traite les cas possibles de la demande en masse
et demande la résolution du ticket.
L'OC pourra rouvrir un ticket unitaire si besoin pour chaque cas non résolus.
type: array
minItems: 1
items:
$ref: "#/components/schemas/RelatedBuilding"
issues:
$ref: "#/components/schemas/AnomalieAdresseUpdateImbIssues"
AnomalieAdresseUpdateImbIssues:
description: "Les anomalies spécifiques en masse"
type: object
properties:
"building.geographicLocations":
$ref: "#/components/schemas/UpdateImbIssuesBuildingGeographicLocations"
"building.name":
$ref: "#/components/schemas/UpdateImbIssuesBuildingName"
"building.address.city":
$ref: "#/components/schemas/UpdateImbIssuesBuildingCity"
"building.address.postcode":
$ref: "#/components/schemas/UpdateImbIssuesBuildingPostcode"
"building.address.streetName":
$ref: "#/components/schemas/UpdateImbIssuesBuildingStreetName"
"building.address.streetNr":
$ref: "#/components/schemas/UpdateImbIssuesBuildingStreetNr"
"building.address.streetNrSuffix":
$ref: "#/components/schemas/UpdateImbIssuesBuildingStreetNrSuffix"
"building.address.streetType":
$ref: "#/components/schemas/UpdateImbIssuesBuildingStreetType"
"building.address.code_insee":
$ref: "#/components/schemas/UpdateImbIssuesBuildingCodeInsee"
"building.address.code_hexacle":
$ref: "#/components/schemas/UpdateImbIssuesBuildingCodeHexacle"
"building.address.code_hexacle_voie":
$ref: "#/components/schemas/UpdateImbIssuesBuildingCodeHexacleVoie"
"building.address.code_rivoli":
$ref: "#/components/schemas/UpdateImbIssuesBuildingCodeRivoli"
"building.address.code_ban":
$ref: "#/components/schemas/UpdateImbIssuesBuildingCodeBan"
"building.pm.id":
$ref: "#/components/schemas/UpdateImbIssuesBuildingPmId"
UpdateImbIssuesBuildingGeographicLocations:
type: object
description: Liste des coordonnées géographiques de l'adresse corrigée.
properties:
value:
type: array
items:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/schemas/Interop.openapi.yaml#/components/schemas/GeographicPoint
UpdateImbIssuesBuildingName:
type: object
description: |
Nom du bâtiment.
Ce champ est nommé `BatimentImmeuble` dans le fichier IPE.
properties:
value:
type: array
items:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/schemas/Interop.openapi.yaml#/components/schemas/Building/allOf/1/properties/name
toBlank:
type: boolean
description: |
Indique si l'attribut en erreur doit être mis à blanc.
Si la valeur est `true`, l'attribut en erreur sera mis à blanc.
Si la valeur est `false`, l'attribut en erreur ne sera pas mis à blanc.
UpdateImbIssuesBuildingCity:
type: object
description: |
Nom de la commune.
Ce champ est nommé `CommuneImmeuble` dans le fichier IPE.
properties:
value:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/schemas/GeographicAddress.openapi.yaml#/components/schemas/GeographicAddress/allOf/1/properties/city
UpdateImbIssuesBuildingPostcode:
type: object
description: |
Code postal.
Ce champ est nommé `CodePostalImmeuble` dans le fichier IPE.
properties:
value:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/schemas/GeographicAddress.openapi.yaml#/components/schemas/GeographicAddress/allOf/1/properties/postcode
UpdateImbIssuesBuildingStreetName:
type: object
description: |
Nom de la voie.
Ce champ est nommé `NomVoieImmeuble` dans le fichier IPE.
properties:
value:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/schemas/GeographicAddress.openapi.yaml#/components/schemas/GeographicAddress/allOf/1/properties/streetName
toBlank:
type: boolean
description: |
Indique si l'attribut en erreur doit être mis à blanc.
Si la valeur est `true`, l'attribut en erreur sera mis à blanc.
Si la valeur est `false`, l'attribut en erreur ne sera pas mis à blanc.
UpdateImbIssuesBuildingStreetNr:
type: object
description: |
Numéro de la voie.
Ce champ est nommé `NumeroVoieImmeuble` dans le fichier IPE.
properties:
value:
type: array
items:
$ref: https://raw.githubusercontent.com/before-interop/common/v1/common/schemas/GeographicAddress.openapi.yaml#/components/schemas/GeographicAddress/allOf/1/properties/streetNr
toBlank:
type: boolean
description: |
Indique si l'attribut en erreur doit être mis à blanc.
Si la valeur est `true`, l'attribut en erreur sera mis à blanc.
Si la valeur est `false`, l'attribut en erreur ne sera pas mis à blanc.
UpdateImbIssuesBuildingStreetNrSuffix:
type: object
description: |