SAP Concur Developer Center |用户

Users资源表示一组SAP Concur用户。它总是作为一批用户进行管理，即使这批用户只包含一个用户。

版本

1．0

工艺流程

用户资源的流程

检索用户信息

此资源允许您获取给定用户的配置文件信息。如果请求URL不包含loginID ?参数，则响应将是登录用户的(并且您必须在请求中传递身份验证信息)。

得到api /用户/ v1.0 /用户

参数

的名字	类型	格式	描述
`loginID`	`字符串`	-	用户的url编码SAP Concur登录。可选的。

获取用户响应模式

的名字	类型	格式	描述
`loginID`	`字符串`	-	用户的登录ID。
`活跃的`	`布尔`	Y / N	用户当前是否处于活动状态。
`FirstName`	`字符串`	-	用户的名字。
`姓`	`字符串`	-	用户的姓。
`心肌梗死`	`字符串`	-	用户的中间首字母。
`EmailAddress`	`字符串`	-	用户的电子邮件地址。
`EmpId`	`字符串`	-	用户的唯一标识符。
`LedgerName`	`字符串`	-	用户指定的帐户代码分类账。
`LocaleName`	`字符串`	-	用户的语言区域设置代码。受支持的地区之一。例如:United English为en_US。
`通过OrgUnit6 OrgUnit1`	`字符串`	-	因配置不同而不同。
`通过Custom21 Custom1`	`字符串`	-	因配置不同而不同。如果自定义字段是列表字段，数据将返回为:(列表项短代码)列表项名称。字段列表的例子: (1234) 1234工程”
`CtryCode`	`字符串`	2-character国家代码	用户的两位数国家代码。
`CashAdvanceAccountCode`	`字符串`	-	用户预支现金的账户代码。
`CrnCode`	`字符串`	ISO 4217货币代码	用户的三个角色的偿还货币。例如:“United Dollar”为“USD”。
`CtrySubCode`	`字符串`	-	用户的两位数国家代码和两位数州或省代码。例如:美国华盛顿州为US-WA。
`ExpenseUser`	`布尔`	Y / N	用户是否有权访问Expense。
`ExpenseApprover`	`布尔`	Y / N	用户是否为费用审批者。
`TripUser`	`布尔`	Y / N	用户是否有权访问Travel。
`InvoiceUser`	`布尔`	Y / N	用户是否有权访问Invoice。
`InvoiceApprover`	`布尔`	Y / N	用户是否为发票审批者。
`ExpenseApproverEmployeeID`	`字符串`	-	用户的费用审批人员的员工ID。如果您同时导入用户及其审批者，则批处理中审批者应该列在用户之前。
`IsTestEmp`	`布尔`	Y / N	是否为测试用户。

根据搜索条件检索所有用户

注意，这是一个3.0版本的API，可以找到在这里．

检索创建用户所需字段列表

检索SAP Concur中的Global employee表单上的配置字段列表。

得到api / user / v1.0 / FormFields

必需字段响应模式

的名字	类型	格式	描述
`Id`	`字符串`	-	唯一的字段标识符。
`标签`	`字符串`	-	显示的字段标签。
`ControlType`	`字符串`	-	字段的类型。
`数据类型`	`字符串`	-	字段收集的数据类型。
`最大长度`	`字符串`	-	字段中数据的最大长度。
`要求`	`字符串`	-	是否需要该字段。
`关口`	`字符串`	-	字段占用的列数。
`访问`	`字符串`	-	最终用户对该领域的访问。
`宽度`	`字符串`	-	字段的宽度，以像素为单位。
`自定义`	`字符串`	-	字段是否自定义。
`序列`	`字符串`	-	表单上字段的序列。

这些元素仅对自定义字段返回:

的名字	类型	格式	描述
`ParentFormTypeCode`	`字符串`	-	此元素仅用于多级列表字段。父字段(列表层次结构中更高一级的字段)连接到的表单类型。
`ParentFieldId`	`字符串`	-	在列表层次结构中较高层的字段的标识符。
`IsCopyDownSourceForOtherForms`	`字符串`	-	字段是否被其他窗体用作复制源。
`ListName`	`字符串`	-	与该字段关联的列表的名称。
`HierLevel`	`字符串`	-	字段的列表级别。如果它是两级列表中的第二级字段，则值为2。

更新用户的帐户信息

更新一个或多个用户。批处理最多可以包含500个用户。

请注意:用户API可以用来添加新用户，但是用户帐户还没有完全配置好并可以使用。为了完成用户概要文件，必须通过手动编辑或通过用户导入更新完成用户概要文件的附加工作。客户配置中存在高度的可变性，该API并不完全支持这种配置。通过文件导入进行手动编辑或更新最有可能需要完成使用此API开始的User配置文件。仅支持POST。请使用员工导入如果User API不能满足您的需求，则使用该特性。

发布api /用户/ v1.0 /用户

这个API要求作为它的参数a批处理元素包含一个UserProfile子元素，用于添加(将来)或更新每个用户。的UserProfile子元素将根据表单配置而变化，可能包含以下元素。

更新用户帐户信息请求架构

