Ordering an xDSL line

Activation type activate

The activation of an existing line, either active or idle, is the easiest of the cases.

The only field requiring specification is the endpoints field that contains the specific endpoint to be activated.

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

{
    "activation_info": {
        "mandate_id": "01234567"
    },
    "activation_type": "activate",
    "comment": "Comments",
    "contacts": {
        "operator": {
            "contact_uuid": "bp5nkkcx"
        },
        "owner": {
            "email": "email@domain.com",
            "first_name": "First name",
            "last_name": "Last name",
            "phone_number": "0123456789"
        }
    },
    "eligibility_ref": "KOSC_57ff668b-69a7-42a0-853a-12fabac2bce5",
    "endpoints": [
        {
            "endpoint_ref": "0143340043",
            "endpoint_ref_type": "line_number"
        }
    ],
    "operator_order_name": "Order for customer Someone",
    "operator_order_ref": "UNTEL02-1",
    "options": {
        "grt": {
            "enabled": true,
            "value": "4h_bhbd"
        }
    },
    "owner": {
        "name": "Someone",
        "type": "unregistrated"
    },
    "product": {
        "code": "AM01"
    },
    "type": "activate"
}

Activation type create

The activation type create allows the creation of a second line for the same address and the same owner.

Since the line that is going to be created will have the exact same address as the reference line, specifying the address field when creating the order is not useful.

Example:

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" : "First name",
         "last_name" : "Last name"
      }
   },
   "operator_order_ref" : "UNTEL02-1",
   "operator_order_name" : "Order for customer Someone",
   "comment" : "Comments",
   "activation_info" : {
      "mandate_id" : "01234567"
   },
   "owner" : {
      "type" : "unregistrated",
      "name" : "Someone"
   }
}

Activation type create_neighbour

Activation type create_neighbour allows to create a line in a specific address by doing an elibility on the closest line on the same sidewalk.

To specify the address of the line to create, it is necessary to provide street_number on the address field.

Optionaly, the following fields can also be passed:

• stairs

• building

• logo

• door

• housing

• floor

Missing address information will be extracted from the reference endpoint.

Example:

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" : "Order for a customer"
   "comment" : "Commentaires",
   "contacts" : {
      "owner" : {
         "first_name" : "First name",
         "last_name" : "Last name"
         "phone_number" : "0123456789",
         "email" : "email@domain.com",
      },
      "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 type create_nearby

Since this type of activation is used to activate a line for the same address as specified by the reference endpoint, only the following fields can be filled in the address field:

• stairs

• building

• logo

• door

• housing

• floor

Missing address information will be extracted from the reference endpoint.

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": "first name",
            "last_name": "last name",
            "phone_number": "0123456789"
        }
    },
    "eligibility_ref": "KOSC_6563c5f8-7297-43ee-a922-1b8db2aa9b49",
    "operator_order_name": "Order for a customer",
    "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

This option is available only for a line creation with the ADSL (AM01, AM08), VDSL (AV01, AV08) and SDSL products (including SDSL Max). Please refer to your contract regarding the price of the ranges.

Example

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

Fields

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+

Possible Errors

In the event of an error, an HTTP 400 is responded which contains the following possible errors:

options.internal_cabling.internal_cabling_length. (If enabled is true this field is mandatory)

options.internal_cabling.internal_cabling_length {value} is not a valid choice. Possible values are - 0-5m - 5-60m - 60m+

options.internal_cabling The internal cabling option is not available for this product. This error occurs if you try to enable this option with a product other than SDSL