GET /eco/immo/offres/statuts

A propos

Cette requête permet de lister le statut des offres créées via l'API.
La liste retournée contient, par ordre décroissant, la référence unique de chaque offre ainsi que son statut :

  • En cours de validation
  • Publiée
  • Archivée

Consultez la description du modèle pour plus d'informations.

Limitations

En JSON, la liste des offres est paginée 50 par 50.

Informations

URL https://api.solutions-territoire.fr/eco/immo/offres/statuts
Disponibilité 0.7.0
Authentification requise Authorization Code ou Client Credentials
Scope requis Accés aux données économiques
Formats disponibles JSON
Code HTTP attendu 200

Paramètres

page Integer optionnel Numéro de la page de résultat

Réponse

total Integer Nombre de résultats trouvés (toutes pages confondues)
page Integer Numéro de la page selectionnée
offres Array Un tableau des offres immobilières par référence et par statut

Exemples

Les exemples ci-dessous utilises la variable $ACCESS_TOKEN décrite dans la section Exemple : authentification en ligne de commande.

Exemple de requête listant les 50 derniers statuts :

cURL :

curl -X GET \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://api.solutions-territoire.fr/eco/immo/offres/statuts

HTTPie :

http -v GET https://api.solutions-territoire.fr/eco/immo/offres/statuts \
  Accept:"application/json" \
  Authorization:"Bearer $ACCESS_TOKEN"

Résultat :

GET /eco/immo/offres/statuts HTTP/1.1
Accept: application/json
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "total":   142,
    "page":    1,
    "offres":  [
        { "reference": "2019-10-00005", "status": "pending_validation" },
        { "reference": "2019-10-00002", "status": "pending_validation" },
        { "reference": "2019-10-00001", "status": "active" },
        { "reference": "2019-09-00067", "status": "active" },
        { "reference": "2019-09-00066", "status": "archived" },
        { "reference": "2019-09-00065", "status": "active" },
        [...]
    ]
}