POST /eco/immo/offres

A propos

Cette requête permet la création d'offres immobilières.
Les offres immobilières ainsi créées doivent être validées et publiées par un utilisateur de l'Atelier Economique.

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

Informations

URL https://api.solutions-territoire.fr/eco/immo/offres
Disponibilité 0.7.0
Authentification requise Authorization Code ou Client Credentials
Scope requis Création d'offres immobilières
Formats disponibles JSON
Code HTTP attendu 202

Paramètres

offre Object requis Un objet contenant les propriétés attendues pour de la création d'une offre immobilière

Réponse

offre Object En cas de succés (status 202) La référence et le statut de l'offre créée
errors Object En cas d'échec (status 422) Les erreurs de validation du modèle

Exemple

Les exemples ci-dessous utilises la variable $ACCESS_TOKEN décrite dans la section Exemple : authentification en ligne de commande, ainsi qu'un fichier JSON contenant le corps de la requête.

Exemple de requête de création :

cat exemple.json
{
  "offre": {
    "local_type":                       "bureaux",
    "transaction_types":                ["acheter"],
    "surface":                          900,
    "label":                            "Bureaux de 900m2",
    "number":                           "2",
    "voie":                             "RUE DE L'EGLISE",
    "code_commune":                     "61167",
    "tags":                             ["PMR (Personne à Mobilité Réduite)", "Vitrine", "Quai de chargement"],
    "disponibilite":                    "30-09-2022",
    "descriptif_bien":                  "Au sein d'une pépinière d'entreprises,\rOpen-space privatif, très spacieux et équipé de la fibre.",
    "descriptif_surface":               "Plateau de 800 m2, 3 salles de réunion de 20m2",
    "descriptif_caracteristique":      "Cuisine équipée et portes-fenêtres verrouillables.",
    "acces":                            "Locaux accessibles 24h/24, 7j/7.\rA 10 minutes à pied du métro.",
    "descriptif_tarif":                 "D'autres services sont négociables.",
    "prix_de_vente":                    900000,
    "charges_mensuelles_copropriete":   150.75
  }
}

cURL :

curl -X POST \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d @exemple.json \
  https://api.solutions-territoire.fr/eco/immo/offres

HTTPie :

http -jv POST https://api.solutions-territoire.fr/eco/immo/offres < exemple.json \
  Accept:"application/json" \
  Authorization:"Bearer $ACCESS_TOKEN"

Exemple de réponse avec succés :

POST /v0/eco/immo/offres/post%2Feco%2Fimmo%2Foffres HTTP/1.1
Accept: application/json
Authorization: Bearer $ACCESS_TOKEN
Content-Type: application/json; charset=utf-8

HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8

{
    "offre": {
        "reference": "2021-10-00014",
        "status":    "pending_validation"
    }
}

Exemple de réponse avec erreurs de validation :

POST /v0/eco/immo/offres/post%2Feco%2Fimmo%2Foffres HTTP/1.1
Accept: application/json
Authorization: Bearer $ACCESS_TOKEN
Content-Type: application/json; charset=utf-8

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json; charset=utf-8

{
    "errors": {
        "local_type": [
            { "error": "blank" }
        ],
        "transaction_types": [
            { "error": "inclusion", "value": ["achaata"]
        ]
        "prix_de_vente": [
            { "error": "not_a_number" }
        ],
        "contact_offers.contact.last_name": [
            { "error": "blank" }
        ]
    }
}