用户
用户对象
属性 | 类型 | 描述 |
---|---|---|
id |
整数 | 用户的唯一ID。 |
first_name |
字符串 | 用户的名字。 |
last_name |
字符串 | 用户的姓。 |
电子邮件 |
字符串 | 用户的电子邮件地址。 |
电话 |
字符串 | 用户的电话号码。 |
时区 |
字符串 | 用户的时区。 |
has_access_to_all_future_projects |
布尔 | 用户是否应该自动添加到未来的项目。 |
is_contractor |
布尔 | 无论用户是一个承包商或雇员。 |
is_active |
布尔 | 用户是否主动或存档。 |
weekly_capacity |
整数 | 每周的小时数这个人可以在几秒钟内工作,在半个小时的增量。例如,如果一个人的能力是35小时,API将返回126000秒。 |
default_hourly_rate |
小数 | 计费率时使用这个用户被添加到一个项目。 |
cost_rate |
小数 | 成本率用于该用户在计算项目的成本和计费。 |
角色 |
字符串数组 | 描述性的名字的业务角色分配给这个人。他们可以用于过滤报告,在收割他们的权限没有影响。bob客服端下载 |
access_roles |
字符串数组 | 访问角色(年代)决定用户的权限在收获。bob客服端下载可能的值:管理员 ,经理 或成员 。此外具有manager角色的用户可以授予一个或多个这样的角色:project_creator ,billable_rates_manager ,managed_projects_invoice_drafter ,managed_projects_invoice_manager ,client_and_task_manager ,time_and_expenses_manager ,estimates_manager 。 |
avatar_url |
字符串 | URL到用户的《阿凡达》的形象。 |
created_at |
datetime | 用户创建日期和时间。 |
updated_at |
datetime | 用户最后一次更新的日期和时间。 |
需要的权限
你必须管理员或经理分配队友为了相互作用/ v2 /用户
端点,除非检索当前身份验证的用户。经理不能编辑电子邮件、角色或权限,他们存档,也不能恢复或删除指定temmates。经理同意看到计费率将获得他们的队友的默认每小时率。权限不足将导致403年被禁止的
状态码。
列出所有用户
返回一个用户列表。用户返回按创建日期排序,与最近创建的用户首先出现。
响应包含一个对象用户
属性包含一个数组per_page
用户。数组中的每一项都是一个单独的用户对象。如果没有更多的用户是可用的,由此产生的数组将是空的。几个额外的分页属性包含在响应用户能够简化方法。
获得/ v2 /用户
参数 | 类型 | 描述 |
---|---|---|
is_active |
布尔 | 通过真正的 只活跃用户,返回假 返回不活跃的用户。 |
updated_since |
datetime | 以来,已更新只返回用户给定的日期和时间。 |
页面 |
整数 | 使用分页的页号。例如,如果您列出请求和收到2000条记录,后续调用可以包括页面= 2 检索列表的下一个页面。(默认值:1) |
per_page |
整数 | 每个页面返回的记录数量。介于1和2000之间。(默认:2000) |
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/users " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”
示例响应:
检索当前身份验证的用户
检索当前身份验证的用户。返回一个用户对象和一个200好了
响应代码。
GET / v2 /用户/我
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/users/me " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”
示例响应:
检索用户
检索与给定的用户ID。返回一个用户对象和一个200好了
响应代码提供了一个有效的标识符。
GET / v2 /用户/ {USER_ID}
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/users/3230547 " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”
示例响应:
创建一个用户
创建一个新用户对象和发送邀请邮件中指定的地址电子邮件
参数。返回一个用户对象和一个201年创建
响应代码如果调用成功。
POST / v2 /用户
参数 | 类型 | 要求 | 描述 |
---|---|---|---|
first_name |
字符串 | 要求 | 用户的名字。 |
last_name |
字符串 | 要求 | 用户的姓。 |
电子邮件 |
字符串 | 要求 | 用户的电子邮件地址。 |
时区 |
字符串 | 可选 | 用户的时区。默认为公司的时区。看到一列支持时区。 |
has_access_to_all_future_projects |
布尔 | 可选 | 用户是否应该自动添加到未来的项目。默认为假 。 |
is_contractor |
布尔 | 可选 | 无论用户是一个承包商或雇员。默认为假 。 |
is_active |
布尔 | 可选 | 用户是否主动或存档。默认为真正的 。 |
weekly_capacity |
整数 | 可选 | 每周的小时数这个人可以在几秒钟内工作。默认为126000年 秒(35小时)。 |
default_hourly_rate |
小数 | 可选 | 计费率时使用这个用户被添加到一个项目。默认为0 。 |
cost_rate |
小数 | 可选 | 成本率用于该用户在计算项目的成本和计费。默认为0 。 |
角色 |
字符串数组 | 可选 | 描述性的名字的业务角色分配给这个人。他们可以用于过滤报告,在收割他们的权限没有影响。bob客服端下载 |
access_roles |
字符串数组 | 可选 | 访问角色(年代)决定用户的权限在收获。bob客服端下载可能的值:管理员 ,经理 或成员 。此外具有manager角色的用户可以授予一个或多个这样的角色:project_creator ,billable_rates_manager ,managed_projects_invoice_drafter ,managed_projects_invoice_manager ,client_and_task_manager ,time_and_expenses_manager ,estimates_manager 。 |
访问角色
为用户设置权限,使用access_roles
参数。用户必须是下列之一:成员
,经理
,或管理员
。
- 如果没有
access_role
参数被发送,用户默认为“成员”。 - 如果一个用户是一个
经理
他们可以有其他访问收获中的角色设置更具体的权限。bob客服端下载 - 的作用
people_manager
取决于用户是否有队友分配给他们,可以通过添加队友api。如果你下调一个人经理的角色成员,他们将不再是一个人管理和分配队友将被删除。
访问角色名 | 描述 |
---|---|
管理员 |
用户最需要的控制来管理您的帐户。管理员可以看到和做所有的事。 |
经理 |
用户需要更多的人员访问和项目报告。经理可以追踪的时间和费用,和编辑,批准,并运行报告和费用跟踪选定的项目和人。 |
成员 |
的用户只需要跟踪的时间和费用。 |
额外的管理器访问角色名称 | 描述 |
---|---|
project_creator |
用户可以创建项目,并编辑项目管理。 |
billable_rates_manager |
用户可以看到计费率和金额项目和管理的人。 |
managed_projects_invoice_drafter |
用户可以创建和编辑草稿发票项目管理。 |
managed_projects_invoice_manager |
用户可以发送和全面项目管理管理所有发票(支付记录,编辑non-drafts,发送提醒和感谢信,删除,等等)。 |
client_and_task_manager |
用户可以创建和编辑所有客户账户和任务。 |
time_and_expenses_manager |
用户可以创建和编辑时间和费用和项目管理。 |
estimates_manager |
用户可以创建和编辑所有估计帐户。 |
了解更多关于团队的权限
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/users " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”\ -X POST \ -H "Content-Type: application/json" \ -d '{"email":"george@example.com","first_name":"George","last_name":"Frank","access_roles":["manager","project_creator","time_and_expenses_manager"]}'
示例响应:
更新用户
更新特定用户通过设置的值传递的参数。没有提供任何参数将保持不变。返回一个用户对象和一个200好了
响应代码如果调用成功。
补丁/ v2 /用户/ {USER_ID}
参数 | 类型 | 描述 |
---|---|---|
first_name |
字符串 | 用户的名字。如果用户不能更新是不活跃的。 |
last_name |
字符串 | 用户的姓。如果用户不能更新是不活跃的。 |
电子邮件 |
字符串 | 用户的电子邮件地址。如果用户不能更新是不活跃的。 |
时区 |
字符串 | 用户的时区。默认为公司的时区。看到一列支持时区。 |
has_access_to_all_future_projects |
布尔 | 用户是否应该自动添加到未来的项目。 |
is_contractor |
布尔 | 无论用户是一个承包商或雇员。 |
is_active |
布尔 | 用户是否主动或存档。 |
weekly_capacity |
整数 | 每周的小时数这个人可以在几秒钟内工作。 |
default_hourly_rate |
小数 | 计费率时使用这个用户被添加到一个项目。 |
cost_rate |
小数 | 成本率用于该用户在计算项目的成本和计费。 |
角色 |
字符串数组 | 描述性的名字的业务角色分配给这个人。他们可以用于过滤报告,在收割他们的权限没有影响。bob客服端下载 |
access_roles |
字符串数组 | 访问角色(年代)决定用户的权限在收获。bob客服端下载可能的值:管理员 ,经理 或成员 。此外具有manager角色的用户可以授予一个或多个这样的角色:project_creator ,billable_rates_manager ,managed_projects_invoice_drafter ,managed_projects_invoice_manager ,client_and_task_manager ,time_and_expenses_manager ,estimates_manager 。 |
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/users/3237198 " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"roles":["Product Team"], "access_roles":["manager", "time_and_expenses_manager", "billable_rates_manager"]}'
示例响应:
档案用户
档案的特定用户设置的值is_active
来假
。让用户再次活跃时,简单的设置is_active
来真正的
一次。返回用户对象和一个更新200好了
响应代码如果调用成功。
补丁/ v2 /用户/ {USER_ID}
示例请求:
旋度" https://api.habob客服端下载rvestapp.com/v2/users/3226125 " \ - h“授权:无记名ACCESS_TOKEN美元”\ - h”Harvest-Account-Id: $ ACCOUNT_ID \ - h“用户代理:MyApp (yourname@example.com)”\ -X PATCH \ -H "Content-Type: application/json" \ -d '{"is_active":false}'
示例响应:
删除一个用户
删除一个用户。删除一个用户是唯一可能的,如果他们没有时间条目或相关费用。返回一个200好了
响应代码如果调用成功。
删除/ v2 /用户/ {USER_ID}