Commander une ligne xDSL

Activation de type activate

L'activation d'une ligne existante, qu'elle soit active ou inactive, est le cas le plus simple.

Le seul champ à préciser est le champ endpoints contenant l'endpoint à activer.

POST /api/orders/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
   "type" : "activate",
   "activation_type" : "activate",
   "eligibility_ref" : "KOSC_57ff668b-69a7-42a0-853a-12fabac2bce5",
   "product" : {
      "code" : "AM01"
   },
   "options" : {
      "grt" : {
         "value" : "4h_bhbd",
         "enabled" : true
      }
   },
   "contacts" : {
      "operator" : {
         "contact_uuid" : "bp5nkkcx"
      },
      "owner" : {
         "phone_number" : "0123456789",
         "email" : "email@domain.com",
         "first_name" : "Prénom",
         "last_name" : "Nom"
      }
   },
   "operator_order_ref" : "UNTEL02-1",
   "operator_order_name" : "Commande pour client Untel",
   "comment" : "Commentaires",
   "activation_info" : {
      "mandate_id" : "01234567"
   },
   "owner" : {
      "type" : "unregistrated",
      "name" : "Untel"
   },
   "endpoints" : [ {
      "endpoint_ref_type" : "line_number",
      "endpoint_ref" : "0143340043"
   } ]
}

Activation de type create

L'activation de type create permet de créer une deuxième ligne à la même adresse pour le même propriétaire.

La ligne qui sera créée ayant exactement la même adresse que la ligne de référence, il n'est pas utile de préciser le champ address à la création de l'order.

Exemple:

POST /api/orders/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
   "type" : "activate",
   "activation_type" : "create",
   "eligibility_ref" : "KOSC_57ff668b-69a7-42a0-853a-12fabac2bce5",
   "product" : {
      "code" : "AM01"
   },
   "options" : {
      "grt" : {
         "value" : "4h_bhbd",
         "enabled" : true
      }
   },
   "contacts" : {
      "operator" : {
         "contact_uuid" : "bp5nkkcx"
      },
      "owner" : {
         "phone_number" : "0123456789",
         "email" : "email@domain.com",
         "first_name" : "Prénom",
         "last_name" : "Nom"
      }
   },
   "operator_order_ref" : "UNTEL02-1",
   "operator_order_name" : "Commande pour client Untel",
   "comment" : "Commentaires",
   "activation_info" : {
      "mandate_id" : "01234567"
   },
   "owner" : {
      "type" : "unregistrated",
      "name" : "Untel"
   }
}

Activation de type create_neighbour

L'activation de type create_neighbour permet de créer une ligne à une adresse spécifique en faisant une éligibilité sur l'adresse la plus et proche sur le même troitoir.

Pour préciser l'adresse de la ligne à créer, il est nécessaire de préciser le champ street_number dans le dictionnaire address.

Les champs suivant sont optionnels:

• stairs

• building

• logo

• door

• housing

• floor

Les informations d'adresse manquantes seront extraites de l'endpoint de référence.

Exemple:

POST /api/orders/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
   "type" : "activate",
   "activation_type" : "create_neighbour",
   "eligibility_ref" : "KOSC_dd429e0c-68b0-4ff1-b869-9d6b1752658c",
   "product" : {
      "code" : "AM01",
   },
   "operator_order_ref" : "UNTEL01-02",
   "operator_order_name" : "Commande pour client Untel",
   "comment" : "Commentaires",
   "contacts" : {
      "owner" : {
         "first_name" : "Prénom",
         "phone_number" : "0123456789",
         "email" : "email@domain.com",
         "last_name" : "Nom"
      },
      "operator" : {
         "contact_uuid" : "bp5nkkcx"
      }
   },
   "owner" : {
      "name" : "Untel",
      "type" : "unregistrated",
   },
   "activation_info" : {
      "mandate_id" : "01234567"
   },
   "options" : {
      "grt" : {
         "enabled" : true,
         "value" : "4h_bhbd"
      }
   },
   "address" : {
      "street_number" : "39",
   }
}

Activation de type create_nearby

Dans la mesure où ce type d'activation est utilisé pour activer une ligne à la même adresse que l'endpoint de référence, seuls les champs suivants peuvent être renseignés dans le champ address:

• stairs

• building

• logo

• door

• housing

• floor

Les informations manquantes seront extraites de l'endpoint de référence.

POST /api/orders/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
    "activation_info": {
        "mandate_id": "01234567"
    },
    "activation_type": "create_nearby",
    "address": {
        "building": "05",
        "door": "24",
        "floor": "04",
        "housing": "13",
        "logo": "06",
        "stairs": "003"
    },
    "comment": "Commentaires",
    "contacts": {
        "operator": {
            "contact_uuid": "bp5nkkcx"
        },
        "owner": {
            "email": "email@domain.com",
            "first_name": "Pr\u00e9nom",
            "last_name": "Nom",
            "phone_number": "0123456789"
        }
    },
    "eligibility_ref": "KOSC_6563c5f8-7297-43ee-a922-1b8db2aa9b49",
    "operator_order_name": "Commande pour client Untel",
    "operator_order_ref": "UNTEL01-2",
    "options": {
        "grt": {
            "enabled": true,
            "value": "4h_24_7"
        }
    },
    "owner": {
        "name": "Untel",
        "type": "unregistrated"
    },
    "product": {
        "code": "AM01"
    },
    "type": "activate"
}

Internal Cabling

Cette option est disponible uniquement pour une création de ligne avec les produits ADSL (AM01, AM08), VDSL (AV01, AV08)

et SDSL (SDSL Max inclut). Pour connaitre les prix associés, veuillez vous référer à votre contrat.

Exemple

{
    "options": {
        "internal_cabling": {
            "enabled": true,
            "internal_cabling_length": "5-60m"
        }
    }
}

Champs

Field name	Type	Description
enabled	boolean	weither the internal cabling is enabled or not
internal_cabling_length	string	possible values are 0-5m, 5-60m, 60m+

Possibles erreurs

En cas d'erreur, une réponse HTTP 400 est renvoyé contenant l'une des erreurs suivantes:

options.internal_cabling.internal_cabling_length. (Si le champs enabled à la valeur True ce champ est obligatoire)

options.internal_cabling.internal_cabling_length {value} is not a valid choice. Les valeurs possibles sont: 0-5m, 5-60m, 60m+

options.internal_cabling The internal cabling option is not available for this product.