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": ""
        }
    ]
}