Description des champs des opérations

Champs
Description
Exemple
reference
required
La référence de l'opération, pour le compte émettant la requête
chauffage-394
description
La description (commentaire) de l'évènement
"Le locataire se plaint d'une panne de chauffage dans son bureau"

"Remise en service du ballon d'eau chaude. Les tuyaux étaient bouchés"
contractReference
required
Le contrat auquel est liée l'opération. Permet notamment de préciser à quel couple (gestionnaire, prestataire) la demande doit être partagée
multi_2019_FR
status
required
L'état d'avancement de l'opération
open
event
required
L'évènement actuel de l'opération
planned
eventDate
required
La date de l'étape (par ex, la date d'ouverture du ticket d'intervention ou, si c'est une planification, la date de planification.)
2016-10-14T14:00:00.000Z
logDate
required
La date à laquelle le client a enregistré l’évènement en interne
2019-01-14T21:00:00.000Z
serviceCode
required
Le code de la prestation réalisée pendant l'intervention
heater_curative
location
required
Lieu de la prestation
via assetReference ou address
assetReference
La référence de l'élément de patrimoine concerné par l'opération
chaudiere-3992
address
Adresse de l'élément concerné par l'intervention
address/way
La rue de l'élément de patrimoine concerné par l'intervention
5 Rue du bonheur
address/city
La ville de l'élément de patrimoine concerné par l'intervention
LILLE
address/zip
Code postal
59000
address/country
Le pays de l'intervention
France
address/complement
Complément d'information sur la localisation du patrimoine concerné par l'intervention
Hall B
geo
Coordonnées géographiques de l'élément concerné par l'intervention
geo/longitude
Degré de longitude du patrimoine concerné par l'intervention
3.057256
geo/latitude
Degré de latitude du patrimoine concerné par l'intervention
50.62925
parentReference
La référence de l'opération liée à l'opération, par exemple la référence du devis liée à l'intervention, ou la référence de l'intervention liée à la réserve.
DEV_9872
workType
required
Le type de prestation demandée. Parmi :
preventive: maintien préventif, pour prévenir les pannes = visites d'entretien, visites de sécurité, audit ...
operational: maintien de l'appareil en condition d'utilisation, entretien, nettoyage ...
corrective: maintien curatif, dépannages, réparations ...
adaptive: maintien pour que l'appareil soit adapté à son environnement, réglages, ...
setup: mise en marche / arrêt
renovation: travaux de rénovation
energetic_coaching: coaching énergétique des occupants d'un logement
diagnosis: diagnostic immobilier (amiante, élec, plomb, gaz, DPE, etc.)
regulatory: intervention réglementaire effectuée par un bureau de contrôle
work_order: bon de commande
none: aucun
preventive
contacts
Les informations d'un contact lié à l'opération
Au format vCard
technicalReason
La raison technique, après diagnostic post intervention (status=closed). Parmi :

vandalism: vandalisme
power_failure: panne électrique
false_alert: fausse alerte
abnormal_use: usage anormal
external_reason: cause extérieure (inondation...)
time_worn: matériel âgé
other_pm: autre cause imputable au client
technical_failure: panne technique
* other_sp: autre cause imputable au prestataire
vandalism
origin
L'origine de la demande. Parmi:
pm: si c'est le gestionnaire de patrimoine qui a exprimé le besoin
sp: si c'est le prestataire de services
* other: autre
pm
documentUrls
l'url du document
equipmentWorkingOrder
L'état de fonctionnement (oui/non) de l'équipement.
Parmi :
operational: fonctionne
not_operational: ne fonctionne pas
not_operational
equipmentStatus
Le statut plus précis de l'équipement, et les actions associées, après l'intervention (status=closed). Parmi :

new: remplacé à neuf
ok: état correct
bad_condition: mauvais état
to_be_replaced: à remplacer
* warning: alerte
ok
visitAttempt
Le nombre de tentatives de passage, si une intervention a donné lieu à plusieurs tentatives infructueuses
4
replacingEquipment
La référence de l'équipement de remplacement, si nécessaire
chaudiere-4829
warning
Si une alerte est émise
true
warningComment
La description de l'alerte émise
la machine n'est pas réparable
occupantSignature
Si l'occupant a validé et signé l'intervention. Parmi :

ok: oui
occupant_denial: refus de l'occupant
* na: non applicable
ok
orderDocReference
La référence d'un document complémentaire
doc-230
dischargeDocReference
La référence de quitus du locataire ou du gestionnaire
doc-2139
additionalOrder
Si une commande complémentaire a été effectuée
true
additionalOrderComment
Le commentaire sur la commande complémentaire
"il y a besoin de commander une nouvelle chaudière"
fileKey
La clé identifiant le fichier utilisé pour importer les logs, lorsque ce mode de transmission est utilisé
file-dj4h
criticalLevel
Le niveau de criticité de la demande.
-1 = NULL (non renseigné)
0 = non urgent, non critique
1 = urgent (faible), très bas
2 = urgent (fort), bas
3 = stratégique, moyen
4 = prioritaire (faible), haut
5 = prioritaire (fort), très haut
4
reminderLevel
Le niveau de relance de la demande. De 1 à 5
3
reminderComment
Commentaire sur la relance
l'hiver arrive, il est nécessaire de réparer cette chaudière
suggestedProvisionalDate
La date limite souhaitée de réalisation de la prestation demandée
2016-10-21T12:00:00Z
suggestedTimeSlot
Les périodes durant lesquelles le travail devrait être effectué
De préférence le matin
tags/NouveauTagPerso
Tag pour créer un champ de votre choix
"Satisfaction":"5 étoiles"
Ajouter les champs de votre choix

Pour créer un nouveau champ, il suffit de rajouter des tags avec un couple clé/valeur. Dans le body de la requête, ajouter :
"tags": {
"NouveauTagPerso":"valeur1",
"TagDeMonChoix":"valeur2"
}
Champ Location

Si vous renseignez le champ assetReference, il n'est pas nécessaire d'indiquer les champs address. Le lien avec l'assetReference permettra d'avoir l'adresse, la ville, le code postal et la géolocalisation de l'élément.