Products

Product family

Product family components

Field name	Type	Description
product_family_uuid	string	Product family identifier
code	string	Product family code
name	string	Product family name
description	string	Product family description
priority	string	Product family priority

Retrieving a product family

GET /api/product-families/o5kp26aa/ HTTP/1.1
Host: extranet.kosc-telecom.fr

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

{
    "product_family_uuid": "o5kp26aa",
    "code": "D",
    "name": "KOSC unbundling",
    "description": "",
    "priority": "0007"
}

Listing the product families

GET /api/product-families/ HTTP/1.1
Host: extranet.kosc-telecom.fr

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

[
    {
        "product_family_uuid": "o5kp26aa",
        "code": "D",
        "name": "KOSC unbundling",
        "description": "",
        "priority": "0007"
    },
    {
        "product_family_uuid": "rsvjvpsy",
        "code": "A",
        "name": "ADSL",
        "description": "ADSL * technology : ADSL, VDSL, READSL",
        "priority": "0001"
    }
]

Product lines

Product line components

Field name	Type	Description
product_line_uuid	string	Product line identifier
code	string	Product code
description	string	Product description
family	dictionary	Product family information
priority	string	Product priority.
line_type	integer	Example : copper

family dictionary

Field name	Type	Description
code	string	Product family code
name	string	Product family name

Example:

{
    "product_line_uuid": "0atlcz9r",
    "code": "SL",
    "name": "SDSL-1M",
    "description": "SDSL-1M * Rate : 1 Mbits",
    "family": {
        "code": "S",
        "name": "SDSL"
    },
    "priority": "00020003",
    "line_type": 2
}

Retrieving a product line

GET /api/product-lines/0atlcz9r/ HTTP/1.1
Host: extranet.kosc-telecom.fr

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

{
    "product_line_uuid": "0atlcz9r",
    "code": "SL",
    "name": "SDSL-1M",
    "description": "SDSL-1M * Rate : 1 Mbits",
    "family": {
        "code": "S",
        "name": "SDSL"
    },
    "priority": "00020003",
    "line_type": 2
}

Listing the product lines

GET /api/product-lines/ HTTP/1.1
Host: extranet.kosc-telecom.fr

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

[
    {
        "product_line_uuid": "0atlcz9r",
        "code": "SL",
        "name": "SDSL-1M",
        "description": "SDSL-1M * Rate : 1 Mbits",
        "family": {
            "code": "S",
            "name": "SDSL"
        },
        "priority": "00020003",
        "line_type": 2
    },
    {
        "product_line_uuid": "8iiqme4o",
        "code": "SC",
        "name": "SDSL-3M",
        "description": "SDSL-3M * Rate : 3 Mbits",
        "family": {
            "code": "S",
            "name": "SDSL"
        },
        "priority": "00020005",
        "line_type": 2
    }
]

Products

Components of a product

Field name	Type	Description
product_uuid	string	Product unique identifier
code	string	Product code
name	string	Product name
provider	string	Network provider
description	string	Product description
priority	string	Product priority
line	dictionary	Object containing the product line information
family	dictionary	Object containing the product family information
options	dictionary	Object containing the product options that can be activated
settings	dictionary	Object containing the product configuration

line dictionary

Field name	Type	Description
code	string	Product line code
name	string	Product line name

family dictionary

Field name	Type	Description
code	string	Product family code
name	string	Product family name

options dictionary

The options object is a dictionary whose key is an option code and whose value is a dictionary containing the configuration option for that product.

Available option codes are listed below:

Code	Description
grt	Guaranteed recovery time
unlisted_number	Red list option
paid_desat	Desaturation option
guaranteed_bandwidth	Guaranteed rate option
portability	Portability option
demarcation_device	Demarcation Device option
contract_term	Contract Term option
enni_redundancy	Enni Redundancy option

The configuration of an option consists of the following fields:

Field name	Type	Description
enabled	boolean	Shows whether the option is enabled or not
values	list	If the field is present, it contains the list of available choices for that option

settings dictionary

Field name	Type	Description
cos	string	Class of service, specifies whether the product is guaranteed (G) or not guaranteed (ng)
bitrate	integer	Delivered product rate
max_bitrate	integer	Maximum product rate (Best effort)
technology	string	Product technology (SDSL or ADSL)
unbundling	string	Unbundling type (FULL or PARTIAL)
pairs_nb	integer	Number of pairs in the product
mode	string	Product mode (EFM or ATM)
sla	string	Product service level agreement (standard or PREMIUM)

