Relations

Resource type:idsfromrelation

For reading out the IDs of certain links, such as buyer, tenant, owner.

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, brokers are childIds)

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