調用getPersonList介面查詢個體組下的所有個體ID。
QPS限制
本介面的單使用者QPS限制為20次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。
請求文法
POST /green/sface/group/persons HTTPS|HTTP要求標頭
該介面使用公用要求標頭,無特殊要求標頭。請參見公用要求標頭。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
clientInfo | JSONObject | 否 | {"userId":"120234234","userNick":"Mike","userType":"others"} | 用戶端資訊,由ClientInfo結構體通過JSON序列化獲得,包含umid、imei等資訊,具體結構描述,請參見ClientInfo。 |
RequestBody
RequestBody中還需要填入以下參數,用來指定要查詢的個體組資訊。
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
groupId | String | 是 | group1 | 要查詢的個體組ID。 |
currentPage | Integer | 否 | 1 | 返回的當前分頁數,從 1 開始,預設值為 1。 |
pageSize | Integer | 否 | 20 | 分頁大小,預設值為 20,取值為 1-100。 |
返回資料
所有請求均返回JSON格式的資料。關於返回資料中的公用欄位,請參見公用返回參數。返回資料中的data欄位表示與業務相關的資料,一般是一個JSON結構體或數組。
響應出錯的情況下,data欄位可能為空白。
該介面返回的data欄位包含以下參數。
名稱 | 類型 | 樣本值 | 描述 |
code | Integer | 200 | 錯誤碼,和HTTP狀態代碼一致。 更多資訊,請參見公用錯誤碼。 |
personIds | StringArray | ["person1","person2"] | 個體組下的所有個體ID列表。 |
currentPage | Integer | 1 | 返回的當前分頁數。 |
pageSize | Integer | 20 | 返回的分頁大小。 |
totalCount | Integer | 100 | 總的共個體數。 |
樣本
請求樣本
POST /green/sface/group/persons HTTP/1.1
公用要求標頭
{
"groupId": "group1",
"pageSize": 10,
"currentPage": 1
}正常返回樣本
{
"msg": "OK",
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"personIds": [
"person1",
"person2"
],
"pageSize": 10,
"currentPage": 1,
"totalCount": 17
}
}