E-Intervention-OI-v2.0.0.OAS3.yaml

openapi: 3.0.2
servers:
  - url: https://{serverRoot}/v2
    variables:
      serverRoot:
        default: serverRoot
paths:
  /interventions-oi:
    post:
      tags:
        - creerInterventionOI
      summary: "Flux M2: Début d’intervention DO transmis par l’OI aux autres OCs presents au PM."
      operationId: creerInterventionOI
      x-secured-access: strict
      security:
        - creerInterventionOI_auth: []
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreerInterventionOI'
        description: Objet intervention à déclarer chez l'OC
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreerInterventionOIOut'
          description: Operation Successful
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-security-in: IDENTITE_ET_GESTION
      x-security-out: IDENTITE_ET_GESTION
    put:
      tags:
        - modifierInterventionOI
      summary: "Flux M4: la fin de l'intervention notifier par l'OI"
      operationId: modifierInterventionOI
      x-secured-access: strict
      security:
        - modifierInterventionOI_auth: []
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifierInterventionOI'
        description: Objet intervention à déclarer chez l'OC
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifierInterventionOIOut'
          description: Operation Successful
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-security-in: IDENTITE_ET_GESTION
      x-security-out: IDENTITE_ET_GESTION
  /interventions-oi/compte-rendu:
    post:
      tags:
        - compteRenduInterventionOI
      summary: "Flux M3 optionnel: compte rendu de fin d'intervention relié par l'OI"
      operationId: compteRenduInterventionOI
      x-secured-access: strict
      security:
        - compteRenduInterventionOI_auth: []
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompteRenduInterventionOI'
        description: Objet intervention à déclarer chez l'OC
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompteRenduInterventionOIOut'
          description: Operation Successful
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-security-in: IDENTITE_ET_GESTION
      x-security-out: IDENTITE_ET_GESTION
  /interventions-oi/notification-impacte-clients-oc:
    post:
      tags:
        - notifierImpacteClientsOC
      summary: "Flux M5TX: Impacts clients identifiés par l’OC"
      operationId: notifierImpacteClientsOC
      x-secured-access: strict
      security:
        - notifierImpacteClientsOC_auth: []
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientImpacteOCParIntervention'
        description: Liste des clients coupés lors d'une intervention donnée pour un opérateur commercial donné
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientImpacteParInterventionOut'
          description: Operation Successful
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-security-in: IDENTITE_ET_GESTION
      x-security-out: IDENTITE_ET_GESTION
  /interventions-oi/notification-impacte-clients-oi-do:
    post:
      tags:
        - notifierImpacteClientsOIDO
      summary: "Flux M6TX:  Impacts clients relayés par l’OI au DO"
      operationId: notifierImpacteClientsOIDO
      x-secured-access: strict
      security:
        - notifierImpacteClientsOIDO_auth: []
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotifierImpacteClientsOIDO'
        description: Liste des clients coupés lors d'une intervention donnée pour un opérateur commercial donné
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotifierImpacteClientsOIDOOut'
          description: Operation Successful
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-security-in: IDENTITE_ET_GESTION
      x-security-out: IDENTITE_ET_GESTION
  /interventions-oi/test-intermediaire:
    post:
      tags:
        - demanderTestIntermediaireInterventionOI
      summary: "Flux M4TX: Demande de test DO relayée par l’OI"
      operationId: demanderTestIntermediaireInterventionOI
      x-secured-access: strict
      security:
        - demanderTestIntermediaireInterventionOI_auth: []
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DemanderTestIntermediaireInterventionOI'
        description: Objet intervention à déclarer chez l'OI
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemanderTestIntermediaireInterventionOIOut'
          description: Operation Successful
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-security-in: IDENTITE_ET_GESTION
      x-security-out: IDENTITE_ET_GESTION
