Fibre¶

Représente un service fibre. Un service est un dictionnaire contenant une liste de champs représentant un lien en production.

Celle-ci implémente un payload différent de l'API cuivre.

API INDEX URL https://extranet.kosc-telecom.fr/api/fiber-services/

Action	URL
Lister les services	`/api/fiber-services/`
Récupérer un service	`/api/fiber-services/{uuid}/`

Exemple¶

GET /api/fiber-services/0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
    "uuid": "e0422430-1be8-4647-bf3d-802b40eb9d71",
    "reference": "S180713_39002",
    "status": "active",
    "activate_order_ref": "O180713_39001",
    "activate_order_uuid": "97e98a3f-339e-4f49-9298-d6c979b10b20",
    "product": {
        "code": "FP01",
        "name": "PROFESSIONAL-FIBER",
        "description": "PROFESSIONAL FIBER",
        "line": {
            "name": "PRO-FIBER",
            "code": "FP",
            "description": "Professional Fiber",
            "family": {
                "name": "FIBR",
                "code": "F",
                "description": "Fiber"
            }
        }
    },
    "end_customer": {
        "contact": {
            "first_name": "asd",
            "last_name": "asd",
            "phone_number": "01242323232",
            "email": "asd@asd.com"
        },
        "type": "unregistered",
        "name": "asd"
    },
    "operator_info": {
        "contact_uuid": "zitjrmff"
    },
    "bounds": [
        {
            "endpoints": [
                {
                    "reference": "FI-1234-2342",
                    "type": "otp"
                }
            ],
            "address": {
                "kosc_street_code": "9169103000",
                "kosc_insee_code": "91691",
                "zipcode": "91330",
                "street_name": "RUE BERTHIER",
                "street_number": "2",
                "city": "YERRES",
                "building_code": "IMB/91691/C/00I2",
                "stairs": "_NA_",
                "floor": "_NA_"
            },
            "information": {
                "co": "91114BRN"
            }
        }
    ],
    "options": {
        "gtr": {
            "enabled": true,
            "value": "d_plus_1"
        }
    },
    "information": {},
    "activation_date": "2018-07-13T15:49:54.168555Z",
    "starting_date": "2018-07-20T15:49:54.168555Z",
    "creation_date": "2018-07-13T15:49:54.168907Z",
    "modification_date": "2018-08-27T10:05:54.070594Z"
}

Attributs d'un service¶

Le tableau ci dessous liste les champs d'un service.

