Publication de tables de référence

Cette route permet de publier des tables de référence PHyC.

Paramètres HTTP

Paramètre

Valeur

Route

tables

Méthode

POST

Paramètres

Les paramètres doivent être transmis dans le contenu de la requête au format format JSON.

Nom

Description

Type

O/F

cdtables

liste des codes de table

list(str)

F

contenu

publication du contenu

bool

F

dtmaj

date de mise à jour

datetime

F

contenu

Si le paramètre contenu n’est pas défini ou qu’il prend comme valeur “false”, le contenu des tables n’est pas retourné.

Droit de publication

Les données publiées par ce service web sont publiques hormis la table des codes BNBV. N’importe quel utilisateur peut avoir accès aux données que le service web produit, et ça que l’utilisateur soit authentifié ou non.

Pour publier la table des codes BNBV, il faut être authentifié et avoir le profil institutionnel.

Retour du web-service

Le web-service retourne une liste d’objet Table au format json.

Table

Propriétés de l’objet Table:

  • CdTable

  • LbTable

  • NomTable

  • DtMajTable

  • NbEnrTable

  • Lignes : une liste d’objets Ligne non vide si contenu = true

Ligne

Une ligne correspond à un enregistrement de base de données. Sa structure dépend des colonnes de la table.

Exemple (table des articles)

table de référence au format json
[
  {
    "CdTable": 1,
    "LbTable": "Table des articles",
    "NomTable": "nom",
    "DtMajTable": "2020-01-01T00:00:00",
    "NbEnrTable": 6,
    "Lignes":[
      {
        "karticle":"1",
        "article1": null,
        "article2": "à"
      }, {
        "karticle": 2,
        "article1":"Le",
        "article2":"au"
      },{
        "karticle":"3",
        "article1":"Les",
        "article2":"aux"
      }
    ]
  }
]