dolibarr
9.0.0
|
Public Member Functions | |
__construct () | |
Constructor. | |
get ($id) | |
Get properties of a member object. More... | |
index ($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $typeid='', $sqlfilters='') | |
List members. More... | |
post ($request_data=null) | |
Create member object. More... | |
put ($id, $request_data=null) | |
Update member. More... | |
delete ($id) | |
Delete member. More... | |
_validate ($data) | |
Validate fields before creating an object. More... | |
_cleanObjectDatas ($object) | |
Clean sensible object datas. More... | |
getSubscriptions ($id) | |
List subscriptions of a member. More... | |
createSubscription ($id, $start_date, $end_date, $amount, $label='') | |
Add a subscription for a member. More... | |
getCategories ($id, $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0) | |
Get categories for a member. More... | |
![]() | |
__construct ($db, $cachedir='', $refreshCache=false) | |
Constructor. More... | |
_cleanObjectDatas ($object) | |
Executed method when API is called without parameter. More... | |
_checkFilters ($sqlfilters) | |
Return if a $sqlfilters parameter is valid. More... | |
Additional Inherited Members | |
![]() | |
static | _checkAccessToResource ($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid') |
Check user access to a resource. More... | |
static | _forge_criteria_callback ($matches) |
Function to forge a SQL criteria. More... | |
Definition at line 31 of file api_members.class.php.
Members::_cleanObjectDatas | ( | $object | ) |
Clean sensible object datas.
object | $object | Object to clean |
Definition at line 297 of file api_members.class.php.
Members::_validate | ( | $data | ) |
Validate fields before creating an object.
array | null | $data | Data to validate |
RestException |
Definition at line 280 of file api_members.class.php.
Members::createSubscription | ( | $id, | |
$start_date, | |||
$end_date, | |||
$amount, | |||
$label = '' |
|||
) |
Add a subscription for a member.
int | $id | ID of member |
int | $start_date | Start date { body} { timestamp} |
int | $end_date | End date { body} { timestamp} |
float | $amount | Amount (may be 0) { body} |
string | $label | Label { body} |
POST {id}/subscriptions
Definition at line 364 of file api_members.class.php.
Members::delete | ( | $id | ) |
Delete member.
int | $id | member ID |
Definition at line 245 of file api_members.class.php.
Members::get | ( | $id | ) |
Get properties of a member object.
Return an array with member informations
int | $id | ID of member |
RestException |
Definition at line 60 of file api_members.class.php.
Members::getCategories | ( | $id, | |
$sortfield = "s.rowid" , |
|||
$sortorder = 'ASC' , |
|||
$limit = 0 , |
|||
$page = 0 |
|||
) |
Get categories for a member.
int | $id | ID of member |
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
GET {id}/categories
Definition at line 392 of file api_members.class.php.
Members::getSubscriptions | ( | $id | ) |
List subscriptions of a member.
Get a list of subscriptions
int | $id | ID of member |
RestException | GET {id}/subscriptions |
Definition at line 331 of file api_members.class.php.
Members::index | ( | $sortfield = "t.rowid" , |
|
$sortorder = 'ASC' , |
|||
$limit = 100 , |
|||
$page = 0 , |
|||
$typeid = '' , |
|||
$sqlfilters = '' |
|||
) |
List members.
Get a list of members
string | $sortfield | Sort field |
string | $sortorder | Sort order |
int | $limit | Limit for list |
int | $page | Page number |
string | $typeid | ID of the type of member |
string | $sqlfilters | Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')" |
RestException |
Definition at line 94 of file api_members.class.php.
Members::post | ( | $request_data = null | ) |
Create member object.
array | $request_data | Request data |
Definition at line 165 of file api_members.class.php.
Members::put | ( | $id, | |
$request_data = null |
|||
) |
Update member.
int | $id | ID of member to update |
array | $request_data | Datas |
Definition at line 190 of file api_members.class.php.