Relations

Resource type: appointments

With this API call you can delete a relation. The parent ID and the child ID of the relation to be deleted have to be specified as parameters. See here for more information on relations and which kind of relations exist.

Parameters:

  • parentid
    INTEGER. parent ID (e.g. address ID, estate ID, appointment ID)
  • childid
    INTEGER. child ID e.g. address ID, estate ID, appointment ID)
  • relationtype
    STRING. Description of the link. Important relation types in enterprise:

    • 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:interested' An estate is assigned to the address of an interested party.
    • 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:estateUnit' A base object is assigned estate units.
    • 'urn:onoffice-de-ns:smart:2.5:relationTypes:calendar:address' An appointment is linked to an address.
    • 'urn:onoffice-de-ns:smart:2.5:relationTypes:calendar:estate' An appointment is linked to an estate.
    • 'urn:onoffice-de-ns:smart:2.5:relationTypes:agentsLog:file:attachment' An agents log entry is assigned a file attachment.
    • 'urn:onoffice-de-ns:smart:2.5:relationTypes:agentsLog:address' An agents log entry is assigned an address.
    • 'urn:onoffice-de-ns:smart:2.5:relationTypes:agentsLog:estate' An agents log entry is assigned an object.
    • Buyer: 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:buyer'
    • Tenant: 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:renter'
    • Owner: 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:owner'
    • Contact person(only brokers): 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:contactPerson'
    • All contact persons: 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:contactPersonAll'

Example: Delete a relation / unlink an address from an appointment

...
{
    "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:delete",
    "resourceid": "",
    "identifier": "",
    "resourcetype": "relation",
    "parameters": {
        "relationtype": "urn:onoffice-de-ns:smart:2.5:relationTypes:calendar:address",
        "parentid": 671,
        "childid": 153
    }
}
...

If successful, the response is success.