Get macro resolve

Resource type: macroresolve

Class: SmartMlInterfaceActionGetMacroResolve
Action Type: Get

Returns the given text resolved by macro resolver. To have a proper context, usually IDs of a module have to be specified, see parameter list.

See macro list for reference (you need to be logged in in enterprise). You can call the macro list from enterprise via the menu “?->macro list”.

Parameters:

  • text
    STRING. MANDATORY. Text to resolve.
  • ishtml
    BOOL. Text or html.
  • estateids
    ARRAY. Estate IDs.
  • addressids
    ARRAY. Address IDs.
  • appointmentids
    ARRAY. Appointment IDs.
  • agentlogids
    ARRAY. agent log IDs.

Example:

...
{
	"actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
	"resourceid": "",
	"identifier": "",
	"resourcetype": "macroresolve",
	"parameters": {
              "text":"_Uservorname _Username"
	}
}
...

Response:

Parameters:

  • registryvalue
    STRING. Registry value
{
    "status": {
        "code": 200,
        "errorcode": 0,
        "message": "OK"
    },
    "response": {
        "results": [
            {
                "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
                "resourceid": "",
                "resourcetype": "macroresolve",
                "cacheable": true,
                "identifier": "",
                "data": {
                    "meta": {
                        "cntabsolute": null
                    },
                    "records": [
                        {
                            "id": 0,
                            "type": "",
                            "elements": {
                                "resolvedtext": "Robert Igelmund"
                            }
                        }
                    ]
                },
                "status": {
                    "errorcode": 0,
                    "message": "OK"
                }
            }
        ]
    }
}