PHP WHMCS GetProjects用法及代码示例

获取符合通过条件的订单

请求参数

参数	类型	说明	必需的
action	string	“GetProjects”	Required
limitstart	int	返回的项目数据的偏移量(默认值：0)。	Optional
limitnum	int	要返回的记录数(默认值：25)。	Optional
userid	int	用于查找项目的特定客户 ID。	Optional
title	string	查找项目的特定标题。	Optional
ticketids	string	用于查找项目的特定工单 ID。	Optional
invoiceids	string	用于查找项目的特定发票 ID。	Optional
notes	string	查找项目的具体说明。	Optional
adminid	int	用于查找项目的特定管理员 ID。	Optional
status	string	查找项目的特定状态。	Optional
created	string	查找项目的特定创建日期。	Optional
duedate	string	查找项目的特定截止日期。	Optional
completed	bool	是否查找已完成或未完成的项目。	Optional
lastmodified	string	查找项目的特定最后修改日期。	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
totalresults	int	可用结果的总数。
startnumber	int	返回结果的起始编号。
numreturned	int	返回的结果数。
invoices	array	与通过的条件匹配的发票数组。

示例请求 (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'GetProjects',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'GetProjects';
$postData = array(
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

示例响应 JSON

{
    "result": "success",
    "totalresults": 1,
    "startnumber": 0,
    "numreturned": 1,
    "projects": [
        {
            "id": 1,
            "userid": 0,
            "title": "First Project",
            "ticketids": "",
            "invoiceids": "",
            "notes": "",
            "adminid": 1,
            "status": "Pending",
            "created": "2020-06-24",
            "duedate": "2020-06-24",
            "completed": 0,
            "lastmodified": "2020-06-24 10:26:23",
            "watchers": ""
        }
    ]
}