联系我们用户的队友
队友对象
| 属性 | 类型 | 描述 |
|---|---|---|
| id | int | 队友的唯一ID |
| first_name | 字符串 | 队友的名字 |
| last_name | 字符串 | 队友的姓 |
| 电子邮件 | 字符串 | 队友的邮件 |
需要的权限
必须是管理员才能与/ v2 /用户/ {USER_ID} /队友端点。权限不足将导致403年被禁止的状态码。
列出指定用户的所有队友
为标识的用户返回分配的队友列表USER_ID．的USER_ID必须属于Manager类型的用户，如果不是422不可处理实体将返回状态码。
响应包含一个对象队友属性，该属性包含最多到的数组per_page队友。数组中的每个条目都是一个单独的队友对象。如果没有更多的队友可用，则结果数组将为空。响应中包含了几个额外的分页属性，以简化对队友的分页。
GET / v2 /用户/ {USER_ID} /队友| 参数 | 类型 | 描述 |
|---|---|---|
页面 |
整数 | 在分页中使用的页码。例如，如果您发出一个列表请求并收到100条记录，您的后续呼叫可以包括页面= 2检索列表的下一页。(默认值:1) |
per_page |
整数 | 每页要返回的记录数。取值范围为1 ~ 2000。(默认:2000) |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/users/1782959/teammates" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"示例响应:
｛“队友”:【｛“id”：3230547，“first_name”：“吉姆”，“last_name”：“艾伦”，“电子邮件”：“jimallen@example.com”}，｛“id”：1782884，“first_name”：“Bob”，“last_name”：“鲍威尔”，“电子邮件”：“bobpowell@example.com”｝]，“per_page”：One hundred.，“total_pages”：1，“total_entries”：2，“next_page”：零，“previous_page”：零，“页面”：1，“链接”: {“第一”：“https://api.bob客服端下载harvestapp.com/v2/users/1782959/teammates?page=1&per_page=100”，“下一个”：零，“以前”：零，“最后一次”：“https://api.bob客服端下载harvestapp.com/v2/users/1782959/teammates?page=1&per_page=100”｝｝更新用户指定的队友
更新指定用户的队友。返回分配的队友列表和200好了调用成功时的响应代码。的USER_ID必须属于Manager类型的用户，如果不是422不可处理实体将返回状态码。
第一次添加队友会添加people_manager访问的角色对经理说。类中未包含的任何idteammate_ids当前分配的数据将从管理器中取消分配。使用空数组取消所有用户的分配。这也将删除people_manager访问角色。
补丁/ v2 /用户/ {USER_ID} /队友| 参数 | 类型 | 要求 | 描述 |
|---|---|---|---|
teammate_ids |
用户id数组 | 要求 | 要分配给管理器的用户id的完整列表。 |
示例请求:
curl "https://api.bob客服端下载harvestapp.com/v2/users/1782959/teammates" \ -H "授权:持有者$ACCESS_TOKEN" \ -H "收获帐户id: $ACCOUNT_ID" \ -H "User-Agent: MyApp (yourname@example.com)"\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"teammate_ids":[3230547, 3230575]}'示例响应
｛“队友”:【｛“id”：3230547，“first_name”：“吉姆”，“last_name”：“艾伦”，“电子邮件”：“jimallen@example.com”}，｛“id”：3230575，“first_name”：“加里。”，“last_name”：“布鲁克斯”，“电子邮件”：“gary@example.com”｝］｝