fonciqAPI
Tâches

Lire les lignes d'un index

Portée `jobs:read`. Lecture directe des lignes conservées pour cet index. Même objet qu'une tâche terminée : `parse`, `unparsed_retained` et `entries`. JSON par défaut. `format=csv` ou `Accept: text/csv` renvoie le CSV. `format` l'emporte. Toute autre valeur reçoit `400` et le code `invalid_request`. `404` lorsque le document n'est pas un index produit pour l'organisation. Le PDF de cet index reste la source, même si `entries` est vide. `parse.confidence` et la confiance de chaque ligne valent `unscored`. `needs_review` est nul sur une ligne structurée. `unparsed_retained` vaut `false` et `unparsed` est omis. Aucune ligne n'est inventée. Un tirage sans PDF n'a pas de lignes.

GET
/v1/documents/{id}/entries

Autorisation

AuthorizationBearer <token>

Clé d'API de l'organisation. Le secret n'est montré qu'une fois. Le préfixe affichable d'une clé d'essai est fq_test_. Le hachage SHA-256 est la seule forme conservée. Le panneau d'essai de cette documentation n'envoie qu'une clé fq_test_ et n'effectue aucun débit.

Dans : en-tête

Paramètres de chemin

idstring

Paramètres de requête

format?string

json est le défaut. csv, ou l'en-tête Accept: text/csv lorsque format est absent, sélectionne le CSV. format l'emporte lorsque les deux sont envoyés. Toute autre valeur reçoit 400 et le code invalid_request.

Défaut"json"
Valeurs"json" | "csv"

Corps de la réponse

application/json

application/json

application/json

application/json

curl -X GET "https://api.fonciq.ca/v1/documents/string/entries"
{
  "lot": "string",
  "source_document_id": "string",
  "pdf_url": "http://example.com",
  "entries_url": "http://example.com",
  "parse": {
    "confidence": "unscored"
  },
  "unparsed_retained": true,
  "unparsed": [
    {
      "position": 0,
      "raw_text": "string",
      "page": 0,
      "needs_review": true,
      "reason": "no_acte_link"
    }
  ],
  "pages": [
    {
      "page": 0,
      "status": "parsed",
      "needs_review": true
    }
  ],
  "entries": [
    {
      "lot": "string",
      "source_document_id": "string",
      "position": 0,
      "inscription": "string",
      "presentation_date": "2019-08-24",
      "nature": "string",
      "parties": [
        {
          "role": "string",
          "name": "string"
        }
      ],
      "remarks": "string",
      "radiations": [
        {
          "inscription": "string",
          "mention": "string",
          "raw_text": "string"
        }
      ],
      "seqnt_prodt": "string",
      "portal_href": "string",
      "raw_text": "string",
      "read_method": "text_layer",
      "confidence": "unscored",
      "needs_review": true
    }
  ]
}
{
  "error": {
    "code": "invalid_request",
    "message": "Indiquer une adresse ou un matricule.",
    "request_id": "req_01HZX"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Clé d'API refusée.",
    "request_id": "req_01HZX"
  }
}
{
  "error": {
    "code": "account_not_found",
    "message": "Ce compte du Registre n'appartient pas à l'organisation.",
    "request_id": "req_01HZX"
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Trop de requêtes pour cette clé.",
    "request_id": "req_01HZX"
  }
}

Lire le PDF d'un document GET

Portée `jobs:read`. Renvoie le PDF d'un index ou d'un acte produit pour l'organisation. Le corps est `application/pdf`. Pour un index, ce PDF est toujours renvoyé et il fait foi, que des lignes aient été lues ou non. Une liste de lignes vide ne le remplace pas. Les lignes se lisent sur `GET /v1/documents/{id}/entries`, sur la tâche et sur la fiche.

Lire une tâche GET

Portée `jobs:read`. État, documents, résultat et capacité du jour de chaque compte touché. Il n'existe pas de route séparée pour la capacité : elle est portée par cette réponse. Tant que l'index n'est pas analysé, `result` est nul. Une tâche terminée d'un seul lot porte `result.index`. Un lot groupé porte `result.indexes`, un bloc par lot. Chaque bloc contient le PDF (`pdf_url`), l'adresse des lignes (`entries_url`) et `entries`. Le CSV est `GET /v1/jobs/{id}/results`. Pour un compte, `cap` vaut 540 index par jour (heure de Toronto). `on_demand_reserve` vaut 180. Les surveillances ne peuvent pas prendre cette réserve. `watch_budget_remaining` vaut min(360 − index de surveillance utilisés ce jour-là, 540 − index utilisés ce jour-là) pour ce compte. `used_today` compte les index réellement envoyés au Registre sur ce compte, appels à la demande et surveillances confondus.