Users资源表示一组SAP Concur用户。它总是作为一批用户进行管理,即使这批用户只包含一个用户。
1
此资源允许您获取给定用户的配置文件信息。如果请求URL不包含?罗吉尼
参数,则响应将是登录用户的(并且您必须在请求中传递身份验证信息)。
获取api/user/v1.0/user
名称 | 类型 | 格式 | 描述 |
---|---|---|---|
罗吉尼 |
一串 |
- | 用户的URL编码SAP Concur登录。可选。 |
名称 | 类型 | 格式 | 描述 |
---|---|---|---|
罗吉尼 |
一串 |
- | 用户的登录ID。 |
活跃的 |
布尔 |
Y / N | 用户当前是否处于活动状态。 |
名字 |
一串 |
- | 用户的名字。 |
姓氏 |
一串 |
- | 用户的姓。 |
惯性矩 |
一串 |
- | 用户的中间首字母。 |
EmailAddress |
一串 |
- | 用户的电子邮件地址。 |
EmpId |
一串 |
- | 用户的唯一标识符。 |
LedgerName |
一串 |
- | 用户指定的帐户代码分类帐。 |
LocaleName |
一串 |
- | 用户的语言区域设置代码。支持的区域设置之一。例如:美国英语是en_US。 |
组织单元1至组织单元6 |
一串 |
- | 因配置不同而不同。 |
海关1至海关21 |
一串 |
- | 根据配置的不同而有所不同。如果自定义字段是列表字段,则数据将作为:(列表项短代码)列表项名称返回。列表字段示例: |
CtryCode |
一串 |
双字符国家代码 | 用户的两位数国家代码。 |
CashAdvanceAccountCode |
一串 |
- | 用户预支现金的账户代码。 |
CrnCode |
一串 |
ISO 4217货币代码 | 用户的三个角色的偿还货币。例如:“United Dollar”为“USD”。 |
CtrySubCode |
一串 |
- | 用户的两位数国家代码和两位数州或省代码。例如:美国华盛顿州为US-WA。 |
费用使用者 |
布尔 |
Y / N | 用户是否有权访问Expense。 |
ExpenseApprover |
布尔 |
Y / N | 用户是否为费用审批人。 |
TripUser |
布尔 |
Y / N | 用户是否有权旅行。 |
InvoiceUser |
布尔 |
Y / N | 用户是否有权访问Invoice。 |
发票批准人 |
布尔 |
Y / N | 用户是否为发票审批者。 |
ExpenseApproverEmployeeID |
一串 |
- | 用户的费用审批人员的员工ID。如果您同时导入用户及其审批者,则批处理中审批者应该列在用户之前。 |
IsTestEmp |
布尔 |
Y / N | 是否为测试用户。 |
请注意,这是一个3.0版API,可以找到在这里.
检索SAP Concur中的Global employee表单上的配置字段列表。
得到api / user / v1.0 / FormFields
名称 | 类型 | 格式 | 描述 |
---|---|---|---|
Id |
一串 |
- | 唯一的字段标识符。 |
标签 |
一串 |
- | 显示的字段标签。 |
ControlType |
一串 |
- | 字段的类型。 |
数据类型 |
一串 |
- | 字段收集的数据类型。 |
最大长度 |
一串 |
- | 字段中数据的最大长度。 |
要求 |
一串 |
- | 该字段是否为必填字段。 |
关口 |
一串 |
- | 字段占用的列数。 |
访问 |
一串 |
- | 最终用户对该领域的访问。 |
宽度 |
一串 |
- | 字段的宽度,以像素为单位。 |
自定义 |
一串 |
- | 字段是否自定义。 |
序列 |
一串 |
- | 表单上字段的顺序。 |
这些元素仅对自定义字段返回:
名称 | 类型 | 格式 | 描述 |
---|---|---|---|
ParentFormTypeCode |
一串 |
- | 此元素仅用于多级列表字段。父字段(列表层次结构中更高一级的字段)连接到的表单类型。 |
父字段ID |
一串 |
- | 在列表层次结构中较高层的字段的标识符。 |
IsCopyDownSourceForOtherForms |
一串 |
- | 该字段是否被其他表单用作向下复制源。 |
ListName |
一串 |
- | 与该字段关联的列表的名称。 |
希尔维尔 |
一串 |
- | 字段的列表级别。如果它是两级列表中的第二级字段,则值为2。 |
更新一个或多个用户。批处理最多可以包含500个用户。
请注意:用户API可以用来添加新用户,但是用户帐户还没有完全配置好并可以使用。为了完成用户概要文件,必须通过手动编辑或通过用户导入更新完成用户概要文件的附加工作。客户配置中存在高度的可变性,该API并不完全支持这种配置。通过文件导入进行手动编辑或更新最有可能需要完成使用此API开始的User配置文件。仅支持POST。请使用员工导入如果User API不能满足您的需求,则使用该特性。
发布api /用户/ v1.0 /用户
此API需要一个批处理
包含用户配置文件
要添加(将来)或更新的每个用户的子元素。这个用户配置文件
子元素将根据表单配置而变化,可能包含以下元素。
名称 | 类型 | 格式 | 描述 |
---|---|---|---|
EmpId |
一串 |
- | 必修的。用户的唯一标识符。默认值是用户的电子邮件地址。最多48个字符。 |
FeedRecordNumber |
一串 |
- | 必修的。当前批次中的记录编号。 |
罗吉尼 |
一串 |
- | 必需的。用户的登录ID。默认值为用户的邮箱地址。必须有“@”。最多128个字符。 |
LocaleName |
一串 |
- | 用户的语言区域设置代码。区域设置代码列表位于员工导入附录支持的区域设置之一。例如:美国英语是en_US。支持的语言因公司而异,但始终包括en_US。最多:5个字符。 |
活跃的 |
布尔 |
Y / N | 用户当前是否处于活动状态。 |
密码 |
一串 |
- | 必修的。用户的密码。此元素可用于输入新用户的密码,但不能用于更新现有用户的密码。最多255个字符。 |
名字 |
一串 |
- | 用户的名字。最多32个字符。 |
姓氏 |
一串 |
- | 用户的姓。最多32个字符。 |
惯性矩 |
一串 |
- | 用户的中间首字母。最大1字符。 |
EmailAddress |
一串 |
- | 用户的电子邮件地址。最多255个字符。 |
LedgerKey |
一串 |
- | 新用户所需。用户指定的帐户代码分类账。例如:违约。最大的20个字符。 |
组织单元1至组织单元6 |
一串 |
- | 员工表单上的自定义组织单位字段。根据配置的不同而有所不同。使用员工表单字段资源获取已配置字段的列表。每个字段最多48个字符。 |
海关1至海关21 |
一串 |
- | Employee表单上的自定义字段。因配置不同而不同。使用Employee Form Field资源获取配置字段列表。最大48个字符。 |
CtryCode |
一串 |
ISO 3166-1 alpha-2国家代码 | 国家代码,例如:美国就是美国。最多2个字符。 |
CashAdvanceAccountCode |
一串 |
- | 用户预支现金的账户代码。最大的20个字符。 |
CrnKey |
一串 |
ISO 4217三个字母的货币代码 | 用户报销货币的货币代码。例:美元等于美元。最多3个字符。 |
CtrySubCode |
一串 |
- | 用户的两个字符的国家代码和两个字符的州或省代码。例如:美国华盛顿州为US-WA。最大2字符。 |
费用使用者 |
布尔 |
Y / N |
用户是否有权访问Expense。 |
ExpenseApprover |
布尔 |
Y / N |
用户是否为费用审批人。 |
TripUser |
布尔 |
Y / N |
用户是否有权旅行。 |
InvoiceUser |
布尔 |
Y / N |
用户是否有权访问Invoice。 |
发票批准人 |
布尔 |
Y / N |
用户是否为发票审批者。 |
ExpenseApproverEmployeeID |
一串 |
- | 用户的费用审批人的员工ID。如果同时导入用户及其审批人,则批处理中应在用户之前列出审批人。最多48个字符。 |
纽洛尼德 |
一串 |
- | 使用此元素更改现有员工的登录ID。最多128个字符。 |
新雇员ID |
一串 |
- | 使用此元素可以更改现有员工的员工ID。最多48个字符。 |
名称 | 类型 | 格式 | 描述 |
---|---|---|---|
records-succeeded |
一串 |
- | 已成功添加或更新的已处理记录的数量。 |
记录失败 |
一串 |
- | 未成功添加或更新的已处理记录的数目。 |
当任何用户成功更新时:
请求将返回用户详细信息
具有用户信息
元素,用于每个成功添加或更新的用户。这个用户信息
元素将包含以下子元素:
名称 | 类型 | 格式 | 描述 |
---|---|---|---|
EmployeeID |
一串 |
- | 用户的员工ID。 |
FeedRecordNumber |
一串 |
- | 提要中记录的项目编号。 |
状态 |
一串 |
- | 试图添加或更新用户的状态。应该总是包含“成功”这个词。 |
当任何用户失败时:
该请求将返回errors父元素,并为每个记录失败返回一个错误父元素。error元素将包含以下子元素:
名称 | 类型 | 格式 | 描述 |
---|---|---|---|
EmployeeID |
一串 |
- | 用户的员工ID。 |
FeedRecordNumber |
一串 |
- | 提要中记录的项目编号。 |
消息 |
一串 |
- | 错误消息。 |
<批xmlns =“http://www.concursolutions.com/api/user/2011/02”>< UserProfile > 罗吉尼< / LoginID >< EmployeeID >雇员ID> <活跃N> < /活跃<--!任何更多的要求领域-->
POST api/user/v1.0/Users/password
最多为500个用户更新密码。
请记住,如果您正在更新密码以克服密码过期策略,则此方法不会更新用户密码过期日期。如果更新前的原始密码已过期,用户在登录SAP Concur时仍需更改密码。
此函数需要一个UserBatch
元素,该元素包含每个用户的用户子元素。这个用户
元素必须包含以下元素:
名称 | 类型 | 格式 | 描述 |
---|---|---|---|
罗吉尼 |
一串 |
- | 必修的。用户的登录ID。默认值为用户的电子邮件地址。该值必须包含“@”。 |
密码 |
一串 |
- | 用户的新密码。 |
这个请求将返回一个批处理结果
带有以下子元素的父元素:
名称 | 类型 | 格式 | 描述 |
---|---|---|---|
RecordsSucceeded |
一串 |
- | 已成功更新的已处理记录的数量。 |
记录失败 |
一串 |
- | 未成功更新的已处理记录数。 |
UserPasswordStatusList |
一串 |
- | 此父元素将包含一个UserPasswordStatus 元素。 |
的UserPasswordStatus
元素包含以下子元素:
名称 | 类型 | 格式 | 描述 |
---|---|---|---|
罗吉尼 |
一串 |
- | 用户的登录ID。 |
状态 |
布尔 |
成功/失败 | 尝试更新用户密码的状态。 |
消息 |
一串 |
- | 关于请求成功或失败的附加细节。 |
xmlns =“http://www.concursolutions.com/api/user/2011/02”> 罗吉尼< / LoginID > 密码用户> < /< / UserBatch >