Ressources

Déclarations

Chaque point de terminaison Déclarations, avec la portée qu'il impose, le corps qu'il accepte, une réponse lisible et les refus qu'il peut renvoyer.

Lire l’état de l’affichage environnemental français.

get/organizations/{organization}/passports/{id}/affichage

Portée: passports:read
Idempotency-Key: Non accepté
Renvoie: 200

Paramètres de chemin

organizationstringObligatoire

L'organisation pour laquelle cette requête agit. La clé doit disposer d'une autorisation sur celle-ci.

idstringObligatoire

L'identifiant de la ressource. Traitez-le comme une chaîne opaque.

Erreurs

Tous les refus que ce point de terminaison peut renvoyer, avec le statut qui les accompagne.

Requête

curl "https://passportcraft.com/api/v1/organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/2c1f9e07-3b4d-4a18-9f6c-5e0a7b8d3c41/affichage" \
  -H "Authorization: Bearer $PASSPORTCRAFT_API_KEY"

Réponse · 200

{
  "object": "affichage",
  "name": "organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/2c1f9e07-3b4d-4a18-9f6c-5e0a7b8d3c41/affichage",
  "organization_id": "8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2",
  "passport_id": "2c1f9e07-3b4d-4a18-9f6c-5e0a7b8d3c41",
  "livemode": true,
  "status": "not_filed",
  "filed_at": null,
  "portal_gtin": null,
  "portal_score": null,
  "filing_available": false,
  "blockers": [
    "delegation_required"
  ],
  "delegation_status": "pending"
}

GET /organizations/8f14e45f-ceea-467a-9a5f-8dc7d9c6a1b2/passports/2c1f9e07-3b4d-4a18-9f6c-5e0a7b8d3c41/affichage

Déposer la déclaration d’affichage environnemental français.

post/organizations/{organization}/passports/{id}/affichage

Portée: filings:write
Idempotency-Key: Accepté
Renvoie: 200