家 构建 产品集成指南
指南
工作地点API指南ADP专家巴西188bet金宝搏app
发表在
2022年7月27日7:14AM
最后修改
2023年1月11日11:11PM
188bet金宝搏appADP版权信息
188bet金宝搏appADP, ADP的标志,和ADP的总是为人们设计商标,公司。
Windows是微软公司的一个注册商标。
所有另外的商标是他们的各自的主人的财产。
版权©2023年188bet金宝搏appADP公司ADP专有和机密,保留所有权利。这些材料不得在任何复制格式没有ADP的书面许可,公司。188bet金宝搏app
这些材料不得在任何复制格式没有ADP的书面许可,公司ADP提供了这种出版”是“没有任何形式的保证,表达或暗示的保证,包括但不限于隐含保证适销性或健身为特定目的。188bet金宝搏app188bet金宝搏appADP不负责任何技术inaccurancies或排版错误可能包含在这份出版物。定期更改的信息,和这种变化将纳入新版本出版。188bet金宝搏appADP可能做出改进和/或产品的变化和/或本出版物中描述的程序。
发表在
2022年7月27日7:14AM
最后修改
2023年1月11日11:11PM
表的内容
章1
关于这个API

总结

工作地点API指南描述了应用程序如何访问信息关于工作地点在应用程序中注册。它可以帮助你确定哪些用例最好的满足您的业务需求。

它还将指导您完成每个用例的实现。

工作位置的描述,员工身体的公司工作,作为一个工人网站(像一个分支或总部)或客户的网站。在这个API,应用程序可以访问数据对每个工作位置注册联系的每个工人的工作任务。

在本指南´s新

在本节中,我们将宣布任何新的修订工作位置应用程序编程接口(API)和本指南。

2022年11月

  • 本文的第一次修订

2022年12月

  • 变化对过滤器命令的行为。

过程概述

下面的表显示了如何使用你的数据连接器应用程序客户机。

演员的任务 描述
1 人力资源从业者

基于触发api的应用程序之间的数据交换

和ADP188bet金宝搏app专家
2 您的应用程序 检索工作地点信息详细信息基于您的需要

所需的设置步骤

没有所需的设置步骤。

邮差集合


邮差允许您导入一个api的集合,由其他人创建的,所以你可以试试。邮递员的更多信息,请参阅做你的第一个API调用使用邮差。

下载API工作地点集合API从ADP GitHub库,并将其导入到邮递员,邮递员上班地点集合。188bet金宝搏app

在你开始之前

188bet金宝搏appADP api提供了一套全面的部门与ADP应用程序保持同步,做到以下几点:

  • 检索注册工作位置的列表。
  • 检索数据为一个特定的工作位置信息。

应用程序检索的数据量可能会有所不同根据系统目标ADP和ADP的系统配置。188bet金宝搏app此外,控制API允许您选择或过滤所请求的数据基于您的需要。

章2
用例:检索工作地点信息

在你开始之前

这个API包含数据的工作位置在专家系统中注册,这意味着“Estabelecimento”、“Tomador”和“Tomador Obra为固有层”地址表。保证唯一性,位置ID使用上面的结构形成的工作位置在需要的时候(更多细节,请现场locationID数据字典)

API的使用

方法 URI 描述 GitHub的例子
得到 /人力资源/ v1 / associate-work-locations 所有可用的工作地点的列表请求者的请求被授权视图。 JSON响应示例
得到 /人力资源/ v1 / associate-work-locations / {location-id} 请求一个请求者被授权查看工作位置。 JSON响应示例

适用范围


相对应的标准URI API需要添加在消费应用程序注册表(汽车)订阅后用户可以访问这个API,使成功的API调用。

以下规范需要添加到您的应用范围,使这个用例:

/人力资源/ organizationInformationManagement / organizationInformationManagement / workLocationManagement / workLocation.read

强制性的头

这个API有以下强制性的标题:

头 期望值
associateoid associateoid的用户。
orgoid 客户端的orgoid你试图访问。
领域 发自
琼 eXpertBR
roleCode 在这一点上,只有“医生”角色的支持。

支持OData查询选项

这个用例支持查询字符串定义的选项开放数据协议(OData)。

查询字符串的选择 描述 例子
美元上 请求查询的条目的数量被包括在结果集合。 /人力资源/ v1 / associate-work-locations ? = 100美元
美元跳过 查询集合中指定条目的数量被忽略,而不是包含在结果中。 /人力资源/ v1 / associate-work-locations ? = 100 &跳过= 100美元
美元的过滤器

过滤器的集合资源请求解决的统一资源定位符(URL188bet金宝搏手机客户端下载)。只有项的表达式的计算结果为真时,包含在响应中。

当使用过滤器,将命令记录所选择的领域。

请注意,并不是所有的字段都可用于过滤(检查附录B的更多细节)

 /人力资源/ v1 / associate-work-locations吗?美元的过滤器=/associateWorkLocations eq ‘ESTAB-001-1’


数据字典

见附件一:数据字典进行数据检索页。

所有列出的字段是支持这个用例。

反应

你可能会遇到异常外常见的成功场景。你必须考虑这些异常在你最初的发展。

返回代码 返回状态
200好了 检索与细节的工作位置列表。
200好了 检索单个位置的细节工作。
200好了 检索工作位置响应使用美元上和$跳过参数。
200 OK(空表)

当分页的页

例子