Retrieving a product

To retrieve a product, you need to do a GET on the /api/products/{product_uuid}/ URL.

Example:

GET /api/products/0s7ci7c4/ HTTP/1.1
Host: extranet.kosc-telecom.fr

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

{
    "product_uuid": "0s7ci7c4",
    "code": "SA01",
    "name": "SDSL-0,5M-PREMIUM-G-1P-KOSC",
    "provider": "KOSC",
    "description": "SDSL 0.5Mbit/s  PREMIUM * Guaranteed * 1 pair * KOSC",
    "priority": "000200020001",
    "line": {
        "code": "SA",
        "name": "SDSL-0,5M"
    },
    "family": {
        "code": "S",
        "name": "SDSL"
    },
    "options": {
        "portability": {
            "enabled": true
        },
        "unlisted_number": {
            "enabled": true
        },
        "guaranteed_bandwidth": {
            "enabled": false
        },
        "paid_desat": {
            "enabled": true
        },
        "grt": {
            "enabled": true,
            "values": [
                "4h_24_7"
            ]
        },
        "demarcation_device": {
            "enabled": true
        },
        "contract_term": {
            "enabled": true,
            "values": [
                "36_months"
            ]
        }
    },
    "settings": {
        "cos": "G",
        "bitrate": 500000,
        "technology": "SDSL",
        "unbundling": "FULL",
        "pairs_nb": 1,
        "mode": "EFM",
        "sla": "PREMIUM"
    }
}

Listing the products

To list the existing products, you need to do a GET on the /api/products/ URL.

You can filter the results by adding one of the following parameters to the URL:

Parameter name	Description
line	Product line code

Example:

GET /api/products/?line=AM HTTP/1.1
Host: extranet.kosc-telecom.fr

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

[
    {
        "product_uuid": "2nr0jwzs",
        "code": "AM08",
        "name": "ADSL-Max-partial-KOSC",
        "provider": "KOSC",
        "description": "ADSL * partial unbundling  * KOSC",
        "priority": "000100010008",
        "line": {
            "code": "AM",
            "name": "ADSL-Max"
        },
        "family": {
            "code": "A",
            "name": "ADSL"
        },
        "options": {
            "portability": {
                "enabled": false
            },
            "unlisted_number": {
                "enabled": true
            },
            "guaranteed_bandwidth": {
                "enabled": false
            },
            "paid_desat": {
                "enabled": false
            },
            "inner_wiring": {
                "enabled": true
            },
            "grt": {
                "enabled": true,
                "values": [
                    "4h_bhbd",
                    "4h_24_7"
                ]
            },
            "demarcation_device": {
                "enabled": false
            },
            "contract_term": {
                "enabled": true,
                "values": [
                    "36_months"
                ]
            }
        },
        "settings": {
            "cos": "ng",
            "max_bitrate": 24000000,
            "technology": "ADSL",
            "unbundling": "partial",
            "vlan": "MN",
            "pairs_nb": 1
        }
    },
    {
        "product_uuid": "i8k4fzfq",
        "code": "AM01",
        "name": "ADSL-Max-FULL-KOSC",
        "provider": "KOSC",
        "description": "ADSL * FULL unbundling  * KOSC",
        "priority": "000100010001",
        "line": {
            "code": "AM",
            "name": "ADSL-Max"
        },
        "family": {
            "code": "A",
            "name": "ADSL"
        },
        "options": {
            "portability": {
                "enabled": true
            },
            "unlisted_number": {
                "enabled": true
            },
            "guaranteed_bandwidth": {
                "enabled": false
            },
            "paid_desat": {
                "enabled": true
            },
            "inner_wiring": {
                "enabled": true
            },
            "grt": {
                "enabled": true,
                "values": [
                    "4h_bhbd",
                    "4h_24_7"
                ]
            },
            "demarcation_device": {
              "enabled": false
            },
            "contract_term": {
                "enabled": true,
                "values": [
                    "36_months"
                ]
            }
        },
        "settings": {
            "cos": "ng",
            "max_bitrate": 24000000,
            "technology": "ADSL",
            "unbundling": "FULL",
            "vlan": "MN",
            "pairs_nb": 1
        }
    }
]