components:
  securitySchemes:
    compteRenduInterventionOI_auth:
      type: oauth2
      x-habilitations: []
      flows:
        implicit:
          authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize
          scopes: {}
    creerInterventionOI_auth:
      type: oauth2
      x-habilitations: []
      flows:
        implicit:
          authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize
          scopes: {}
    demanderTestIntermediaireInterventionOI_auth:
      type: oauth2
      x-habilitations: []
      flows:
        implicit:
          authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize
          scopes: {}
    modifierInterventionOI_auth:
      type: oauth2
      x-habilitations: []
      flows:
        implicit:
          authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize
          scopes: {}
    notifierImpacteClientsOC_auth:
      type: oauth2
      x-habilitations: []
      flows:
        implicit:
          authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize
          scopes: {}
    notifierImpacteClientsOIDO_auth:
      type: oauth2
      x-habilitations: []
      flows:
        implicit:
          authorizationUrl: https://oauth2.bouyguestelecom.fr/authorize
          scopes: {}
  schemas:
    ClientHSOC:
      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"
      type: object
      required:
        - dateChangementEtat
        - fibre
        - nomModulePM
        - positionCoupleurOC
        - positionModulePM
        - refPBO
        - refPTO
        - tube
      properties:
        couleurJarretiere:
          description: ""
          type: string
        dateChangementEtat:
          description: Date/heure de début de coupure pour le client (format selon la norme ISO 8601)
          type: string
          format: date-time
        fibre:
          description: ""
          maxLength: 50
          type: string
        nomModulePM:
          description: ""
          type: string
        numeroSerieONT:
          description: ""
          type: string
        positionCoupleurOC:
          description: ""
          type: string
        positionModulePM:
          description: ""
          maxLength: 100
          type: string
        refPBO:
          description: ""
          maxLength: 100
          type: string
        refPTO:
          description: ""
          maxLength: 50
          type: string
        referencePrestationPrise:
          description: ""
          type: string
        tube:
          description: ""
          maxLength: 50
          type: string
    ClientHSOC1:
      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"
      type: object
      required:
        - dateChangementEtat
        - fibre
        - nomModulePM
        - positionCoupleurOC
        - positionModulePM
        - refPBO
        - refPTO
        - tube
      properties:
        couleurJarretiere:
          description: ""
          type: string
        dateChangementEtat:
          description: ""
          type: string
          format: date-time
        fibre:
          description: ""
          maxLength: 50
          type: string
        nomModulePM:
          description: ""
          type: string
        numeroSerieONT:
          description: ""
          type: string
        positionCoupleurOC:
          description: ""
          type: string
        positionModulePM:
          description: ""
          maxLength: 100
          type: string
        refPBO:
          description: ""
          maxLength: 100
          type: string
        refPTO:
          description: ""
          maxLength: 50
          type: string
        referencePrestationPrise:
          description: ""
          type: string
        reserveReparationOI:
          description: ""
          type: boolean
        tube:
          description: ""
          maxLength: 50
          type: string
    ClientImpacteOCParIntervention:
      description: ""
      type: object
      required:
        - clientHSOC
        - codeOcImpacte
        - ligneClientRetablie
        - message
        - referenceIntervOI
        - testCloture
      properties:
        clientHSOC:
          description: ""
          type: array
          items:
            $ref: '#/components/schemas/ClientHSOC'
        codeOcImpacte:
          description: Code opérateur Interop de celui ayant des clients impactés
          maxLength: 4
          type: string
        demandeReapartion:
          description: ""
          type: array
          items:
            $ref: '#/components/schemas/DemandeReparation'
        ligneClientRetablie:
          description: ""
          type: array
          items:
            $ref: '#/components/schemas/LigneClientRetablie'
        message:
          description: ""
          type: string
        numeroTest:
          description: ""
          type: integer
          format: int32
        referenceIntervOI:
          description: Référence d’intervention unique produite par l'OI
          maxLength: 50
          type: string
        testCloture:
          description: ""
          type: string
    ClientImpacteParInterventionOut:
      description: ""
      type: object
      required:
        - code
        - numeroTest
        - referenceIntervOI
      properties:
        code:
          description: 0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si REF_INTERV_OI_INCONNUE
          type: integer
          format: int32
        description:
          description: Description de l'erreur
          maxLength: 100
          type: string
        numeroTest:
          description: ""
          type: integer
          format: int32
        referenceIntervOI:
          description: ""
          type: string
    CompteRenduInterventionOI:
      description: ""
      type: object
      required:
        - codeOI
        - message
        - refIntervOI
      properties:
        codeOI:
          description: Code opérateur Interop de l'opérateur d'infrastructure
          maxLength: 4
          type: string
        lignesImpactees:
          description: ""
          type: array
          items:
            $ref: '#/components/schemas/LigneImpacte'
        lignesRetablies:
          description: ""
          type: array
          items:
            $ref: '#/components/schemas/LigneRetablie'
        message:
          description: ""
          type: string
        refIntervOI:
          description: Référence d’intervention unique produite par l’OI dans R M1/R M3
          maxLength: 50
          type: string
    CompteRenduInterventionOIOut:
      description: ""
      type: object
      required:
        - code
        - refInterventionOI
      properties:
        code:
          description: 0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si CODE_OI_INCONNU 4 si PM_INCONNU
          type: integer
          format: int32
        description:
          description: Description de l'erreur
          maxLength: 100
          type: string
        refInterventionOI:
          description: ""
          type: string
    CreerInterventionOI:
      description: ""
      type: object
      required:
        - codeOI
        - dateDebutIntevention
        - message
        - refIntervOI
        - refPBO
      properties:
        codeOI:
          description: Code opérateur Interop de l'opérateur d'infrastructure
          maxLength: 4
          type: string
        dateDebutIntevention:
          description: Date/heure de début réel d'intervention (format selon la norme ISO 8601)
          type: string
          format: date-time
        description:
          description: ""
          type: string
        elementReseau:
          description: ""
          type: string
        message:
          description: ""
          type: string
        pointMutualisation:
          $ref: '#/components/schemas/PointMutualisation'
        refIntervOI:
          description: Référence d’intervention unique produite par l’OI dans R M1/R M3
          maxLength: 50
          type: string
        refPBO:
          description: ""
          type: string
    CreerInterventionOIOut:
      description: ""
      type: object
      required:
        - code
        - refInterventionOI
      properties:
        code:
          description: 0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si CODE_OI_INCONNU 4 si PM_INCONNU
          type: integer
          format: int32
        description:
          description: Description de l'erreur
          maxLength: 100
          type: string
        refInterventionOI:
          description: ""
          type: string
    DemandeReparation:
      description: ""
      type: object
      required:
        - codeDO
      properties:
        codeDO:
          description: ""
          type: string
        reparation:
          description: ""
          default: false
          type: boolean
    DemanderTestIntermediaireInterventionOI:
      description: ""
      type: object
      required:
        - codeOI
        - dateTest
        - infosIntervention
        - message
        - natureTest
        - numeroTest
        - refIntervOI
      properties:
        codeOI:
          description: Code opérateur Interop de l'opérateur d'infrastructure
          maxLength: 4
          type: string
        dateTest:
          description: ""
          type: string
          format: date-time
        infosIntervention:
          description: ""
          type: array
          items:
            $ref: '#/components/schemas/InfoIntervention'
        message:
          description: ""
          type: string
        natureTest:
          description: ""
          type: string
        numeroTest:
          description: ""
          type: integer
          format: int32
        refIntervOI:
          description: ""
          type: string
    DemanderTestIntermediaireInterventionOIOut:
      description: ""
      type: object
      required:
        - code
        - numeroTest
      properties:
        code:
          description: 0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si CODE_OI_INCONNU 4 si PM_INCONNU
          type: integer
          format: int32
        description:
          description: Description de l'erreur
          maxLength: 100
          type: string
        numeroTest:
          description: ""
          type: integer
          format: int32
        refIntervOI:
          description: "Conditionnel: si Libelle_Reponse = OK Référence d'intervention unique produite par l'opérateur d'infrastructure"
          maxLength: 50
          type: string
    InfoIntervention:
      description: ""
      type: object
      properties:
        refPbo:
          description: "Référence PBO (Ex: PTXXXXXXX) si disponible"
          maxLength: 100
          type: string
    LigneClientRetablie:
      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"
      type: object
      required:
        - dateChangementEtat
        - fibre
        - nomModulePm
        - positionModulePM
        - refPBO
        - refPTO
        - tube
      properties:
        dateChangementEtat:
          description: Date/heure de début de coupure pour le client (format selon la norme ISO 8601)
          type: string
          format: date-time
        fibre:
          description: ""
          maxLength: 50
          type: string
        nomModulePm:
          description: ""
          type: string
        numeroSerieONT:
          description: ""
          type: string
        positionModulePM:
          description: ""
          maxLength: 100
          type: string
        refPBO:
          description: ""
          maxLength: 100
          type: string
        refPTO:
          description: ""
          maxLength: 50
          type: string
        referencePrestationPrise:
          description: ""
          type: string
        tube:
          description: ""
          maxLength: 50
          type: string
    LigneClientRetablie1:
      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"
      type: object
      required:
        - dateChangementEtat
        - fibre
        - nomModulePM
        - positionModulePM
        - refPBO
        - refPTO
        - referencePrestationPrise
        - tube
      properties:
        dateChangementEtat:
          description: ""
          type: string
          format: date-time
        fibre:
          description: ""
          maxLength: 50
          type: string
        nomModulePM:
          description: ""
          type: string
        numeroSerieONT:
          description: ""
          type: string
        positionModulePM:
          description: ""
          maxLength: 100
          type: string
        refPBO:
          description: ""
          maxLength: 100
          type: string
        refPTO:
          description: ""
          maxLength: 50
          type: string
        referencePrestationPrise:
          description: ""
          type: string
        tube:
          description: ""
          maxLength: 50
          type: string
    LigneImpacte:
      description: ""
      type: object
      properties:
        refPTO:
          description: ""
          type: string
        referencePrestationPrise:
          description: ""
          type: string
        repaCodeOC:
          description: ""
          type: string
        repaOCDemandee:
          description: ""
          type: string
        retMessage:
          description: ""
          type: string
        retStatut:
          description: ""
          type: string
        retTypo:
          description: ""
          type: string
        serialNumberONT:
          description: ""
          type: string
    LigneRetablie:
      description: ""
      type: object
      properties:
        refPTO:
          description: ""
          type: array
          items:
            type: string
        referencePrestationPrise:
          description: ""
          type: string
        serialNumberONT:
          description: ""
          type: string
    ModifierInterventionOI:
      description: ""
      type: object
      required:
        - codeOI
        - dateDebutIntevention
        - message
        - pointMutualisation
        - refIntervOI
        - testFinFroid
      properties:
        codeOI:
          description: Code opérateur Interop de l'opérateur d'infrastructure
          maxLength: 4
          type: string
        dateDebutIntevention:
          description: Date/heure de début réel d'intervention (format selon la norme ISO 8601)
          type: string
          format: date-time
        dateFinIntervention:
          description: Valeur NULL si M2 Date/heure de fin réel d'intervention si M4 (format selon la norme ISO 8601)
          type: string
          format: date-time
        description:
          description: ""
          type: string
        elementReseau:
          description: ""
          type: string
        message:
          description: ""
          type: string
        pointMutualisation:
          $ref: '#/components/schemas/PointMutualisation'
        refIntervOI:
          description: Référence d’intervention unique produite par l’OI dans R M1/R M3
          maxLength: 50
          type: string
        testFinFroid:
          description: ""
          type: string
    ModifierInterventionOIOut:
      description: ""
      type: object
      required:
        - code
        - refInterventionOI
      properties:
        code:
          description: 0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si CODE_OI_INCONNU 4 si PM_INCONNU
          type: integer
          format: int32
        description:
          description: Description de l'erreur
          maxLength: 100
          type: string
        refInterventionOI:
          description: ""
          type: string
    NotifierImpacteClientsOIDO:
      description: ""
      type: object
      required:
        - clientHSOC
        - codeOCImpacte
        - ligneClientRetablie
        - message
        - multiInterventionOI
        - nombreOC
        - referenceIntervOI
        - reparation
      properties:
        clientHSOC:
          description: ""
          type: array
          items:
            $ref: '#/components/schemas/ClientHSOC1'
        codeOCImpacte:
          description: Code opérateur Interop de celui ayant des clients impactés
          maxLength: 4
          type: string
        ligneClientRetablie:
          description: ""
          type: array
          items:
            $ref: '#/components/schemas/LigneClientRetablie1'
        message:
          description: ""
          type: string
        multiInterventionOI:
          description: ""
          type: boolean
        nombreOC:
          description: ""
          type: integer
          format: int32
        numeroTest:
          description: ""
          type: integer
          format: int32
        referenceIntervOI:
          description: Référence d’intervention unique produite par l'OI
          maxLength: 50
          type: string
        reparation:
          description: ""
          type: boolean
    NotifierImpacteClientsOIDOOut:
      description: ""
      type: object
      required:
        - code
        - numeroTest
        - referenceIntervOI
      properties:
        code:
          description: 0 si OK 1 si CHAMPS_NON_RENSEIGNE 2 si MAUVAIS_FORMAT 3 si REF_INTERV_OI_INCONNUE
          type: integer
          format: int32
        description:
          description: Description de l'erreur
          maxLength: 100
          type: string
        numeroTest:
          description: ""
          readOnly: true
          type: integer
          format: int32
        referenceIntervOI:
          description: ""
          type: string
    PointMutualisation:
      description: ""
      type: object
      required:
        - refPM
        - refPMTechnique
      properties:
        refPM:
          description: "Référence réglementaire du PM (ex: FI-XXXXX-XXXX)"
          maxLength: 50
          type: string
        refPMTechnique:
          description: "C'est la référence du PMTechnique dans le cas d'un regroupement de plusieurs PM Techniques rattachés à un PM. Ce champ permet à l'Oc d'identifier le PM Technique à raccorder (boitier, armoire...) au PBO."
          type: string
    ErrorResponse:
      description: Description d'une erreur fonctionnelle
      type: object
      required:
        - error
      properties:
        error:
          description: Le code erreur permet de discriminer les différentes erreurs
          type: string
          enum:
            - CHAMPS_NON_RENSEIGNE
            - CODE_OI_INCONNU
            - MAUVAIS_FORMAT
            - PM_INCONNU
            - REF_INTERV_OI_INCONNUE
            - INCOHERENCE
            - TEST_PRECEDENT_DEJA_EMIS
            - TEST_PRECEDENT_NON_ACQUITTE
            - M3TX_NON_DEMANDE
            - DELAI_NON_RESPECTE
            - ERREUR_ITERATION
        error_description:
          description: Description de l'erreur, si possible fixe pour un même code erreur
          type: string
          maxLength: 256
        error_uri:
          description: L'URI de description de l'erreur
          type: string
        error_parameters:
          description: Les paramètres de l'erreur
          type: array
          items:
            type: string
            maxLength: 64
info:
  x-objetmetier: INTERVENTION-OI
  x-sf: ""
  x-st: MSF
  x-type: partenaire
  x-execution: api
  x-role: provider
  title: INTERVENTION-OI
  version: 1.0.287
  description: ""
  contact:
    name: MOE MSF
tags:
  - name: demanderTestIntermediaireInterventionOI
    description: "Flux M4TX: Demande de test DO relayée par l’OI"
  - name: modifierInterventionOI
    description: "Flux M4: la fin de l'intervention notifier par l'OI"
  - name: creerInterventionOI
    description: "Flux M2 : Début d’intervention DO transmis par l’OI aux autres OCs presents au PM."
  - name: compteRenduInterventionOI
    description: "Flux M3 optionnel: compte rendu de fin d'intervention relié par l'OI"
  - name: notifierImpacteClientsOC
    description: "Flux M5TX: Impacts clients identifiés par l’OC"
  - name: notifierImpacteClientsOIDO
    description: "Flux M6TX:  Impacts clients relayés par l’OI au DO"
externalDocs:
  description: "Groupe Interop'Fibre"
  url: "https://www.interop-fibre.fr/"