Baromètre FTTH

Description

Le serveur hébergant l'API est disponible à l'adresse

Les données de l'API sont disponibles sous licence ODbL

Les adresses indiquées en dessous acceptent aussi les requètes de type HEAD et OPTIONS

Options

Nom	Valeur	Description
format	api (défault) ou json	Définit le format de retour de réponse de l'API. format=json fera que l'API répondra du application/json format=api(default) répondra en text/html correspondant a l'interface web de l'API

Collections

GET/ftth-networks/Récupère tous les réseaux FTTH

Réseaux FTTH

Paramètres

Nom	Valeur	Description

Sortie

Cette ressource renvoie un tableau d'objets de type ftth-network

Code de retour

Cette ressource peut renvoyer les codes 200, 400, ou 500

GET/ftth-networks/<string:slug>/Récupère le réseau FTTH dont le slug correspond au "slug" passé dans l'url

Réseaux FTTH

Paramètres

Nom	Valeur	Description

Sortie

Cette ressource renvoie un objet de type ftth-network

Code de retour

Cette ressource peut renvoyer les codes 200, 400, 404 ou 500

GET/service-categories/Récupère toutes les catégories de service

Catégories de service

Sortie

Cette ressource renvoie un tableau d'objets de type service-catégorie

Code de retour

Cette ressource peut renvoyer les codes 200, 400, ou 500

GET/service-categories/<id:integer>/Récupère la catégories de service d'id "id"

Catégories de service par id

Paramètres

Nom	Valeur	Description

Sortie

Cette ressource renvoie un objets de type service-catégorie

Code de retour

Cette ressource peut renvoyer les codes 200, 400, 404 ou 500

GET/services/Récupère tous les services

Services

Sortie

Cette ressource renvoie un tableau d'objets de type service

Code de retour

Cette ressource peut renvoyer les codes 200, 400, ou 500

GET/services/<id:integer>/Récupère le service d'id "id"

Services par id

Sortie

Cette ressource renvoie un objet de type service

Code de retour

Cette ressource peut renvoyer les codes 200, 400, ou 500

GET/offers/Récupère toutes les offres

Offres

Sortie

Cette ressource renvoie un tableau d'objets de type offer

Code de retour

Cette ressource peut renvoyer les codes 200, 400, ou 500

Recherche et autocompletion

GET/ftth-networks/search/Récupère toutes les réseaux correspondant à la recherche

Réseaux FTTH

Sortie

Cette ressource renvoie un tableau d'objets de type ftth-network

Code de retour

Cette ressource peut renvoyer les codes 200, 400, 404 ou 500

GET/ftth-networks/autocomplete/Récupère toutes les réseaux correspondant disponible pour l'autocompletion

Réseaux FTTH

Sortie

Cette ressource renvoie un tableau d'objets de type ftth-network

Code de retour

Cette ressource peut renvoyer les codes 200, 400, 404 ou 500

Objets

ftth-network

    {
        "id": "integer(unique)",
        "name": "string",
        "slug": "string",
        "overview": "string:html",
        "website": "string:url",
        "geographical_areas": "array:geographical_area",
        "initiator_name": "string",
        "initiator_address": "string",
        "contract_type": "string:[DSP,PPP,CREM,other,unknown]",
        "contract_date": "string:ISO8601 date",
        "contract_duration": "int",
        "contract_detail": "string",
        "contractor_name": "string",
        "contractor_address": "string",
        "comments": "string:html",
        "parent_company": "string",
        "bitstream_offers": "string:[yes_certain,yes_maybe,unknown,no_certain,no_maybe]",
        "bitstream_comment": "string",
        "catalog_date": "string:ISO8601 date",
        "last_updated": "string:ISO8601 datetime",
        "rating": "string:[A,B,C,D,Z]",
        "urls": "array:object_url"
    }

geographical_area

    {
        "name": "string",
        "kind": "string",
        "code": "string"
    }

object_url

    {
        "name": "string",
        "url": "string:url"
    }

service-categorie

    {
        "id": "integer(unique)",
        "name": "string"
    }

service

    {
        "id": "integer(unique)",
        "name": "string",
        "order": "integer",
        "category": "integer:service-categorie.id",
        "network": "integer:ftth-network.id",
        "global_initial_cost": "float: 2 chiffres après la virgule",
        "global_recurring_cost": "float: 2 chiffres après la virgule",
        "individual_initial_cost": "float: 2 chiffres après la virgule",
        "individual_recurring_cost": "float: 2 chiffres après la virgule",
        "mbps_recurring_cost": "float: 2 chiffres après la virgule",
        "included_traffic": "float",
        "recurring_period": "integer",
        "commitment": "integer:>0 || null"
    }

offer

   {
        "id": "integer(unique)",
        "name": "string",
        "order": "integer,
        "comment": "string",
        "network": "integer:network.id",
        "services": "array:service.id"
    }