API - Consulter et modifier des actifs


Rappel des bases URL
Environnement sandbox :

Environnement de production :


Consulter le patrimoine bâti qui m'est partagé


Je suis prestataire de service et je souhaite consulter le patrimoine que mon client m'a partagé via le contrat 4536 qui a démarré au 1/1/2018.

Utilisation de paramètres

Pour l'utilisation de cette requête GET assets/, l'utilisation de paramètre est obligatoire. Vous êtes à minima obligé d'utiliser soit since ou from/to.
La liste d'asset retourné est limité à 1 an.


Requête


URL
{url_de_base}/api/assets/v1/assets?since=2018-01-01&contractReference=4536"
verbe HTTP
GET


Réponse

Le système renvoie HTTP 200 OK si les modifications ont correctement été prises en compte.
Vous retrouverez le listing des assets dans le body de la réponse.

Pour aller plus loin

Pour plus d'exemples sur consultation d'éléments de patrimoine et notamment l'utilisation des paramètres, veuillez-vous référer à l' API Reference  Assets v1.0


Mettre à jour un équipement


Je souhaite, sur mon équipement VMC_EURATECH_12:
  • modifier le titre de mon équipement : label
  • ajouter un lien d'installation pour indiquer où est situé mon équipement : installationReference
  • supprimer un lien d'usage de mon équipement : usageLinksReferences
  • ajouter un lien d'usage pour indiquer le bâtiment impacté par mon équipement : usageLinksReferences


Requête

URL
{url_de_base}/api/assets/v1/assets/VMC_EURATECH_12
verbe HTTP
PATCH

Body de la requête

{
    "label": "VMC Euratech bât 12",
    "installationReference": "RES-EURATECH",
    "usageLinksReferences": [
      {
        "operation": "remove",
        "value": "RES-A-Euratechnologies"
      },
      {
        "operation": "add",
        "value": "RES-12-Euratech"
      },
    ]
  }


Réponse


Le système renvoie HTTP 200 OK si les modifications ont correctement été prises en compte.
Pour aller plus loin

Pour plus d'exemples sur la mise à jour d'élément de patrimoine bâti et équipement, veuillez-vous référer à l' API Reference  Assets v1.0


Ajouter un contact (locataire, gardien, responsable, etc) au format Vcard


Pour ajouter un contact à un asset, il faut renseigner le champ intent_contacts, soit au format texte ou Vcard

Requête

URL
{url_de_base}/api/assets/v1/assets/app_temoin
verbe HTTP
PATCH

Body de la requête

{
    "tags": [
      {
        "operation": "add",
        "name": "intent_contacts",
        "value": "BEGIN:VCARD\r\nVERSION:3\r\nFN;CHARSET=UTF-8:Pierre DUPONT\r\nN;CHARSET=UTF-8:DUPONT ;Pierre\r\nTEL;TYPE=WORK,VOICE:0734220902\r\nTEL;TYPE=HOME,VOICE:0685874445\r\nADR;TYPE=WORK:165 Avenue de Bretagne;59000;LILLE;France\r\nROLE;CHARSET=UTF-8:Gardien\r\nEMAIL;CHARSET=UTF-8;TYPE=WORK,INTERNET:p.dupont@intent.fr\r\nEND:VCARD\r\n"
      }
    ]
}


Réponse


Le système renvoie HTTP 200 OK si la Vcard a été correctement ajouté à l'asset.


Ajout d'un contact locataire au format texte

Requête

URL
https://apisandbox.hubintent.com/api/assets/v1/assets/app_temoin
verbe HTTP
PATCH

Body de la requête

{
    "tags": [
      {
        "operation": "add",
        "name": "intent_contacts",
        "value": "Gardien : Pierre DUPONT - Pro : 0734220902 / p.dupont@internet.fr"
      }
    ]
}

Réponse


Le système renvoie HTTP 200 OK si le contact a été correctement ajouté à l'asset.