Cuivre¶

La plateforme supporte deux types de services selon la gamme de produits utilisé pour commander un service:

Un service de type collect se définit par un produit appartenant aux familles ADSL (A), SDSL (S) ou SDSL Max (M).
Les service de type enni se définit par un produit appartenant la famille ENNI (N).

Les attributs d'un service permettent d'identifier, de définir et de suivre l'évolution d'un service. Selon le type de service (enni ou collect)

Identifier un service¶

Un service est un dictionnaire contenant une variété de champs représentant un lien en production.

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

Nom du champ	Type	Description
model	string	`service`
service_uuid	string	Identifiant technique du service (usage m-to-m)
alias	string	Référence commercial Covage du service créé à communiquer à l'équipe SAV
operator_uuid	string	Identifiant de l'opérateur (vous)

Définition du service¶

type	string	Type de service: `collect` ou `enni`
product	dictionnaire	Informations sur le produit choisi

Champ `product`¶

Le dictionnaire product contient les informations du produit activé sur le service ainsi que les informations sur la ligne de produit et la famille de produit.

Voir la documentation ici.

Suivi du cycle de vie d'un service¶

status	string	État du service : `active`, ...
creation_date	ISO datetime	Date de création du service
modification_date	ISO datetime	Date de dernière modification du service
activation_date	ISO datetime	Date de démarrage effectif du service

Caractéristiques d'un service de type `collect`¶

endpoints	liste de dictionnaires	Liste des `endpoints` qui constituent le service
contacts	dictionnaire	Informations de contacts précisés lors de la commande
owner	dictionnaire	Informations sur le client final
enni	dictionnaire	Informations sur l'ENNI vers lequel doit être router le traffic (cas d'utilisation d'un produit de famille `S`)
options	dictionnaire	Options à activer

Champ `endpoints`¶

Le champ endpoints contient le ou les endpoints du service.

Voir la documentation ici.

Champ `contacts`¶

Le champ contacts est un dictionnaire contenant les informations sur les personnes à contacter pour la réalisation du service.

Voir la documentation ici.

Champ `owner`¶

Le champ owner est un dictionnaire contenant les informations d'identification du client final.

Voir la documentation ici.

Champ `options`¶

Le champ options est un dictionnaire dont la clef est le code de l'option et la valeur est un dictionnaire contenant sa configuration.

Voir la documentation ici.

Champ `enni`¶

Le champ enni est un dictionnaire contenant les informations sur l'ENNI vers lequel vous souhaitez router le traffic pour les produits de la famille SDSL (S)

Voir la documentation ici.

Caractéristiques d'un service de type `enni`¶

Nom du champ	Type	Description
pop	dictionnaire	Informations on the `pop`

Le champ pop est un dictionnaire contenant les information du POP.

Voir la documentation ici.

Récupérer un `service`¶

Il est possible de récupérer un service avec la méthode GET sur l'url /api/services/{service_uuid}/.

GET /api/services/3acf5ab1-4062-4199-ba98-c3f94681b3de/ HTTP/1.1
Host: extranet.kosc-telecom.fr

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

