Fibre¶
Représente une commande fibre. Une commande est un dictionnaire contenant une liste de champs représentant un futur service.
Celle-ci implémente un payload différent de l'API cuivre.
API INDEX URL https://extranet.kosc-telecom.fr/api/fiber-orders/
Action |
URL |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Exemple d'une commande¶
GET /api/fiber-orders/0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json
{
"uuid": "709e77c5-8f38-4db4-819e-77633f63f8a8",
"reference": "O180713_39001",
"status": "completed",
"type": "activate",
"request_type": "create",
"service_ref": "S180713_39001",
"service_uuid": "524ab500-2561-4726-b3d6-87becfd95ea6",
"eligibility_ref": "elig-3a5213ba-a606-4c7f-a894-e1f9d4609750",
"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": {
"type": "individual",
"first_name": "Frodo",
"last_name": "Baggins",
"contact": {
"first_name": "Gandoulf",
"last_name": "Legrisant",
"email": "gandoulf.legrisant@youshallnotpass.com",
"phone_number": "0456322365",
"cell_phone_number": "0612345678"
}
},
"operator_info": {
"order_ref": "TheOne",
"order_name": "TheRing",
"contact_uuid": "9bd806aa-f394-4545-87f2-b740dd0dd5ad"
},
"bounds": [
{
"uuid": "64c58141-6ee2-4ba9-a110-b2db169fc7e5",
"address": {
"street_number": "34",
"street_name": "AVENUE SAINT LAURENT",
"zipcode": "91400",
"city": "ORSAY",
"kosc_street_code": "9147129100",
"kosc_insee_code": "91471",
"building_code": "IMB/91471/C/NU2C",
"building": "GARDIEN",
"stairs": "1",
"floor": "2",
"door": "36",
"logo": "logo"
},
"information": {
"co": "75107SEG",
"building_operator_code": "FI",
"building_operator_name": "ORANGE"
},
"endpoints": [
{
"uuid": "94da5adb-ed7d-4569-9f80-28459fde33fa",
"reference": "FI-1234-5678",
"type": "otp"
}
]
}
],
"options": {
"gtr": {
"enabled": true,
"value": "d_plus_1"
}
},
"last_status_update": "2018-05-31 14:30:01.162500+00:00",
"submission_date": "2018-07-13T15:14:51.238228Z",
"acknowledged_date": "2018-07-13T15:16:16.199866Z",
"processing_date": "2018-07-13T15:20:38.989706Z",
"completion_date": "2018-07-13T15:22:58.890678Z",
"creation_date": "2018-07-13T15:12:26.085102Z",
"modification_date": "2018-07-13T15:22:58.884850Z"
}
Exemple d'une commande E-access Fiber¶
GET /api/fiber-orders/0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json
{
"acknowledged_date": "2018-07-13T15:16:16.199866Z",
"bounds": [
{
"address": {
"building": "GARDIEN",
"building_code": "IMB/91471/C/NU2C",
"city": "ORSAY",
"door": "36",
"floor": "2",
"kosc_insee_code": "91471",
"kosc_street_code": "9147129100",
"logo": "logo",
"stairs": "1",
"street_name": "AVENUE SAINT LAURENT",
"street_number": "34",
"zipcode": "91400"
},
"uuid": "64c58141-6ee2-4ba9-a110-b2db169fc7e5"
}
],
"completion_date": "2018-07-13T15:22:58.890678Z",
"creation_date": "2018-07-13T15:12:26.085102Z",
"eligibility_ref": "elig-3a5213ba-a606-4c7f-a894-e1f9d4609750",
"end_customer": {
"contact": {
"cell_phone_number": "0612345678",
"email": "gandoulf.legrisant@youshallnotpass.com",
"first_name": "Gandoulf",
"last_name": "Legrisant",
"phone_number": "0456322365"
},
"first_name": "Frodo",
"last_name": "Baggins",
"type": "individual"
},
"endpoints": [
{
"reference": "FI-1234-5678",
"type": "otp",
"uuid": "94da5adb-ed7d-4569-9f80-28459fde33fa"
}
],
"information": {
"end_user_premises_availability_date": "2018-07-30",
"end_user_premises_phone_number": "0123456789",
"end_user_premises_product_reference": "SERVICENUMBER",
"ennis": [
{
"reference": "S180228_10001",
"uuid": "18c2d878-3281-4258-b201-7bdaac57f05f",
"vlan": "200"
}
],
"requested_provision_date": "2018-07-30"
},
"last_status_update": "2018-05-31 14:30:01.162500+00:00",
"modification_date": "2018-07-13T15:22:58.884850Z",
"operator_info": {
"contact_uuid": "9bd806aa-f394-4545-87f2-b740dd0dd5ad",
"order_name": "TheRing",
"order_ref": "TheOne"
},
"options": {
"gtr": {
"enabled": true,
"value": "d_plus_1"
}
},
"processing_date": "2018-07-13T15:20:38.989706Z",
"product": {
"code": "EA02",
"description": "E-ACCESS-FIBER 10Mbit/s * PREMIUM * priority",
"line": {
"code": "EA",
"description": "E-ACCESS-FIBER * 10 Mbits",
"family": {
"code": "E",
"description": "E-Access Fiber",
"name": "EAF"
},
"name": "EAFIBER-10M"
},
"name": "E-ACCESS-FIBER_10M_PREMIUM_p"
},
"reference": "O180713_39001",
"request_type": "create",
"service_ref": "S180713_39001",
"service_uuid": "524ab500-2561-4726-b3d6-87becfd95ea6",
"status": "completed",
"submission_date": "2018-07-13T15:14:51.238228Z",
"type": "activate",
"uuid": "709e77c5-8f38-4db4-819e-77633f63f8a8"
}
La description des formats des requêtes et réponses de méthodes de l’API sont sous la forme de tableau :
Nom du champ |
Type du champ |
Pour les requêtes, si l’élèment est [O]bligatoire, [C]onditionel ou [F]acultatif |
Description du champ |
Dans le cas d’objet composite, la cascade est représentée ainsi :
objet1 |
objet |
Description objet1 |
|
objet1[élément] |
type de l'élément |
Description de l'élément |
|
objet1.élément[sous-élement] |
type de sous-élément |
Description du sous élément |
Attributs de l'order¶
uuid |
string |
Identifiant de la commande |
|
reference |
string |
Référence commerciale de la commande au format OYYMMDD_XXXXX à communiquer au service Delivery |
|
status |
string |
Statut de la commande |
|
type |
string |
Type de la commande (seule la valeur |
|
request_type |
string |
Type d'activation. Valeurs possibles: |
|
service_ref |
string |
Référence commerciale Covage du service: (à communiquer dans tous les échanges avec Covage).
|
|
service_uuid |
string |
Identifiant du service associé à la commande |
|
eligibility_ref |
string |
Identifiant de la demande d'éligibilité |
|
comment |
string |
Informations spécifiques convenues avec Covage pour activer le service |
|
submission_date |
ISO datetime |
Date de soumission de la commande |
|
acknowledged_date |
ISO datetime |
Date de prise en compte de la commande par Covage |
|
processing_date |
ISO datetime |
Date de démarrage du traitement effectif de la commande |
|
completion_date |
ISO datetime |
Date de passage de la commande en status |
|
cancellation_date |
ISO datetime |
Date de passage de la commande en status |
|
rejection_date |
ISO datetime |
Date de passage de la commande en status |
|
creation_date |
ISO datetime |
Date de création de la commande |
|
modification_date |
ISO datetime |
Date de dernière modification de la commande |
|
product |
object |
Informations sur le produit choisi. Défini le type de service, la technologie, le débit, les options possibles. |
|
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[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[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. Pour garantir le bon fonctionnement de la commande, tous les caractères utilisés pour ces champs doivent faire partie de cette liste (espace et espace insécable acceptés): ()+,-.0123456789:BCDEFGHIJKLMNO@APQRSTUVWXYZ[]_abcdefghijklmnopqrstuvwxyz{}~àâäçèéêëîïôöùûü |
|
end_customer[type] |
string |
Type de client final. Valeurs possibles: |
|
end_customer[name] |
string |
Nom du client final (entreprise). A renseigner si end_customer[type] est |
|
end_customer[first_name] |
string |
Prénom du client final. A renseigner si end_customer[type] est |
|
end_customer[last_name] |
string |
Nom de famille du client final. A renseigner si end_customer[type] est |
|
end_customer[siret] |
string |
Numéro SIRET de l'entreprise. A renseigner si end_customer[type] est |
|
end_customer[naf_code] |
string |
Code NAF de l'entreprise. Peut être renseigné si end_customer[type] est |
|
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[order_ref] |
string |
Référence de la commande dans votre système d'information |
|
operator_info[order_name] |
string |
Nom de la commande affichée sur l'extranet |
|
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 de l'extrémité |
|
bounds[address] |
string |
Adresse associée à l'extrémité. Pour garantir le bon fonctionnement de la commande, tous les caractères utilisés pour ces champs doivent faire partie de cette liste (espace et espace insécable acceptés): ()+,-.0123456789:BCDEFGHIJKLMNO@APQRSTUVWXYZ[]_abcdefghijklmnopqrstuvwxyz{}~àâäçèéêëîïôöùûü |
|
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 batiment |
|
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 à activer, dépend du produit commandé et du type de commande |
|
options[gtr] |
object |
Option GTR (avec valeur) |
|
options[patch_panel] |
object |
Option Patch Panel (booléenne) |
|
options[internal_cabling] |
object |
Option Internal Cabling (avec valeur) |
|
options[cpe_install] |
object |
Option Installation CPE (booléenne) |
|
options[installation_expert] |
object |
Option Installation Expert (avec valeur) |
|
options[guaranteed_bandwidth] |
object |
Option Débit Garanti (avec valeur) |
|
options[unlisted_number] |
object |
Option Numéro caché (booléenne) |
|
options[demarcation_device] |
object |
Option demarcation_device (booléenne) |
|
options[contract_term] |
object |
Option Durée de contrat (avec valeur) |
|
options[enni_redundancy] |
object |
Option Redondance ENNI (avec valeur) |
|
options[portability] |
object |
Option portabilité (champs spécifiques, voir ci-dessous) |
|
options[double_otp] |
object |
Option double PTO (booléenne). Commandes 'create' uniquement |
|
options[otp_displacement] |
object |
Option déplacement PTO (booléenne). Commandes 'activate' uniquement |
|
information |
object |
Le contenu de ce champs dépend de la famille de produit. |
Objet options :
Il existe 2 types génériques d'option : les options booléeen (activée ou non) et les options avec valeur (activée + valeur ou non).
Options booléennes :
enabled |
boolean |
true si l'option est activée, false par défaut |
Options avec valeur :
enabled |
boolean |
true si l'option est activée, false par défaut |
|
value |
string |
valeur de l'option si activée |
|
default_value |
string |
valeur par défaut de l'option |
Option Portability. Cette option contient des champs spécifiques
enabled |
boolean |
|
|
prefix_code |
string |
Remplir le prefix_code. |
|
rio_code |
string |
Remplir le rio_code. |
|
contract_ref |
string |
Champ en lecture seule. Automatiquement renseigné avec notre reference de contrat de portabilité. |
|
operator_code |
string |
Champ en lecture seule. Automatiquement renseigné avec notre code operateur. |
Champs information :
Pour les produits E-Access Fiber, information contient les champs suivant:
requested_provision_date |
ISO date |
Date de provision souhaitée |
|
end_user_premises_availability_date |
ISO date |
Date de disponibilité des locaux du client final. |
|
end_user_premises_phone_number |
string |
Numéro de téléphone des locaux du client final. |
|
end_user_premises_product_reference |
string |
Réference d'une service existante. |
|
ennis.0.uuid |
string |
uiid d'une service de type |
|
ennis.0.reference |
string |
Réference d'une service de type |
|
enni.0.vlan |
string |
Numéro de vlan |
Exemple:
{
"information": {
"requested_provision_date": "2018-07-30",
"end_user_premises_availability_date": "2018-07-30",
"end_user_premises_phone_number": "0123456789",
"end_user_premises_product_reference": "SERVICENUMBER",
"ennis": [
{
"uuid": "18c2d878-3281-4258-b201-7bdaac57f05f",
"reference": "S180228_10001",
"vlan": "200"
}
]
}
}
Création d'une commande¶
Lors de la création d’une nouvelle commande, son statut est mis à draft (on parle de draft order).
Cette facilité permet à l’opérateur de renseigner le draft order avec les premières informations disponibles et de le compléter par la suite. Une fois toutes les informations renseignées, il faudra soumettre la commande pour une exécution effective de la commande.
Pour le moment, seules les commandes d'activation fibre peuvent être créées via l'extranet.
La mise à jour de la référence de la PTO se fait sur un endpoint spécifique Mettre à jour la référence PTO d’une commande.
La mise à jour des informations stairs et floor se font sur un endpoint spécifique Mettre à jour l’adresse d’une commande.
Request URL /api/fiber-orders/
Paramètres d'entrées¶
type |
string |
O |
Type de la commande (seule la valeur |
request_type |
string |
F |
Type d'activation:
|
eligibility_ref |
string |
O |
Identifiant de la demande d'éligibilité |
comment |
string |
F |
Informations spécifiques convenues avec Covage pour activer le service |
product[code] |
string |
O |
Seul le code du produit est nécessaire, le reste du produit sera rempli automatiquement par la plateforme |
end_customer[type] |
string |
F |
Type de client final. Valeurs possibles: |
end_customer[name] |
string |
C |
Nom du client final (entreprise). A renseigner si end_customer[type] est |
end_customer[first_name] |
string |
C |
Prénom du client final. A renseigner si end_customer[type] est |
end_customer[last_name] |
string |
C |
Nom de famille du client final. A renseigner si end_customer[type] est |
end_customer[siret] |
string |
C |
Numéro SIRET de l'entreprise. A renseigner si end_customer[type] est |
end_customer[naf_code] |
string |
C |
Code NAF de l'entreprise. Peut être renseigné si end_customer[type] est |
end_customer.contact[first_name] |
string |
F |
Prénom du contact |
end_customer.contact[last_name] |
string |
F |
Nom de famille du contact |
end_customer.contact[email] |
string |
F |
E-mail du contact |
end_customer.contact[phone_number] |
string |
F |
Téléphone principal du contact |
end_customer.contact[cell_phone_number] |
string |
F |
Téléphone portable du contact |
operator_info[order_ref] |
string |
F |
Référence de la commande dans votre système d'information |
operator_info[order_name] |
string |
F |
Nom de la commande affichée sur l'extranet |
operator_info[contact_uuid] |
string |
F |
Référence du contact de l'opérateur à contacter concernant cette commande. |
options.gtr[enabled] |
boolean |
F |
Renseigner true si l'on désire l'option, false par défaut |
options.gtr[value] |
string |
C |
Valeur de la GTR choisie |
options.patch_panel[enabled] |
boolean |
F |
Renseigner true si l'on désire l'option, false par défaut |
options.internal_cabling[enabled] |
boolean |
F |
Renseigner true si l'on désire l'option, false par défaut |
options.internal_cabling[value] |
string |
C |
Valeur de la desserte interne choisie |
information.requested_provision_date |
ISO date |
C |
Renseigner pour les produits E-Access Fiber |
information[end_user_premises_availability_date] |
ISO date |
C |
Renseigner pour les produits E-Access Fiber |
information[end_user_premises_phone_number] |
string |
C |
Renseigner pour les produits E-Access Fiber si end_user_premises_product_reference est null |
information[end_user_premises_product_reference] |
string |
C |
Renseigner pour les produits E-Access Fiber si end_user_premises_phone_number est null |
information.ennis.0.reference |
string |
C |
Renseigner pour les produits E-Access Fiber |
information.ennis.0.vlan |
string |
C |
Renseigner pour les produits E-Access Fiber |
Exemple de requête¶
POST /api/fiber-orders/0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json
{
"eligibility_ref": "elig-ac1daf2f-5a44-4312-a168-1dbb5123a762",
"product": {
"code": "FP01"
},
"type": "activate"
}
Exemple de réponse¶
HTTP/1.1 200 OK
Content-Type: application/json
{
"uuid": "0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2",
"reference": "O180910_34001",
"status": "draft",
"type": "activate",
"eligibility_ref": "elig-ac1daf2f-5a44-4312-a168-1dbb5123a762",
"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": {},
"operator_info": {},
"bounds": [
{
"uuid": "b97a1002-4d6c-4eea-badd-ef2af30e67fb",
"endpoints": [
{
"uuid": "5861fb91-f434-4e9c-9ddf-9e36c606ea42"
}
],
"address": {
"kosc_street_code": "0105319900",
"kosc_insee_code": "01053",
"zipcode": "01000",
"street_name": "AVENUE JEAN MARIE VERNE",
"street_number": "2",
"city": "BOURG EN BRESSE",
"building_code": "IMB/01053/C/02GN"
},
"information": {
"co": "01053BPB"
}
}
],
"information": {},
"creation_date": "2018-09-10T10:16:47.387018Z",
"modification_date": "2018-09-10T10:16:47.387057Z"
}
Mettre à jour une commande¶
Permet de mettre à jour une commande.
Les paramètres d'entrées sont décrit plus haut Paramètres d'entrées
Request URL /api/fiber-orders/{uuid}/
Exemple de requête¶
PATCH /api/fiber-orders/0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json
{
"end_customer": {
"type": "unregistered",
"name": "ACME",
"contact": {
"first_name": "Firstname",
"last_name": "Lastname",
"email": "firstname.lastname@acme.fr",
"phone_number": "0123456789"
}
},
"operator_info": {
"order_ref": "ORDERREF0001",
"order_name": "Order name",
"contact_uuid": "7powrhlv"
},
"options": {
"gtr": {
"enabled": true,
"value": "d_plus_1"
}
}
}
Exemple de réponse¶
HTTP/1.1 200 OK
Content-Type: application/json
{
"uuid": "0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2",
"reference": "O180910_34001",
"status": "draft",
"type": "activate",
"request_type": "create",
"eligibility_ref": "elig-ac1daf2f-5a44-4312-a168-1dbb5123a762",
"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": "Firstname",
"last_name": "Lastname",
"phone_number": "0123456789",
"email": "firstname.lastname@acme.fr"
},
"type": "unregistered",
"name": "ACME"
},
"operator_info": {
"order_ref": "ORDERREF0001",
"order_name": "Order name",
"contact_uuid": "7powrhlv"
},
"bounds": [
{
"uuid": "b97a1002-4d6c-4eea-badd-ef2af30e67fb",
"endpoints": [
{
"uuid": "5861fb91-f434-4e9c-9ddf-9e36c606ea42"
}
],
"address": {
"kosc_street_code": "0105319900",
"kosc_insee_code": "01053",
"zipcode": "01000",
"street_name": "AVENUE JEAN MARIE VERNE",
"street_number": "2",
"city": "BOURG EN BRESSE",
"building_code": "IMB/01053/C/02GN",
"stairs": "_NA_",
"floor": "_NA_"
},
"information": {
"co": "01053BPB"
}
}
],
"options": {
"gtr": {
"enabled": true,
"value": "d_plus_1",
"default_value": "standard"
}
},
"information": {},
"creation_date": "2018-09-10T10:16:47.387018Z",
"modification_date": "2018-09-10T13:05:15.757253Z"
}
Mettre à jour la référence PTO d'une commande¶
Cet endpoint permet de renseigner la référence de sa PTO, à renseigner quand la valeur request_type est égale à activate_defined.
Il faut donc mettre à jour le champ request_type de la commande avant de pouvoir mettre à jour la référence de la PTO.
Lorsque l'on renseigne sa référence PTO, la plateforme va interroger un service externe afin de déterminer l'escalier (stairs) et l'étage (floor) associés à cette référence.
Il est fortement conseillé de vérifier que ces valeurs correspondent bien à l'adresse communiquée par le client pour éviter les erreurs.
Point d'attention: Lorsque l'on est sur un produit de la famille EAF, le format de la PTO est différent :
PTO FIBR :
^[A-Z0-9]{2}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}$(FI-1234-4234)PTO EAF :
^[A-Z0-9]{3}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}$(FIE-2523-4523)
Request URL /api/fiber-orders/{order_uuid}/endpoints/{endpoint_uuid}/
Exemple de requête¶
PATCH /api/fiber-orders/0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2/endpoints/5418ee25-cb93-4182-a76b-1d078fe30249/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json
{
"reference": "FI-3790-3415"
}
Exemple de réponse¶
HTTP/1.1 200 OK
Content-Type: application/json
{
"uuid": "4a83ee8c-769a-41a5-9c50-0441c58fb887",
"reference": "FI-3790-3415",
"type": "otp",
"bound_uuid": "2b45d2fc-4edd-49c6-8948-08f7303cf30c"
}
Mettre à jour l'adresse d'une commande¶
Cet endpoint permet de renseigner l'escalier et l'étage du client final, à renseigner quand la valeur request_type est égale à create ou activate_undefined.
Sinon ces deux valeurs seront remplies automatiquement par la plateforme.
Un nouveau endpoint est disponible pour récupérer les valeurs possibles sur l'immeuble (building_code) :
Exemple (building_code: IMB/91471/C/NU2C):
GET /api/v2/eligibility/buildings/IMB/91471/C/NU2C/?include_stairs=true HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json
{
"operator_code": "FI",
"operator_name": "ORANGE",
"name": "GARDIEN",
"building_ref": "IMB/91471/C/NU2C",
"type": "BUILDING",
"nro": "91122BUR",
"stairs": {
"1": [
"-1", "0", "1", "2", "3"
],
"2": [
"-1", "0", "1", "2", "3"
]
},
"address": {
"street_number": "34",
"street_name": "AVENUE SAINT LAURENT",
"kosc_street_code": "9147129100",
"kosc_insee_code": "91471",
"city": "ORSAY"
}
}
Exemple sans escalier et/ou étage (building_code: IMB/91691/C/00I2)
GET /api/v2/eligibility/buildings/IMB/91691/C/00I2/?include_stairs=true HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json
{
"operator_code": "FI",
"operator_name": "ORANGE",
"name": "",
"building_ref": "IMB/91691/C/00I2",
"type": "HOUSE",
"nro": "91114BRN",
"stairs": {
"_NA_": [
"_NA_"
]
},
"address": {
"street_number": "2",
"street_name": "RUE BERTHIER",
"kosc_street_code": "9169103000",
"kosc_insee_code": "91691",
"city": "YERRES"
}
}
Les valeurs escalier (stairs) et étage (floor) étant obligatoires, il faudra aussi renseigner _NA_ sur ces deux champs s'il s'agit des seules valeurs disponibles. Si et seulement si l'API building retourne "stairs": null, il est nécessaire d'envoyer l'escalier et l'étage connus ou _NA_ le cas échéant. Attention, une valeur incorrecte peut conduire à un rejet de commande.
Request URL /api/fiber-orders/{order_uuid}/bounds/{bound_uuid}
Exemple de requête¶
PATCH /api/fiber-orders/0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2/bounds/5418ee25-cb93-4182-a76b-1d078fe30249/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json
{
"address": {
"stairs": "_NA_",
"floor": "_NA_"
}
}
Exemple de réponse¶
HTTP/1.1 200 OK
Content-Type: application/json
{
"uuid": "b97a1002-4d6c-4eea-badd-ef2af30e67fb",
"endpoints": [
{
"uuid": "5861fb91-f434-4e9c-9ddf-9e36c606ea42"
}
],
"address": {
"kosc_street_code": "0105319900",
"kosc_insee_code": "01053",
"zipcode": "01000",
"street_name": "AVENUE JEAN MARIE VERNE",
"street_number": "2",
"city": "BOURG EN BRESSE",
"building_code": "IMB/01053/C/02GN",
"stairs": "_NA_",
"floor": "_NA_"
},
"information": {
"co": "01053BPB"
}
}
Soumettre une commande¶
Permet de soumettre la commande à Kosc.
Exemple de requête¶
PATCH /api/fiber-orders/0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json
{
"status": "submitted"
}
Exemple de réponse¶
HTTP/1.1 200 OK
Content-Type: application/json
{
"uuid": "0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2",
"reference": "O180910_34001",
"status": "submitted",
"type": "activate",
"request_type": "create",
"eligibility_ref": "elig-ac1daf2f-5a44-4312-a168-1dbb5123a762",
"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": "Firstname",
"last_name": "Lastname",
"phone_number": "0123456789",
"email": "firstname.lastname@acme.fr"
},
"type": "unregistered",
"name": "ACME"
},
"operator_info": {
"order_ref": "ORDERREF0001",
"order_name": "Order name",
"contact_uuid": "7powrhlv"
},
"bounds": [
{
"uuid": "b97a1002-4d6c-4eea-badd-ef2af30e67fb",
"endpoints": [
{
"uuid": "5861fb91-f434-4e9c-9ddf-9e36c606ea42"
}
],
"address": {
"kosc_street_code": "0105319900",
"kosc_insee_code": "01053",
"zipcode": "01000",
"street_name": "AVENUE JEAN MARIE VERNE",
"street_number": "2",
"city": "BOURG EN BRESSE",
"building_code": "IMB/01053/C/02GN",
"stairs": "_NA_",
"floor": "_NA_"
},
"information": {
"co": "01053BPB"
}
}
],
"options": {
"gtr": {
"enabled": true,
"value": "d_plus_1",
"default_value": "standard"
}
},
"information": {},
"creation_date": "2018-09-10T10:16:47.387018Z",
"modification_date": "2018-09-11T14:06:14.725364Z",
"submission_date": "2018-09-14T14:19:59.547681Z"
}
Lister les commandes¶
Permet de lister toutes les commandes.
Il est possible de filtrer sur plusieurs champs :
reference: Rechercher par référence de commande
status: rechercher par statut:
draft,acknowledged,in_progress,submitted,cancelled,rejected,completedtype: rechercher par type:
activate,terminateendpoint_ref: rechercher par référence d'endpoint
end_customer: rechercher par nom de client final
Request URL /api/fiber-orders/?
Exemple de requête¶
GET /api/fiber-orders/?status=submitted&type=activate&reference=O180905_41001 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": "0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2",
"reference": "O180905_41001",
"status": "submitted",
"type": "activate",
"request_type": "create",
"eligibility_ref": "elig-da2add61-6f4a-4de1-a08b-1558c4525ba2",
"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": "0123123234",
"email": "asd@asd.com"
},
"type": "unregistered",
"name": "asd"
},
"operator_info": {
"order_ref": "order ref",
"order_name": "order name",
"contact_uuid": "zitjrmff"
},
"bounds": [
{
"uuid": "22d3aff9-654d-457c-bc41-7dfa8b1b38d4",
"endpoints": [
{
"uuid": "f3870a26-ec08-4760-96ee-e99091427f15",
"type": "otp"
}
],
"address": {
"kosc_street_code": "6822462750",
"kosc_insee_code": "68224",
"zipcode": "68100",
"street_name": "AVENUE ROBERT SCHUMAN",
"street_number": "10",
"city": "MULHOUSE",
"building_code": "IMB/68224/C/0IEW",
"stairs": "_NA_",
"floor": "2"
},
"information": {
"co": "68271BDI"
}
}
],
"options": {
"gtr": {
"enabled": false,
"default_value": "standard"
}
},
"information": {},
"creation_date": "2018-09-05T17:03:21.717534Z",
"modification_date": "2018-09-05T17:15:02.214220Z",
"submission_date": "2018-09-05T17:15:02.220581Z"
}
]
Récupérer une commande¶
Permet de récupérer une commande avec son identifiant uuid.
Request URL /api/fiber-orders/{uuid}/
Exemple de requête¶
GET /api/fiber-orders/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": "0cd8d842-b0ca-43c0-8cbc-5d275cbdb1c2",
"reference": "O180905_41001",
"status": "submitted",
"type": "activate",
"request_type": "create",
"eligibility_ref": "elig-da2add61-6f4a-4de1-a08b-1558c4525ba2",
"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": "0123123234",
"email": "asd@asd.com"
},
"type": "unregistered",
"name": "asd"
},
"operator_info": {
"order_ref": "order ref",
"order_name": "order name",
"contact_uuid": "zitjrmff"
},
"bounds": [
{
"uuid": "22d3aff9-654d-457c-bc41-7dfa8b1b38d4",
"endpoints": [
{
"uuid": "f3870a26-ec08-4760-96ee-e99091427f15",
"type": "otp"
}
],
"address": {
"kosc_street_code": "6822462750",
"kosc_insee_code": "68224",
"zipcode": "68100",
"street_name": "AVENUE ROBERT SCHUMAN",
"street_number": "10",
"city": "MULHOUSE",
"building_code": "IMB/68224/C/0IEW",
"stairs": "_NA_",
"floor": "2"
},
"information": {
"co": "68271BDI"
}
}
],
"options": {
"gtr": {
"enabled": false,
"default_value": "standard"
}
},
"information": {},
"creation_date": "2018-09-05T17:03:21.717534Z",
"modification_date": "2018-09-05T17:15:02.214220Z",
"submission_date": "2018-09-05T17:15:02.220581Z"
}
Lister les contacts de l'opérateur¶
Voir la documentation Contacts.
Renseigner l'uuid du contact dans le champ operator_info.contact_uuid.
Les options disponibles¶
Les valeurs des options disponibles sont définis dans le catalogue produit.