Definition at line 28 of file api_subscriptions.class.php.
◆ _validate()
Subscriptions::_validate |
( |
|
$data | ) |
|
Validate fields before creating an object.
- Parameters
-
array | null | $data | Data to validate |
- Returns
- array
- Exceptions
-
Definition at line 244 of file api_subscriptions.class.php.
◆ delete()
Subscriptions::delete |
( |
|
$id | ) |
|
◆ get()
Subscriptions::get |
( |
|
$id | ) |
|
Get properties of a subscription object.
Return an array with subscription informations
- Parameters
-
- Returns
- array|mixed data without useless information
- Exceptions
-
Definition at line 59 of file api_subscriptions.class.php.
◆ index()
Subscriptions::index |
( |
|
$sortfield = "dateadh" , |
|
|
|
$sortorder = 'ASC' , |
|
|
|
$limit = 100 , |
|
|
|
$page = 0 , |
|
|
|
$sqlfilters = '' |
|
) |
| |
List subscriptions.
Get a list of subscriptions
- Parameters
-
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
string | $sqlfilters | Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.import_key:<:'20160101')" |
- Returns
- array Array of subscription objects
- Exceptions
-
Definition at line 88 of file api_subscriptions.class.php.
◆ post()
Subscriptions::post |
( |
|
$request_data = null | ) |
|
Create subscription object.
- Parameters
-
array | $request_data | Request data |
- Returns
- int ID of subscription
Definition at line 154 of file api_subscriptions.class.php.
◆ put()
Subscriptions::put |
( |
|
$id, |
|
|
|
$request_data = null |
|
) |
| |
Update subscription.
- Parameters
-
int | $id | ID of subscription to update |
array | $request_data | Datas |
- Returns
- int
Definition at line 179 of file api_subscriptions.class.php.
The documentation for this class was generated from the following file: