Agents log / Activities

Resource type: agentslog

Writes a agents log or activity entry.

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
  • actiontype
    STRING. OPTIONAL. Action type
  • note
    STRING. OPTIONAL. Note
  • 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

...
"actions":[
	{
		"actionid":"urn:onoffice-de-ns:smart:2.5:smartml:action:create",
		"resourceid":"",
		"identifier":"",
		"resourcetype":"agentslog",
		"parameters":{
			"datetime":"2017-01-31 12:23:30",
			"addressids":[177],
			"estateid":83,
			"actionkind":"Email",
			"actiontype":"Ausgang",
			"note":"Vertragsunterlagen versendet"
		}
	}
]
...

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": [
        ]
    }
]
...