SOAP API method reference

Description

If a expression in javascript is provided, then this expression is run with the affected profile or subprofile. If the expression is true the given url will be visited and a post request is made using xml or json.

Parameters

Parameter 'id' : int: Unique identifier (id) of the object Database. The method only applies to the database with this id.
Parameter 'url' : string
Parameter 'expression' : string
Parameter 'method' : string
Parameter 'login' : Structure of type 'login': Optional login data

Return values

Return value 'callback' : Structure of type 'callback'

Structure 'login'

This structure login was mentioned above. This structure has the following properties:

Property 'username' : string: The username of the login attempt
Property 'account' : string: The account name of the login attempt
Property 'password' : string: The password for the login attempt

Structure 'callback'

This structure callback was mentioned above. This structure has the following properties:

Property 'id' : int: The ID of the callback.
Property 'url' : string: The url to notify.
Property 'method' : string: Get the method of notify. This can be xml, json.
Property 'expression' : string: The expression that validates the callback.
Property 'api_disabled' : boolean: Set whether the callback is disabled in api mode
Property 'actionfilter' : string: The actions that can trigger this callback.

SOAP API method Database_createCallback