Resource type: addressHierarchyContacts
This call can be used to retrieve all relevant addresses of a contact hierarchy for a specified parent address. The returned list is based on the logic stored in the “receiverSelection ” (Empfänger-Auswahl) field of the specified address: If the options “Subordinate address(es)” (or “This and subordinate address(es)”) are selected, the main contact details of all subordinate addresses will automatically be contacted (additionally). This applies, among other things, to email and WhatsApp actions from the address list, from the address itself, from properties, the process manager, as well as appointments (appointment confirmation).
An address ID must be specified as resourceid.
Parameters: NONE
Request example
{
"actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
"resourceid": "691",
"identifier": "",
"resourcetype": "addressHierarchyContacts",
"parameters": []
}
Response:
id
INTEGER. The unique address ID.customerno
STRING. The customer number (KdNr).firstname
STRING. The first name of the contact.surname
STRING. The last name of the contact.company
STRING. The company name.primaryEmail- STRING. The primary email address of the contact.
Response example
{
"status": {
"code": 200,
"errorcode": 0,
"message": "OK"
},
"response": {
"results": [
{
"actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
"resourceid": "691",
"resourcetype": "addressHierarchyContacts",
"cacheable": false,
"identifier": "",
"data": {
"meta": {
"cntabsolute": null
},
"records": [
{
"id": 691,
"type": "address",
"elements": {
"id": 691,
"customerno": "599",
"firstname": "Geralinde",
"surname": "Mufflon",
"company": "",
"primaryEmail": "g.mufflon@my-onoffice.com"
}
}
]
},
"status": {
"errorcode": 0,
"message": "OK"
}
}
]
}
}