SOAP API method Collection_callback
Description
Return a single Callback by ID or url. A callback is launched when a profile or subprofile is created, updated or deleted and the javascript expression of the callback matches.
Parameters
Name | Type | Description |
---|---|---|
id * | int | Unique identifier (id) of the object Collection. The method only applies to the collection with this id. |
identifier * | int | |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* required parameters |
Return values
Name | Type | Description |
---|---|---|
callback | Structure of type 'callback' |
Structure 'login'
Name | Type | Description |
---|---|---|
username | string | The username of the login attempt |
account | string | The account name of the login attempt |
password | string | The password for the login attempt |
Structure 'callback'
Name | Type | Description |
---|---|---|
id | int | The ID of the callback. |
url | string | The url to notify. |
method | string | Get the method of notify. This can be xml, json. |
expression | string | The expression that validates the callback. |
api_disabled | boolean | Set whether the callback is disabled in api mode |
actionfilter | string | The actions that can trigger this callback. |