Nom du champ	Type	Description
uuid	string	Identifiant du service
reference	string	Référence commerciale Covage du service au format SYYMMDD_XXXXX à communiquer au service Delivery
status	string	Statut du service
activate_order_ref	string	Référence commerciale Covage de la commande qui a servi à créer ce service
activate_order_uuid	string	Identifiant de la commande
activation_date	ISO datetime	Date de prise en compte de la commande par Covage
starting_date	ISO datetime	Date de soumission de la commande
creation_date	ISO datetime	Date de création de la commande
modification_date	ISO datetime	Date de dernière modification de la commande
current_order_uuid	string	Identifiant de la commande (valeur à `null` pour le moment)
current_order_type	string	Type de la commande (valeur à `null` pour le moment)
product	object*	Informations sur le produit choisi. Défini le type de service, la technologie, le débit, les options possibles
product[uuid]	string	Référence du produit
product[code]	string	Code du produit
product[name]	string	Nom du produit
product[description]	string	Description du produit
product[line]	object*	Ligne du produit
product.line[uuid]	string	Référence de la ligne de produit
product.line[code]	string	Code de la ligne de produit
product.line[name]	string	Nom de la ligne de produit
product.line[description]	string	Description de la ligne de produit
product.line[family]	object*	Famille de produit
product.line.family[uuid]	string	Référence de la famille de produit
product.line.family[code]	string	Code de la famille de produit
product.line.family[name]	string	Nom de la famille de produit
product.line.family[description]	string	Description de la famille de produit
end_customer	object*	Informations sur le client final
end_customer[type]	string	Type de client final. Valeurs possibles: `registered`, `unregistered` ou `individual`
end_customer[name]	string	Nom du client final (entreprise). A renseigner si end_customer[type] est `registered` ou `unregistered`
end_customer[first_name]	string	Prénom du client final. A renseigner si end_customer[type] est `unregistered`
end_customer[last_name]	string	Nom de famille du client final. A renseigner si end_customer[type] est `unregistered`
end_customer[siret]	string	Numéro SIRET de l'entreprise. A renseigner si end_customer[type] est `registered`
end_customer[naf_code]	string	Code NAF de l'entreprise. Peut être renseigné si end_customer[type] est `registered`. Aide à identifier le client final.
end_customer[contact]	string	Informations de contact du client final
end_customer.contact[first_name]	string	Prénom du contact
end_customer.contact[last_name]	string	Nom de famille du contact
end_customer.contact[email]	string	E-mail du contact
end_customer.contact[phone_number]	string	Téléphone principal du contact
end_customer.contact[cell_phone_number]	string	Téléphone portable du contact
operator_info	object*	Informations relatives à l'opérateur (vous)
operator_info[contact_uuid]	string	Référence du contact de l'opérateur à contacter concernant cette commande
bounds	list	Informations aux extrémités (adresse, endpoints, ...)
bounds[uuid]	string	Identifiant d'une extrémité
bounds[address]	string	Adresse associée d'une extrémité
bounds.address[street_number]	string	Numéro de rue
bounds.address[street_name]	string	Nom de la rue
bounds.address[zipcode]	string	Code postal
bounds.address[city]	string	Ville
bounds.address[kosc_street_code]	string	Identifiant Covage de la voie
bounds.address[kosc_insee_code]	string	Code INSEE Covage de la commune
bounds.address[building_code]	string	Code immeuble
bounds.address[building]	string	Nom du bâtiment
bounds.address[stairs]	string	Escalier
bounds.address[floor]	string	Étage
bounds.address[door]	string	Porte
bounds.address[logo]	string	Logo
bounds[information]	string	Informations supplémentaire sur l'extrémité
bounds.information[co]	string	Nom du NRO
bounds.information[building_operator_code]	string	Code de l'opérateur d'immeuble
bounds.information[building_operator_name]	string	Nom de l'opérateur d'immeuble
bounds[endpoints]	list	Liste des endpoints sur une extrémité
bounds.endpoints[uuid]	string	Identifiant d'un endpoint
bounds.endpoints[reference]	string	Référence d'un endpoint
bounds.endpoints[type]	string	Type d'endpoint, pour la fibre: OTP
bounds.endpoints[locked]	boolean	Indique si l'utilisateur peut modifier ou non l'endpoint
options	object*	Options (dépend du produit sélectionné)
options[gtr]	object	Option GTR
options.gtr[enabled]	boolean	true si l'option est activée
options.gtr[value]	string	Valeur de la GTR choisie
options.gtr[default_value]	string	Si cette valeur est renseignée: valeur de la GTR par défaut
options[patch_panel]	object	Option Patch Panel
options.patch_panel[enabled]	boolean	true si l'option est activée

Lister les services¶

Permet de lister tous les services.

Il est possible de filtrer sur plusieurs champs :

reference: rechercher par référence de service

status: rechercher par statut: active, terminated

endpoint_ref: rechercher par référence d'endpoint

end_customer: rechercher par nom de client final

Request URL /api/fiber-services/?

Exemple de requête¶

GET /api/fiber-services/?status=active&reference=S180713_39002&end_customer=asd HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