的名字	类型	格式	描述
`EmpId`	`字符串`	-	必需的。用户的唯一标识符。默认值为用户的邮箱地址。最大48个字符。
`FeedRecordNumber`	`字符串`	-	必需的。当前批处理中的记录号。
`LoginId`	`字符串`	-	必需的。用户的登录ID。默认值为用户的邮箱地址。必须有“@”。最多128个字符。
`LocaleName`	`字符串`	-	用户的语言区域设置代码。区域设置代码列表可在员工导入合同附件。受支持的地区之一。例如:United English为en_US。支持的语言因公司而异，但总是包括en_US。最大:5字符。
`活跃的`	`布尔`	Y / N	用户当前是否处于活动状态。
`密码`	`字符串`	-	必需的。用户的密码。此元素可用于输入新用户的密码，但不能用于更新现有用户的密码。最多255个字符。
`FirstName`	`字符串`	-	用户的名字。最多32个字符。
`姓`	`字符串`	-	用户的姓。最多32个字符。
`心肌梗死`	`字符串`	-	用户的中间首字母。最大1字符。
`EmailAddress`	`字符串`	-	用户的电子邮件地址。最多255个字符。
`LedgerKey`	`字符串`	-	新用户所需。用户指定的帐户代码分类账。例如:违约。最大的20个字符。
`通过OrgUnit6 OrgUnit1`	`字符串`	-	Employee表单上的自定义组织单元字段。因配置不同而不同。使用Employee Form Field资源获取配置字段列表。每个字段不能超过48个字符。
`通过Custom21 Custom1`	`字符串`	-	Employee表单上的自定义字段。因配置不同而不同。使用Employee Form Field资源获取配置字段列表。最大48个字符。
`CtryCode`	`字符串`	ISO 3166-1 alpha-2国家代码	国家代码，例如:United States为US。最大2字符。
`CashAdvanceAccountCode`	`字符串`	-	用户预支现金的账户代码。最大的20个字符。
`CrnKey`	`字符串`	ISO 4217三个字母的货币代码	用户报销货币的货币代码。例如:“United Dollar”为“USD”。最大的3个字符。
`CtrySubCode`	`字符串`	-	用户的两个字符的国家代码和两个字符的州或省代码。例如:美国华盛顿州为US-WA。最大2字符。
`ExpenseUser`	`布尔`	`Y / N`	用户是否有权访问Expense。
`ExpenseApprover`	`布尔`	`Y / N`	用户是否为费用审批者。
`TripUser`	`布尔`	`Y / N`	用户是否有权访问Travel。
`InvoiceUser`	`布尔`	`Y / N`	用户是否有权访问Invoice。
`InvoiceApprover`	`布尔`	`Y / N`	用户是否为发票审批者。
`ExpenseApproverEmployeeID`	`字符串`	-	用户的费用审批人员的员工ID。如果您同时导入用户及其审批者，则批处理中审批者应该列在用户之前。最大48个字符。
`NewLoginID`	`字符串`	-	使用此元素更改现有雇员的Login ID。最多128个字符。
`NewEmployeeID`	`字符串`	-	使用此元素更改现有雇员的Employee ID。最大48个字符。

更新用户帐户信息响应模式

的名字	类型	格式	描述
`records-succeeded`	`字符串`	-	已成功添加或更新的已处理记录的数量。
`records-failed`	`字符串`	-	未成功添加或更新的已处理记录的数目。

当任何用户成功更新时:

请求将返回UserDetails带有用户信息元素，用于成功添加或更新的每个用户。的用户信息元素将包含以下子元素:

的名字	类型	格式	描述
`EmployeeID`	`字符串`	-	用户的员工ID。
`FeedRecordNumber`	`字符串`	-	提要中记录的项目编号。
`状态`	`字符串`	-	试图添加或更新用户的状态。应该总是包含“成功”这个词。

当任何用户失败时:

该请求将返回errors父元素，并为每个记录失败返回一个错误父元素。error元素将包含以下子元素:

的名字	类型	格式	描述
`EmployeeID`	`字符串`	-	用户的员工ID。
`FeedRecordNumber`	`字符串`	-	提要中记录的项目编号。
`消息`	`字符串`	-	错误消息。

例子

         <批xmlns =“http://www.concursolutions.com/api/user/2011/02”>< UserProfile >< LoginID >loginID< / LoginID >< EmployeeID >employeeID< / EmployeeID >> <活跃N> < /活跃<——!更多必需字段——>< / UserProfile >> < /批
        

更新用户密码

发布api / user / v1.0 /用户/密码

最多为500个用户更新密码。

请记住，如果您正在更新密码以克服密码过期策略，则此方法将不会更新用户密码过期日期。如果更新前的原始密码已经过期，用户登录SAP Concur时仍然需要更改密码。

更新用户密码请求架构

这个函数的参数是aUserBatch元素，其中包含每个用户的User子元素。的用户元素必须包含以下元素:

的名字	类型	格式	描述
`LoginID`	`字符串`	-	必需的。用户的登录ID。默认值为用户的邮箱地址。必须包含“@”。
`密码`	`字符串`	-	用户的新密码。

更新用户密码响应架构

这个请求将返回一个BatchResult带有以下子元素的父元素:

的名字	类型	格式	描述
`RecordsSucceeded`	`字符串`	-	已成功更新的已处理记录的数量。
`RecordsFailed`	`字符串`	-	未成功更新的已处理记录的数量。
`UserPasswordStatusList`	`字符串`	-	这个父元素将包含一个`UserPasswordStatus`元素。

的UserPasswordStatus元素包含以下子元素:

的名字	类型	格式	描述
`LoginID`	`字符串`	-	用户的登录ID。
`状态`	`布尔`	成功/失败	尝试更新用户密码的状态。
`消息`	`字符串`	-	关于请求成功或失败的附加细节。

例子

         < UserBatchxmlns =“http://www.concursolutions.com/api/user/2011/02”><用户名>< LoginID >loginID< / LoginID ><密码>密码< /密码>用户> < /< / UserBatch >
        

版本