Skip to navigation

查詢單一客戶總部

View as Markdown

⚠️ 群組決定資料可見範圍:總部客戶的 Boss 角色使用者看得到群組內所有成員的資料。這支端點只讀取,不會改變可見範圍。

依 id 查詢單一客戶總部,回傳總部客戶(parentCompany)與子客戶清單(subCompanies)。子客戶清單不含總部本身,依客戶序號由小到大排列,只列出有效的客戶。若總部客戶之後已被刪除,parentCompany 仍會回傳 id,outerSysCode 與 name 則為空字串。

群組不存在,或屬於其他租戶,一律回傳 404 not_found,兩種情況無法從回應內容區分。

Authentication

X-Signaturestring

每個 /v1 請求都必須帶 X-Client-Id、X-Timestamp、X-Nonce 與 X-Signature 四個標頭。X-Signature 是以 client secret 對 canonical string 做 HMAC-SHA256 後的 Base64。

canonical string 的組成、可複製的簽章範例與 401 排查步驟,請參閱「驗證與簽章」。

Path parameters

idlongRequired

要查詢的群組序號。不存在或屬於其他租戶時,一律回傳 404 not_found。

Response

OK
idlongOptional

群組序號。

namestring or nullOptional

群組名稱。

parentCompanyobjectOptional

總部客戶。建立群組後不能更換。

subCompanieslist of objects or nullOptional

子客戶清單,不含總部本身,依客戶序號由小到大排列,只列出有效的客戶。

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error