Exemple de réponse¶

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "uuid": "5e2f9694-a6e7-40da-9d78-b603302db02a",
        "reference": "S180713_39002",
        "status": "active",
        "activate_order_ref": "O180713_39001",
        "activate_order_uuid": "bgwas5tt",
        "product": {
            "code": "FP01",
            "name": "PROFESSIONAL-FIBER",
            "description": "PROFESSIONAL FIBER",
            "line": {
                "name": "PRO-FIBER",
                "code": "FP",
                "description": "Professional Fiber",
                "family": {
                    "name": "FIBR",
                    "code": "F",
                    "description": "Fiber"
                }
            }
        },
        "end_customer": {
            "contact": {
                "first_name": "asd",
                "last_name": "asd",
                "phone_number": "01242323232",
                "email": "asd@asd.com"
            },
            "type": "unregistered",
            "name": "asd"
        },
        "operator_info": {
            "contact_uuid": "zitjrmff"
        },
        "bounds": [
            {
                "endpoints": [
                    {
                        "reference": "FI-1234-2342",
                        "type": "otp"
                    }
                ],
                "address": {
                    "kosc_street_code": "9169103000",
                    "kosc_insee_code": "91691",
                    "zipcode": "91330",
                    "street_name": "RUE BERTHIER",
                    "street_number": "2",
                    "city": "YERRES",
                    "building_code": "IMB/91691/C/00I2",
                    "stairs": "_NA_",
                    "floor": "_NA_"
                },
                "information": {
                    "co": "91114BRN"
                }
            }
        ],
        "options": {
            "gtr": {
                "enabled": true,
                "value": "d_plus_1"
            }
        },
        "information": {},
        "activation_date": "2018-07-13T15:49:54.168555Z",
        "starting_date": "2018-07-20T15:49:54.168555Z",
        "creation_date": "2018-07-13T15:49:54.168907Z",
        "modification_date": "2018-08-27T10:05:54.070594Z",
        "sort_value": "cD0yMDE4LTA3LTEzVDE1JTNBNDklM0E1NC4xNjg5MDda"
    }
]

Récupérer un service¶

Permet de récupérer un service avec son identifiant uuid.

Request URL /api/fiber-services/{uuid}/

Exemple de requête¶

GET /api/fiber-services/0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

Exemple de réponse¶

HTTP/1.1 200 OK
Content-Type: application/json

{
    "uuid": "e0422430-1be8-4647-bf3d-802b40eb9d71",
    "reference": "S180713_39002",
    "status": "active",
    "activate_order_ref": "O180713_39001",
    "activate_order_uuid": "97e98a3f-339e-4f49-9298-d6c979b10b20",
    "product": {
        "code": "FP01",
        "name": "PROFESSIONAL-FIBER",
        "description": "PROFESSIONAL FIBER",
        "line": {
            "name": "PRO-FIBER",
            "code": "FP",
            "description": "Professional Fiber",
            "family": {
                "name": "FIBR",
                "code": "F",
                "description": "Fiber"
            }
        }
    },
    "end_customer": {
        "contact": {
            "first_name": "asd",
            "last_name": "asd",
            "phone_number": "01242323232",
            "email": "asd@asd.com"
        },
        "type": "unregistered",
        "name": "asd"
    },
    "operator_info": {
        "contact_uuid": "zitjrmff"
    },
    "bounds": [
        {
            "endpoints": [
                {
                    "reference": "FI-1234-2342",
                    "type": "otp"
                }
            ],
            "address": {
                "kosc_street_code": "9169103000",
                "kosc_insee_code": "91691",
                "zipcode": "91330",
                "street_name": "RUE BERTHIER",
                "street_number": "2",
                "city": "YERRES",
                "building_code": "IMB/91691/C/00I2",
                "stairs": "_NA_",
                "floor": "_NA_"
            },
            "information": {
                "co": "91114BRN"
            }
        }
    ],
    "options": {
        "gtr": {
            "enabled": true,
            "value": "d_plus_1"
        }
    },
    "information": {},
    "activation_date": "2018-07-13T15:49:54.168555Z",
    "starting_date": "2018-07-20T15:49:54.168555Z",
    "creation_date": "2018-07-13T15:49:54.168907Z",
    "modification_date": "2018-08-27T10:05:54.070594Z"
}