Agents log / Activities

Resource type: agentslog

Writes a agents log or activity entry. A list of kind of actions and action types can be found in enterprise under “Extras >> Settings >> Administration >> Action types”. The german names are valid for the API.

Parameters:

  • datetime
    STRING. Date and time (Y-m-d H:i:s). If datetime is not set, the current date and time are written.
  • actionkind
    STRING. OPTIONAL. Kind of action (Aktionsart).
  • actiontype
    STRING. OPTIONAL. Action type (Aktionstyp).
  • origincontact
    STRING. OPTIONAL. Type of contact (Herkunft Kontakt). Values can be found in enterprise under “Extras >> Settings >> Administration >> Multiselect >> Module: address management” >> multiselectfield: type of contact” in the column “field”.
  • feature
    STRING. OPTIONAL. Feature (Merkmal). Values can be found in enterprise under “Extras >> Settings >> Administration >> Multiselect >> Module: Property Activities” >> multiselectfield: Feature” in the column “field”.
  • cost
    FLOAT. OPTIONAL. Costs
  • duration
    INTEGER . OPTIONAL. Duration. Specify the value in seconds.
  • advisorylevel
    STRING. OPTIONAL. Advisorylevel (Beratungsebene). Specify the values as A to G.
  • reasoncancellation
    STRING. OPTIONAL. Reason of cancellation (Absagegrund). Functions together with advisory level G = Cancellation. Values can be found in enterprise under “Extras >> Settings >> Administration >> Singleselect >> Module: Property Activities” >> key field: Reason of cancellation” in the column “content”.
  • note
    STRING. OPTIONAL. Note (Bemerkung).
  • addressids
    ARRAY. OPTIONAL if estateid is set. Linked address IDs: If there are multiple address IDs, a agents log entry is created for each of these addresses
  • estateid
    INTEGER. OPTIONAL, if addressids is set. Linked estate.
  • projectid
    INTEGER. OPTIONAL. Linked project.
  • taskid
    INTEGER. OPTIONAL. Linked task.
  • appointmentid
    INTEGER. OPTIONAL. Linked appointment.
  • fileids
    ARRAY. OPTIONAL. Linked files.
  • userid
    INTEGER. OPTIONAL. Support (Betreuer) of the entry. Id of linked user. If not set, the logged in user will be set as Support (Betreuer) of the entry.

Example: Agents log entry for a sent e-mail

...
    {
        "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:create",
        "resourceid": "",
        "identifier": "",
        "resourcetype": "agentslog",
        "parameters": {
            "datetime": "2021-02-08 11:13:30",
            "addressids": [
                34,
                35
            ],
            "estateid": 41,
            "actionkind": "Email",
            "actiontype": "Ausgang",
            "note": "Vertragsunterlagen versendet",
            "origincontact": "immobilienscout24_system",
            "feature": [
                "indMulti1832Select5686",
                "indMulti1832Select5690",
                "indMulti1836Select5692"
            ],
            "cost": 2.45,
            "duration": 3000,
            "advisorylevel": "B",
            "reasoncancellation": "Architektur"
        }
    }
...

If addressids and estateid is set, then also an entry in enterprise will be created under Addresses >> Property Search >> Tab “Offered till now” and Estates >> Prospective Buyers >> Tab “Offered till now”.

Example: Activity entry for a revocation confirmation

...
"actions":[
	{
		"actionid":"urn:onoffice-de-ns:smart:2.5:smartml:action:create",
		"resourceid":"",
		"identifier":"",
		"resourcetype":"agentslog",
		"parameters":{
			"addressids":[32],
			"actionkind":"Widerruf bestätigt",
			"actiontype":"Vorzeitiger Beginn",
			"note":"Widerruf bestätigt..."
		}
	}
]
...

Response:

  • id
    The ID of the new agents log or activity entry
...
"records": [
    {
        "id": 6065,
        "type": "agentsLog",
        "elements": [
        ]
    }
]
...