ANNEXES
ANNEXE 1
PARAMÈTRES COMMUNIQUÉS PAR L'API
1. Paramètres principaux
Les paramètres principaux sont transmis par l'IAD (pour Integrated Access Device) à un outil de mesure de qualité de service à la suite d'une requête effectuée une seule fois lorsqu'un utilisateur réalise un test de mesure de la qualité de service internet.
Condition de présence | Arbre JSON | Nom du paramètre | Unité | Détail du paramètre | Format / liste de valeurs acceptées |
|---|---|---|---|---|---|
Obligatoire | Root | ApiVersion | Version de l'API | Entier positif de 64 bits | |
Facultatif | Gateway | Model | Nom de l'IAD (« box ») du client | texte | |
Facultatif | Gateway | SoftwareVersion | Version du logiciel | texte | |
Obligatoire lorsque défini et existant | SubscriptionSpeed | DownloadMin | Kb/s | Débit minimum descendant contractuel | Entier positif de 64 bits |
Obligatoire lorsque défini et existant | SubscriptionSpeed | UploadMin | Kb/s | Débit minimum montant contractuel | Entier positif de 64 bits |
Obligatoire | SubscriptionSpeed | DownloadMax | Kb/s | Débit maximum descendant contractuel | Entier positif de 64 bits |
Obligatoire | SubscriptionSpeed | UploadMax | Kb/s | Débit maximum montant contractuel | Entier positif de 64 bits |
Obligatoire lorsque défini et existant | SubscriptionSpeed | DownloadNormally | Kb/s | Débit « normalement disponible » descendant contractuel (s'il existe) | Entier positif de 64 bits |
Obligatoire lorsque défini et existant | SubscriptionSpeed | UploadNormally | Kb/s | Débit « normalement disponible » montant contractuel (s'il existe) | Entier positif de 64 bits |
Obligatoire | Wan | Technology | Technologie WAN utilisée par l'IAD (« box ») | ["ftth" ;"adsl" ; "vdsl" ;"gfast" ;"cable" ;"satellite" ;"2g" ;"3g" ;"4g" ;"5g" ;"other"] | |
Obligatoire si la technologie WAN est FTTH | Wan/SpeedOnt | Download | Kb/s | FTTH uniquement : débit descendant Ethernet entre l'ONT et l'IAD. Facultatif : Si détection d'un CPL sur le port WAN : débit brut remonté par le CPL. | Entier positif de 64 bits |
Obligatoire si la technologie WAN est FTTH | Wan/SpeedOnt | Upload | Kb/s | FTTH uniquement : débit montant Ethernet entre l'ONT et l'IAD Facultatif : Si détection d'un CPL sur le port WAN : débit brut remonté par le CPL. | Entier positif de 64 bits |
Obligatoire si la technologie WAN est FTTH | Wan/SpeedOnt | Duplex | FTTH uniquement : mode Ethernet entre l'ONT et l'IAD | ["half" ;"full"] | |
Obligatoire si la technologie WAN est xDSL | Wan/SpeedSynchro | Download | Kb/s | xDSL uniquement : débit de synchronisation descendant | Entier positif de 64 bits |
Obligatoire si la technologie WAN est xDSL | Wan/SpeedSynchro | Upload | Kb/s | xDSL uniquement : débit de synchronisation montant | Entier positif de 64 bits |
Obligatoire | Wan | Aggregation | Technologie WAN secondaire active "no" : absence d'agrégation ou agrégation non activée. | ["no" ;"ftth" ;"adsl" ; "vdsl" ;"gfast" ;"cable" ;"satellite" ;"2g" ;"3g" ;"4g" ;"5g" ;"other"] |
Nota. - le « débit maximum » est à remplir systématiquement avec les technologies WAN FTTH, câble et satellite avec le débit contractuel. Pour les autres technologies WAN, il n'est à remplir que si l'accès possède un débit maximum.