SOAP API method Collection_createCallback
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
| Name | Type | Description |
|---|---|---|
| id * | int | Unique identifier (id) of the object Collection. The method only applies to the collection with this id. |
| url * | string | |
| expression | string | |
| method | string | |
| 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. |