/人力资源/ v1 / associate-work-locations ? = 100 &跳过= 100美元
404没有找到

这将是如果你叫一个不存在的API返回工作地点例如ID

例子

/人力资源/ v1 / associate-work-locations / <错误ID >
403年被禁止的 当凭证没有访问资源,如尝试访问助理不是到调用者´s层次结构
406不能接受的

当服务器不能产生响应匹配可接受的值的列表中定义请求的资源

例子

/人力资源/ v1 / associate-work-locations / <错误ID >

标题:

接受:图像/ png

章3
附录A:数据字典

词典提供的数据模式资源应用程序用户界面字段映射。

关联> locationID工作位置

规范的领域 标签 索尔的规则 琼规则(当地语言)
/ associateWorkLocations locationID 工作位置独特的代码

代码包括:<工作位置类型> - <代码>元素

例子:分公司1

001年公司——> locationID:国研- 001 - 1

示例2:服务接收器00188bet金宝搏app1 - - > locationID:托马- 001

脏污formado运动:

<蒂波德当地de trabalho > - <脏污做elemento > Exemplo: Estabelecimento 001 senior - - > locationID:国研- 001 - 1

托马Exemplo 2: Tomador 001 - - > locationID: - 001

助理工作地点>名称代码

规范的领域 标签 索尔的规则 琼规则(当地语言)

/ associateWorkLocations nameCode

/ associateWorkLocations / nameCode /代码

 工作位置的代码 分支代码或服务接收器上注册专家188bet金宝搏app 脏污做estabelecimento ou tomador科莫registrado没有专家
/ associateWorkLocations / nameCode /的名字 工作地点的名字 分支机构或服务接收方188bet金宝搏app的名字 省做estabelecimento ou tomador

助理工作地点>地址

规范的领域 标签 索尔的规则 琼规则(当地语言)

/ associateWorkLocations /地址

/ associateWorkLocations /地址/ lineOne

/ associateWorkLocations /地址/ lineTwo

/ associateWorkLocations /地址/ lineThree

/ associateWorkLocations /地址/ cityName

/ associateWorkLocations /地址/ subdivisionCode

/ associateWorkLocations /地址/ subdivisionCode /代码

/ associateWorkLocations /地址/ subdivisionCode /的名字

/ associateWorkLocations /地址/ subdivisionCode / subdivisionType

/ associateWorkLocations /地址/ countryCode

/ associateWorkLocations /地址/ postalCode

/ associateWorkLocations /地址/ buildingNumber

/ associateWorkLocations /地址/ blockName

/ associateWorkLocations /地址/ streetName

/ associateWorkLocations /地址/ streetTypeCode

/ associateWorkLocations /地址/ streetTypeCode /的名字

/ associateWorkLocations /地址/单位

 工作地点的地址 分支机构或服务接收方188bet金宝搏app地址 Endereco estabelecimento ou tomador

助理工作地点>沟通

规范的领域 标签 索尔的规则 琼规则(当地语言)

/ associateWorkLocations /沟通

/ associateWorkLocations /沟通/固定电话

/ associateWorkLocations /沟通/固定电话/ areaDialing

/ associateWorkLocations /沟通/固定电话/ dialNumber

/ associateWorkLocations /沟通/固定电话/ formattedNumber

 位置的电话号码 分支机构或服务接收器188bet金宝搏app与DDD电话号码 期de telefone做estabelecimento ou tomador com DDD。

/ associateWorkLocations /通信/电子邮件

/ associateWorkLocations /通信/电子邮件/ emailUri

 位置的联系邮件 分支机构或服务接收方188bet金宝搏app的电子邮件 电子邮件做estabelecimento ou tomador

/ associateWorkLocations /沟通/传真

/ associateWorkLocations /沟通/传真/ areaDialing

/ associateWorkLocations /沟通/传真/ dialNumber

/ associateWorkLocations /沟通/传真/ formattedNumber

 位置的传真号 分支机构或服务接收器188bet金宝搏app与DDD的传真号码 的传真做estabelecimento ou tomador com DDD。

关联> effectiveDateTime工作位置

规范的领域 标签 索尔的规则 琼规则(当地语言)
/ associateWorkLocations effectiveDateTime 位置的创建日期 分支机构或服务接收器188bet金宝搏app包括日期 数据de inclusao estabelecimento ou tomador

章4
附录B:已知的限制

  • 如果没有命令美元上和美元跳过,只有第一个将返回100件。
  • 的命令美元的过滤器只有以下字段:
    • / associateWorkLocations locationID
    • / associateWorkLocations / nameCode /的名字

工作地点API指南ADP专家巴西188bet金宝搏app

最后更新:2023年1月11日,
总结提供信息的工作位置API专家巴西琼,描述的API检索表的位置信息,对于这个客户端注册所有的位置。
下载指南。下载
章1
关于这个API
章2
用例:检索工作地点信息
章3
附录A:数据字典
章4
附录B:已知的限制
188bet金宝搏appADP市场
关于市场
应用程序
合作伙伴
开发人员
对ADP188bet金宝搏app
API参考
学习
关键概念
的文章
常见问题
构建
集成的解决方案
API浏览器
开发库
指南
支持
状态
帮助中心
188bet金宝搏appADP和ADP的标志是ADP的注册商标,公司所有其他标志是他们的各自的主人的财产。
版权©2023年188bet金宝搏appADP公司。
条款 | 隐私