Relations

Resource type:idsfromrelation

For reading out the parent and child IDs of relations, such as buyer, tenant, owner.

The relation types are all constructed after the same scheme:
In urn:onoffice-en-ns:smart:2.5:relationTypes:estate:address:renter “estate” is the parent id, “address” is the child id and “renter” tells, which estate / address-relation is involved.

Parameters:

  • parentids
    An array of IDs to look for linked IDs on the other side (child IDs). If parentids are specified, the parameter childIds (which is being sought) must not be set
  • childids
    Similar to the parameter parentIds. (If childIds is specified, the parentids are returned)
  • relationtype
    Specification of the relation, e.g. buyer, tenant, etc … Possible relations:

    • Buyer: 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:buyer'
        (estates are parentIds, buyers are childIds)
    • Tenant: 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:renter'
        (estates are parentIds, tenants are childIds)
    • Owner: 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:owner'
        (estates are parentIds, owners are childIds)
    • Prospective buyer: 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:interested'
        (estates are parentIds, prospective buyers are childIds)
    • Contact person (brokers only): 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:contactPerson'
        (estates are parentIds, brokers are childIds)
    • All contact persons: 'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:contactPersonAll'
        (estates are parentIds, addresses are childIds)

Other important relation types are for example:

'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:estateUnit' A base object is assigned an 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 to 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.

'urn:onoffice-de-ns:smart:2.5:relationTypes:address:process' Process to address (address = parent record, process = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:resubmission' Resubmission of Address (address = parent record, resubmission = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:customer' Address is linked to customer (address = parent record, customer = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:buyer' Buyer of estate (estate = parent record, address = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:renter' Renter of estate (estate = parent record, address = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:owner' Owner of estate (estate = parent record, address = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:user:officer' Officer (Betreuer) of estate (estate = parent record, user = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:tenant' Tenant of estate (estate = parent, address = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:contactPerson' Contact person of estate (Makler) (estate = parent, address = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:contactPersonAll' All contact persons of estate (estate = parent, address = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:interested' All interested persons of estate (estate = parent, address = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:allFiles' All files of an estate (estate = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:file:titelbild' Titelbild (estate = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:file:grundriss' Grundriss (estate = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:file:foto' Grundriss (estate = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:file:allpictures' All pictures of an estate (estate = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:file:alllinks' All links of an estate (estate = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:file:allpicturesExceptTitelbild' All pictures of an estate (estate = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:matching' estate/address matching (estate = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estateTracking:estate' estateTracking/estate (estateTracking = parent, estate = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:estateUnit' estate/estate_unit (estate = parent, estate_unit = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:address:isTippgeberOf' Referenceprovider-ID (Tipp-ID) of address (address = parent record, address = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:estate:tipp' Referenceprovider (Tippgeber) of estate (address = parent, estate = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:user:officer' Officer (Betreuer) of address (address = parent record, user = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:user:additionalOfficers' Additional officers (Zusatzbetreuer) of address (address = parent record, user = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:file:attachment' Estate/file relation (estate = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:templateManagement:email:attachment' Template/file matching (email = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:templateManagement:email:documentAttributes' Template/schluessel2 matching (email = parent, schluessel2 = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:searchcriteria' searchcriteria for address (adress = parent record, searchcriteria = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:estate:offer' Offer (Angebot) (adress = parent record, estate = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:estate:contacted' Contacted (Adressen) (adress = parent record, estate = child record)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:estate:offerByAgentsLog' Offer (Angebot) by table “maklerbuch” (address = parent, estate = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:user:strangeNameRelation' user for address, related by “Name” and “Vorname” (address = parent, user = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:estate:matching' immo-matching entry (address = parent, estate = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:customer:address:contact' contact for customer (customer = parent, address = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:project:task:customer' project-task relation in customerDb (project = parent, task = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:project:agentslog' project-agentslog relation (project = parent, agentslog = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:project:calendar' project-calendar relation (project = parent, calendar = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:project:address' project-address relation (project = parent, address = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:project:estate' project-estate relation (project = parent, estate = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:complex:estate:units' Units of complex (Immobilienanlage) (complex = parent, estate = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:task:address' task-address (task = parent, address = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:task:estate' task-estate (task = parent, estate = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:task:file:attachment' task-attachments (task = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:calendar:file:attachment' calendar-attachments (calendar = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:calendar:address' calendar-address (calendar = parent, address = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:calendar:estate' calendar-estate (calendar = parent, estate = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:project:file:attachment' project-attachments (project = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:agentsLog:file:attachment' agents-log-attachments (agents log = parent, file = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:agentsLog:address' agents-log-address (agents log = parent, address = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:agentsLogMail:address' agents-log-address (agents log = parent, address = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:agentsLog:estate' agents-log-estate (agents log = parent, estate = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:agentsLogMail:estate' agents-log-estate (agents log = parent, estate = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:user:assignment' estate-user-assignments (estate = parent, user = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:user:address:birthday' user-address-birthday (user = parent, address = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:user:address' user-address-birthday (user = parent, address = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:mail' address-mail (address= parent, mail = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:estate:mail' estate-mail (estate= parent, mail = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:billing:estate' billing-estate (billing= parent, estate = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:job:estate' job-estate (job = parent, estate = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:agentsLog:attachment:download' agentsLog-attachments-download (agentsLogId = parent, attachmentid = child)
'urn:onoffice-de-ns:smart:2.5:relationTypes:address:contact:address' Sets main and 2nd level contacts on the relations tab for addresses. Parent is main contact, child is 2nd level contact.

Example:

...
"actions":[ 
{
	"actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
	"resourceid": "",
	"identifier": "",
	"resourcetype": "idsfromrelation",
	"parameters":
	{
		"relationtype" :"urn:onoffice-de-ns:smart:2.5:relationTypes:estate:address:contactPersonAll",
		"parentids" :[48]
	}
}
]
...

Response

  • relatedIds
    The searched IDs

For more information on the relations of the multi-property module, which manages property complexes, see here.