{
    "alias": "S190913_75475",
    "model": "service",
    "service_uuid": "3acf5ab1-4062-4199-ba98-c3f94681b3de",
    "product": {
        "code": "AM01",
        "name": "ADSL-Max_FULL_BE_KOSC",
        "description": "ADSL Max * FULL unbundling * Best Effort * KOSC",
        "line": {
            "name": "ADSL-Max",
            "code": "AM",
            "description": "ADSL-MAX * Best of ADSL products",
            "family": {
                "name": "ADSL",
                "code": "A",
                "description": "ADSL * technology : ADSL, VDSL, READSL"
            }
        }
    },
    "endpoints": [
        {
            "endpoint_ref": "0492271978",
            "endpoint_ref_type": "line_number",
            "concentration_point": {
                "latlng": {
                    "latitude": 43.7101894,
                    "longitude": 7.2930888
                },
                "address": {
                    "kosc_street_code": "0608859150",
                    "kosc_insee_code": "06088",
                    "street_number": "00022",
                    "street_name": "BD SAINT ROCH",
                    "city": "NICE",
                    "housing_complex": null,
                    "building": null,
                    "stairs": null,
                    "floor": null,
                    "door": null,
                    "logo": null
                }
            },
            "info": {
                "inactive": false,
                "unlisted_number": true,
                "available_pairs": 11,
                "max_available_pairs": 11,
                "under_construction": false
            },
            "characteristics": {
                "sections_lengths": [
                    {
                        "diameter": 4,
                        "length": 1425
                    }
                ],
                "head": "D/91123",
                "starter": 29,
                "pair": 4,
                "nra": "06088CAR"
            },
            "address": {
                "kosc_street_code": "0608859150",
                "kosc_insee_code": "06088",
                "street_number": "22",
                "street_name": "BOULEVARD SAINT ROCH",
                "city": "NICE",
                "zipcode": "06000",
                "housing_complex": "PRESSE DU BOULEVARD",
                "building": null,
                "stairs": null,
                "floor": "00",
                "door": null,
                "logo": null
            }
        }
    ],
    "owner": {
        "type": "unregistrated",
        "name": "Untel"
    },
    "contacts": {
        "operator": {
            "contact_uuid": "cqu9dq4s",
            "first_name": "John",
            "last_name": "Doe",
            "email": "john@doe.fr",
            "phone_number": "0142845404",
            "cell_phone_number": "0692417901",
            "creation_date": "2019-06-10T12:49:14.723808Z"
        },
        "owner": {
            "first_name": "Prénom",
            "last_name": "Nom",
            "phone_number": "0123456789",
            "email": "email@domain.com"
        }
    },
    "options": {
        "portability": {
            "enabled": false
        },
        "grt": {
            "enabled": false,
            "default_value": "standard"
        },
        "unlisted_number": {
            "enabled": false
        },
        "internal_cabling": {
            "enabled": false,
            "internal_cabling_length": "0-5m",
            "default_value": "0-5m"
        },
        "contract_term": {
            "enabled": false,
            "value": "12_months",
            "default_value": "12_months"
        }
    },
    "activation_date": "2019-09-13T14:03:32.764939Z",
    "status": "active",
    "current_order_uuid": null,
    "current_order_type": null,
    "ticket_id": null,
    "creation_date": "2019-09-13T14:03:32.592482Z",
    "modification_date": "2019-09-13T14:03:32.765156Z",
    "activate_order_uuid": "6d1f0d8a-de30-465b-b2f8-8a324e1c9398",
    "delivery_confirmation_date": "2019-09-20T14:03:32.764939Z",
    "sort_value": "cD0yMDE5LTA5LTEzVDE0JTNBMDMlM0EzMi41OTI0ODJa",
    "address": {
        "kosc_street_code": "0608859150",
        "kosc_insee_code": "06088",
        "street_number": "22",
        "street_name": "BOULEVARD SAINT ROCH",
        "city": "NICE",
        "zipcode": "06000",
        "housing_complex": "PRESSE DU BOULEVARD",
        "building": null,
        "stairs": null,
        "floor": "00",
        "door": null,
        "logo": null
    }
}

Résilier un `service`¶

Afin de résilier un service, un order doit être créé avec un type terminate. Voir la documentation ici.

Cuivre¶

Identifier un service¶

Définition du service¶

Champ product¶

Suivi du cycle de vie d'un service¶

Caractéristiques d'un service de type collect¶

Champ endpoints¶

Champ contacts¶

Champ owner¶

Champ options¶

Champ enni¶

Caractéristiques d'un service de type enni¶

Récupérer un service¶

Résilier un service¶

Champ `product`¶

Caractéristiques d'un service de type `collect`¶

Champ `endpoints`¶

Champ `contacts`¶

Champ `owner`¶

Champ `options`¶

Champ `enni`¶

Caractéristiques d'un service de type `enni`¶

Récupérer un `service`¶

Résilier un `service`¶