TeamWherx

TeamWherx（TW）是一个一体式服务管理平台，可帮助你更有效地管理远程员工团队和远离办公室的常规业务运营。作为基于云的解决方案，TW 支持远程数据收集，并通过其 Web 应用仪表板显示它，为经理提供额外的见解，以创建更智能的策略，以提高效率、工作效率和降低成本，同时协调移动员工。

此连接器在以下产品和区域中可用：

服务	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有逻辑应用区域： - Azure 政府区域 - Azure 中国区域 - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）

联系人
Name	Actsoft 支持
URL	https://www.actsoft.com/self-help-wizards
Email	support@actsoft.com

连接器元数据
发布者	Actsoft
网站	https://actsoft.com
隐私策略	https://www.actsoft.com/privacy
类别	生产力

连接器说明：

TeamWherx 允许你创建和捕获数字表单信息、员工守时信息以及使用调度系统管理工作订单。

详细说明

TeamWherx 连接器使用户能够在多个平台之间连接和交换信息。可以对数据进行动画处理，以创建进程流、驱动其他内部应用程序，以及通知强大的分析。通过访问 up-to（即时刻可作的数据）自动执行和简化每日、每周或每月流程。

## 先决条件

若要使用此连接器，需要满足以下条件：

TeamWherx 帐户
TeamWherx API 密钥
Microsoft Power Apps 或 Power Automate 计划

## 如何获取凭据

API 开发人员门户

若要访问连接器，必须先为 API 开发人员门户设置用户名和密码，然后订阅客户 API：

从应用程序内部转到 “管理>设置>API设置”。
选择 “创建凭据”。
在相应的字段中输入名字和姓氏。
在“电子邮件地址”字段中输入电子邮件地址。
选择 “保存”和“电子邮件邀请”。然后，检查电子邮件，获取有关创建密码的说明。
进入邀请电子邮件后，单击“ 选择密码”，这将打开一个对话框，允许你创建密码。
选择 “保存密码”。
若要转到开发人员门户，请从应用程序内部转到 “管理>设置>”转到开发人员门户。
在开发人员门户中，选择 “产品”，然后选择“ 客户API”。
选择 “订阅”。

API 密钥

现在，你已为你生成了一个已注册的 API 用户，即名为密钥的字母数字序列。需要使用此密钥来处理 API 中的数据。

若要查找 API 密钥，请执行以下作：

从“开发人员门户”菜单中选择 “产品 ”。许可证中提供的 API 产品将显示。
选择“你拥有此产品的 X 订阅”下的 “客户 API 版本”。
选择订阅的主密钥旁边的 “显示 ”。
选择字段的内容，右键单击并选择“ 复制”。密钥现已保存到剪贴板，并已准备好粘贴。

## 连接器入门

转到 “我的流>”新建流，然后选择 “自动化云流”。
从“生成自动化云流”对话框中 选择“手动触发流 ”。
为流命名，或让系统自动生成一个流。
搜索并选择流的触发器。
选择“创建”。
在搜索字段中，搜索并选择 TeamWherx 连接器。
查找要与连接器一起执行的作。

系统将提示你登录到执行所选作所需的所有应用，并跳过已登录的任何应用。

在“连接器”字段中输入新连接器的名称。
然后，输入 API 密钥。
选择“创建”。流程中的第一步显示为流程图中的第一个“box”。
选择 “新建”步骤 ，继续向连接器进程流添加更多作和步骤。
选择“保存”。

**使用连接器 - 订单状态轮询示例
** 以下说明演示如何创建流程流以在工作表中插入行，以及如何插入标识在更新订单状态时更新订单的员工的数据。

转到 连接器。
搜索并选择 [TeamWherx] 连接器。
从作列表选择 “订单”状态轮询 。
在 “连接名称 ”字段中输入新连接的名称。
然后，输入 API 密钥。
选择“创建”。流程中的第一步显示为流程图中的第一个“box”。

连接流步骤中的每个作对话框都将具有属性字段，你可以自定义这些字段来控制执行的作。

继续示例，选择是否希望 Forms 字段值显示（excludeFormData 参数）。
选择连接的 X-API 版本。
选择 “下一步 ”设置在订单状态更改时要执行的作。
在 “选择作 ”对话框中，使用搜索字段查找应用程序，然后选择所需的作。例如，如果要每次更改订单状态时在 Google 工作表中插入一行，可以选择 GoogleSheets，然后插入该作的行。
在后面的 “插入行 ”对话框中，单击“ 文件 ”字段，然后选择将包含结果的文件。
在 “工作表” 字段中，选择数据工作表类型。动态显示的字段是工作表中的数据列。
单击每个列的字段中，并从 “订单状态轮询 属性”列表中选择一个属性。或者，可以使用搜索字段查找特定属性。
可以在每个列字段中输入多个属性;在“事件”列中，选择 StatusLabel，插入短划线，然后选择 StatusStartDate。这意味着，对于每个订单状态更新，“状态标签”和“状态开始日期”将写入新行中的“事件”列。
选择 “新建”步骤。请注意，始终可以悬停并单击箭头连接器以插入新步骤
在“选择作”对话框中，再次选择 TeamWherx 连接器，然后 为作创建客户端 。

同样，对话框中显示的每个字段都将表示 Google Sheets 电子表格中的一列。单击每个字段以激活 订单状态轮询 属性列表，然后选择所需的属性。

对于此示例，请选择“名称”字段的 EmployeeNumber，以标识更新订单状态的员工。
选择 GroupName 并将其插入“ 名称” 字段。
选择“保存”。

现在，你已创建了一个流程流，该流程将在每次更新订单状态时使用员工编号及其关联组更新电子表格。

## 已知问题和限制

所有终结点的音频文件二进制上传（POST）仅限于 MP4。
必须根据RFC3339准则指定所有需要日期时间信息的终结点的日期，如以下示例所示：2021-09-22T02：36：56.52Z。不需要在时间戳中指定确切的秒数;00 是可接受的。

## 常见错误和补救措施

可以在 API 开发人员门户找到可能出现的常见错误示例、响应代码和更正：

曲- https://developer.wfmplatform.com/

## 常见问题解答

正在创建连接

连接器支持以下身份验证类型：


默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name	类型	Description	必选
API 密钥	securestring	此 API 的 API 密钥	True

限制

名称	调用	续订期
每个连接的 API 调用数	100	60 秒

操作

上传二进制文件	使用此选项上传表单图像和音频文件。二进制大小限制为 10MB。支持的文件类型包括：JPEG、PNG 和 MP4。
上传附件文件	使用此选项上传表单文件附件。二进制大小限制为 25MB。包含单个文件的预期多部分/表单数据请求。
从自定义列表中获取单个记录	检索 CustomListId 找到的单个自定义列表数据记录和唯一列值。错误： 404 - 没有提供的 customListId 和唯一列值的自定义列表记录
停用用户	按其 ID 停用现有用户。
停用车辆	按 ID 停用车辆。
创建地理围栏	创建新的地理围栏。
创建客户端	创建新的客户端。
创建或更新自定义事件定义	创建或更新自定义事件定义。
创建或更新自定义列表记录	创建或更新自定义列表数据记录。可以省略唯一列的值，但如果存在，它应与查询参数中的唯一 ID 值匹配。
创建用户	创建新用户。
创建表单	添加新窗体。
创建订单	添加新订单。
创建车辆	创建车辆。
删除地理围栏	按 ID 删除现有地理围栏。
删除客户端	按其 ID 删除现有客户端。
删除自定义事件定义	删除自定义事件定义。
删除自定义列表记录	按自定义列表的 customListId 和 ID 删除自定义列表中的现有记录。 id - 是自定义列表记录的唯一值。错误： 404 - 找不到 customListId 或 ID。
删除车辆	按 ID 删除车辆。
包含事件源的 Web 挂钩回调	此示例方法由事件/订阅使用客户提供的 URL 发送回事件数据馈送使用。
取消订阅 GPS 数据 Web 挂钩	按 ID 删除 GPS 数据 Web 挂钩订阅。
取消订阅事件 Web 挂钩	按 ID 删除事件 Web 挂钩订阅。
带有 GPS 数据馈送的 Webhook 回调	此示例方法由 gpsdata/subscribe 使用客户提供的 URL 发布回数据馈送。
按 CustomListID 获取自定义列表字段列表	使用 CustomListID 检索单个自定义列表的字段列表。
按 CustomListID 获取自定义列表数据	使用 CustomListID 检索单个自定义列表中的所有数据记录。结果按列排序，支持分页。错误： 404 - 没有提供的 customListId 的自定义列表。
按 ID 获取自定义事件定义	按 ID 检索单个自定义事件定义。
按 ID 获取车辆	按 ID 检索单个车辆。
提交事件	提交事件。
更新客户端	更新现有客户端。
更新现有地理围栏	按 ID 更新现有地理围栏。
更新用户	更新现有用户。
更新用户的一部分	更新用户属性的一部分。
更新订单	更新现有订单。
更新订单状态	更改现有订单状态。
更新车辆	按 ID 更新车辆。
激活用户	按其 ID 激活现有用户。
激活车辆	按 ID 激活车辆。
获取 GPS 数据条目	检索指定日期范围的 GPS 数据条目。还返回一个延续标记和一个用于获取下一个数据部分的链接。可以指定返回的页数和每个页的元素数。不会返回已删除用户/车辆的位置。但是，如果在请求数据后删除了用户/车辆，则会返回继续令牌请求的用户/车辆的数据。结果按 UtcTime 自动排序，按升序排序。排序参数不可配置。
获取事件 Web 挂钩订阅列表	检索事件 Web 挂钩订阅的列表。可以指定返回的页数和每个页的元素数。结果按 SubscriptionId 自动排序，按升序排序。排序参数不可配置。
获取事件列表	检索特定时间段的事件列表。可以指定返回的页数和每个页的元素数。按事件类型进行筛选以获取特定事件。如果员工与车辆相关联，则可以为员工返回车辆事件。
获取地理围栏	按其 ID 检索地理围栏。
获取地理围栏列表	检索地理围栏的列表。可以指定返回的页数和每个页面的元素数，以及地理围栏坐标是否为指标。结果按名称自动排序，按升序排序。排序参数不可配置。
获取客户端	按其 ID 检索客户端对象。
获取客户端列表	检索客户端列表。可以指定返回的页数和每个页的元素数。结果按名称自动排序，按升序排序。排序参数不可配置。
获取次要版本	返回 API 的当前次要版本。
获取用户	按其 ID 获取用户。
获取用户列表	检索用户列表。可以指定返回的页数和每个页的元素数。结果按 UserId 自动排序，按升序排序。排序参数不可配置。
获取窗体	按其 ID 检索窗体。
获取自定义事件定义列表	检索自定义事件定义的列表。
获取自定义列表定义	检索自定义列表定义列表。定义列表包含所有现有自定义列表的 CustomListID、名称和版本。
获取行程列表	检索特定时间段的行程列表。可以指定返回的页数和每个页的元素数。结果按 StartUtcTIme 自动排序，按升序排序。排序参数不可配置。
获取表单列表	使用下面所示的请求参数中的任何筛选器检索表单列表。可以指定返回的页数和每个页的元素数。结果按 SubmittedTime 自动排序，按降序排序。排序参数不可配置。
获取计时条目	按其 ID 检索条目。
获取计时条目列表	根据日期范围检索计时项的列表。可以指定返回的页数和每个页的元素数。结果按 ClockInTime 自动排序，然后按 TimekeepingStatusId 和升序排序。排序参数不可配置。
获取订单	按 ID 获取现有订单。
获取订单列表	使用如下所示的请求参数中的筛选器检索订单列表。可以指定返回的页数和每个页的元素数。结果按 Client.Name 自动排序，按升序排序。排序参数不可配置。
获取订阅列表	检索 Web 挂钩订阅的列表。可以指定返回的页数和每个页的元素数。结果按 SubscriptionId 自动排序，按升序排序。排序参数不可配置。
获取车辆列表	检索车辆列表。
订阅 GPS 数据 Web 挂钩	添加新的 GPS 跟踪数据（GPS 位置）Web 挂钩。 Web 挂钩允许你接收在指定 URL 上发生的 GPS 位置。
订阅事件 Web 挂钩	添加新事件 Web 挂钩订阅。 Web 挂钩允许你接收针对指定 URL 上发生的公司事件的自动通知。
部分更新车辆	部分按 ID 更新车辆。
重置事件 Web 挂钩订阅状态	将订阅状态更改为状态 = 1（“正在运行”）。
重置订阅状态	将订阅状态更改为状态 = 1（“正在运行”）。

上传二进制文件

操作 ID:: BinaryController_UploadBinary

使用此选项上传表单图像和音频文件。二进制大小限制为 10MB。支持的文件类型包括：JPEG、PNG 和 MP4。

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

上传附件文件

操作 ID:: BinaryController_UploadAttachment

使用此选项上传表单文件附件。二进制大小限制为 25MB。包含单个文件的预期多部分/表单数据请求。

Body: CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

从自定义列表中获取单个记录

操作 ID:: CustomListController_GetSingleRecord

检索 CustomListId 找到的单个自定义列表数据记录和唯一列值。

错误：

404 - 没有提供的 customListId 和唯一列值的自定义列表记录

参数

名称	密钥	必需	类型	说明
customListId	customListId	True	integer	自定义列表 ID。
id	id	True	string	唯一值。

自定义列表列数据数组的容器。

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

停用用户

操作 ID:: UserController_Deactivate

按其 ID 停用现有用户。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

停用车辆

操作 ID:: VehicleController_Deactivate

按 ID 停用车辆。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

response: integer

创建地理围栏

操作 ID:: GeofenceController_CreateGeofence

创建新的地理围栏。

参数

名称	密钥	类型	说明
GroupNames	GroupNames	array of string	GeofenceCreateApiModel 的 GroupPaths。
Latitude	Latitude	double
Longitude	Longitude	double
Name	Name	string	GeofenceApiModelBase 的名称。
类型	Type	string	GeofenceApiModel 的类型。
形状	Shape	integer	形状：0 表示圆形，1 表示多边形。
Latitude	Latitude	double
Longitude	Longitude	double
AddressLine1	AddressLine1	string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2	string	此 LocationApiModel 的 AddressLine2。
City	City	string	LocationApiModel 市。
地区名称	RegionName	string	LocationApiModel 的区域名称。
邮政编码	PostalCode	string	LocationApiModel 的邮政编码。
国家代码	CountryCode	string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName	string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode	string	LocationApiModel 的子区域代码。
RegionCode	RegionCode	string	LocationApiModel 的区域代码。
半径	Radius	double	GeofenceApiModel 的半径。
UseGeofenceAddress	UseGeofenceAddress	boolean	GeofenceApiModel 的 UseGeofenceAddress。
useMetric	useMetric	boolean	使用指标系统。
geocode	geocode	boolean	应对地址进行地理编码。

Body: CustomerAPI.Models.ReturnIdApiModel

创建客户端

操作 ID:: ClientController_Create

创建新的客户端。

参数

名称	密钥	类型	说明
ExternalId	ExternalId	string	客户端的外部使用 ID - API 扩展属性。
FieldIndex	FieldIndex	integer	字段索引。
价值	Value		字段值。
Name	Name	string	客户端的名称。
Latitude	Latitude	double
Longitude	Longitude	double
AddressLine1	AddressLine1	string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2	string	此 LocationApiModel 的 AddressLine2。
City	City	string	LocationApiModel 市。
地区名称	RegionName	string	LocationApiModel 的区域名称。
邮政编码	PostalCode	string	LocationApiModel 的邮政编码。
国家代码	CountryCode	string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName	string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode	string	LocationApiModel 的子区域代码。
RegionCode	RegionCode	string	LocationApiModel 的区域代码。
Name	Name	string	ContactApiModel 的名称。
电话号码	PhoneNumber	string	ContactApiModel 的 PhoneNumber。
Email	Email	string	ContactApiModel 的电子邮件。
geocode	geocode	boolean	应对地址进行地理编码。

Body: CustomerAPI.Models.ReturnIdApiModel

创建或更新自定义事件定义

操作 ID:: EventController_Put

创建或更新自定义事件定义。

参数

名称	密钥	必需	类型	说明
id	id	True	string	事件定义 ID。
Name	Name		string
ReverseGeocode	ReverseGeocode		boolean
Name	Name		string
类型	Type		integer
标题	Caption		string
必选	Required		boolean

创建或更新自定义列表记录

操作 ID:: CustomListController_PutRecord

创建或更新自定义列表数据记录。可以省略唯一列的值，但如果存在，它应与查询参数中的唯一 ID 值匹配。

参数

名称	密钥	必需	类型	说明
customListId	customListId	True	integer	自定义列表 ID。
id	id	True	string	唯一值。
ColumnIndex	ColumnIndex		integer	自定义列表列索引。
标题	Caption		string	自定义列表列标题。
价值	Value			自定义列表列值。

创建用户

操作 ID:: UserController_Create

创建新用户。

参数

名称	密钥	类型	说明
UserName	UserName	string	用户的用户名。
密码	Password	password	用户的密码。
GroupName	GroupName	string	用户组的名称。
名字	FirstName	string	用户的名字。
姓	LastName	string	用户的姓氏。
员工编号	EmployeeNumber	string	用户的员工编号。
Email	Email	string	用户的电子邮件地址。
电话	Phone	string	用户的电话号码。
RoleId	RoleId	integer	用户的 RoleId - （管理员：1、用户：3、Power User： 5）。
IsActive	IsActive	boolean	用户的活动状态。
EPTTEnabled	EPTTEnabled	boolean	用户增强的“推送到通话”功能的状态：布尔值。
EPTTNumber	EPTTNumber	string	用户增强的“推送到通话”功能的电话号码：字符串。
EPTTWebMDN	EPTTWebMDN	string	用于向 Kodiak EPTT 系统验证用户的电话号码 - 由 Kodiak 提供。
EPTTToken	EPTTToken	string	用于向 Kodiak EPTT 系统对用户进行身份验证的 API 令牌 - 由 Kodiak 提供。
GPSEnabled	GPSEnabled	boolean	用户的 GPS 功能的状态。
MobileOnly	MobileOnly	boolean	CAB 桌面 Web 应用程序访问的状态 - （无 WebApp 访问：True，完整应用访问：False）。
LicenseType	LicenseType	integer	分配给用户的许可证类型： - 0 表示未定义，1 表示常规，2 表示 WebOnly，3 表示员工。

Body: CustomerAPI.Models.ReturnIdApiModel

创建表单

操作 ID:: FormController_PostFormAsync

添加新窗体。

参数

名称	密钥	必需	类型	说明
ApiModuleId	ApiModuleId		string	与此 CreateStandaloneFormApiModel 关联的 ApiModule 的 ID。
检讨	Reviewed		boolean	此 CreateStandaloneFormApiModel 的评审状态。
UserId	UserId		integer	UserId。
员工编号	EmployeeNumber		string	用户的员工编号。
SubmittedTime	SubmittedTime	True	date-time	提交 CreateStandaloneFormApiModel 的时间点。
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2		string	此 LocationApiModel 的 AddressLine2。
City	City		string	LocationApiModel 市。
地区名称	RegionName		string	LocationApiModel 的区域名称。
邮政编码	PostalCode		string	LocationApiModel 的邮政编码。
国家代码	CountryCode		string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName		string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode		string	LocationApiModel 的子区域代码。
RegionCode	RegionCode		string	LocationApiModel 的区域代码。
ApiFieldId	ApiFieldId	True	string	API 字段 ID。
价值	Value	True		FormFieldDataApiModel 的值。 “NFC”字段值格式： { “Type”： number， // 0 - Text “Payload”： object， // Should be text for Type = 0 } “Camera”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传图像的二进制 ID （请参阅上传二进制 API） “注意”：字符串 // 引用图像的注释 } “Sign”字段值格式（二进制参考）： { “BinaryId”：字符串 // 上传图像的二进制 ID （请参阅上传二进制 API） } “Audio”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传的音频的二进制 ID （请参阅上传二进制 API） “DurationSeconds”： number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	捕获二进制数据的时间。格式 - 日期时间（以RFC3339为单位的日期时间），包括偏移量。
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2		string	此 LocationApiModel 的 AddressLine2。
City	City		string	LocationApiModel 市。
地区名称	RegionName		string	LocationApiModel 的区域名称。
邮政编码	PostalCode		string	LocationApiModel 的邮政编码。
国家代码	CountryCode		string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName		string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode		string	LocationApiModel 的子区域代码。
RegionCode	RegionCode		string	LocationApiModel 的区域代码。
ApiFieldId	ApiFieldId	True	string	API 字段 ID。
价值	Value	True		FormFieldDataApiModel 的值。 “NFC”字段值格式： { “Type”： number， // 0 - Text “Payload”： object， // Should be text for Type = 0 } “Camera”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传图像的二进制 ID （请参阅上传二进制 API） “注意”：字符串 // 引用图像的注释 } “Sign”字段值格式（二进制参考）： { “BinaryId”：字符串 // 上传图像的二进制 ID （请参阅上传二进制 API） } “Audio”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传的音频的二进制 ID （请参阅上传二进制 API） “DurationSeconds”： number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	捕获二进制数据的时间。格式 - 日期时间（以RFC3339为单位的日期时间），包括偏移量。

Body: CustomerAPI.Models.ReturnIdApiModel

创建订单

操作 ID:: OrderController_Create

添加新订单。

参数

名称	密钥	必需	类型	说明
CreatedDateTime	CreatedDateTime		date-time	创建 CreateUpdateOrderApiModel 的时间点。
ExternalClientId	ExternalClientId	True	string	客户端的外部使用 ID - API 扩展属性。
ServiceType	ServiceType	True	string	与此 CreateUpdateOrderApiModel 关联的服务类型。
ExternalOrderId	ExternalOrderId		string	客户端的外部 Use OrderId - API 扩展属性。
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2		string	此 LocationApiModel 的 AddressLine2。
City	City		string	LocationApiModel 市。
地区名称	RegionName		string	LocationApiModel 的区域名称。
邮政编码	PostalCode		string	LocationApiModel 的邮政编码。
国家代码	CountryCode		string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName		string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode		string	LocationApiModel 的子区域代码。
RegionCode	RegionCode		string	LocationApiModel 的区域代码。
Name	Name		string	ContactApiModel 的名称。
电话号码	PhoneNumber		string	ContactApiModel 的 PhoneNumber。
Email	Email		string	ContactApiModel 的电子邮件。
截止日期	DueDate		date-time	此 BaseUpdateOrderApiModel 的完成时间点（在 v1.3 中已过时）。
StartTime	StartTime		date-time	此 BaseUpdateOrderApiModel 应启动的时间点（在 v1.3 中引入）。
EndTime	EndTime		date-time	此 BaseUpdateOrderApiModel 应结束的时间点（在 v1.3 中引入）。
标题	Caption	True	string
价值	Value			UpdateFormFieldApiModel 的值。 “NFC”字段值格式： { “Type”： number， // 0 - Text “Payload”： object， // Should be text for Type = 0 } “Camera”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传图像的二进制 ID （请参阅上传二进制 API） “注意”：字符串 // 引用图像的注释 } “Signature”字段值格式（二进制引用）： { “BinaryId”：字符串 // 上传图像的二进制 ID （请参阅上传二进制 API） } “Audio”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传的音频的二进制 ID （请参阅上传二进制 API） “DurationSeconds”： number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	捕获了时间点值。
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2		string	此 LocationApiModel 的 AddressLine2。
City	City		string	LocationApiModel 市。
地区名称	RegionName		string	LocationApiModel 的区域名称。
邮政编码	PostalCode		string	LocationApiModel 的邮政编码。
国家代码	CountryCode		string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName		string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode		string	LocationApiModel 的子区域代码。
RegionCode	RegionCode		string	LocationApiModel 的区域代码。
标题	Caption	True	string
价值	Value			UpdateFormFieldApiModel 的值。 “NFC”字段值格式： { “Type”： number， // 0 - Text “Payload”： object， // Should be text for Type = 0 } “Camera”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传图像的二进制 ID （请参阅上传二进制 API） “注意”：字符串 // 引用图像的注释 } “Signature”字段值格式（二进制引用）： { “BinaryId”：字符串 // 上传图像的二进制 ID （请参阅上传二进制 API） } “Audio”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传的音频的二进制 ID （请参阅上传二进制 API） “DurationSeconds”： number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	捕获了时间点值。
员工编号	EmployeeNumber	True	string	创建此 NewOrderStatusApiModel 的用户的 EmployeeNumber。
StatusLabel	StatusLabel	True	string	与此 NewOrderStatusApiModel 关联的 StatusLabel 的标签内容。
StatusStartDateTime	StatusStartDateTime	True	date-time	启动此 NewOrderStatusApiModel 状态的时间点。
标题	Caption	True	string
价值	Value			UpdateFormFieldApiModel 的值。 “NFC”字段值格式： { “Type”： number， // 0 - Text “Payload”： object， // Should be text for Type = 0 } “Camera”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传图像的二进制 ID （请参阅上传二进制 API） “注意”：字符串 // 引用图像的注释 } “Signature”字段值格式（二进制引用）： { “BinaryId”：字符串 // 上传图像的二进制 ID （请参阅上传二进制 API） } “Audio”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传的音频的二进制 ID （请参阅上传二进制 API） “DurationSeconds”： number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	捕获了时间点值。
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2		string	此 LocationApiModel 的 AddressLine2。
City	City		string	LocationApiModel 市。
地区名称	RegionName		string	LocationApiModel 的区域名称。
邮政编码	PostalCode		string	LocationApiModel 的邮政编码。
国家代码	CountryCode		string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName		string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode		string	LocationApiModel 的子区域代码。
RegionCode	RegionCode		string	LocationApiModel 的区域代码。
标题	Caption	True	string
价值	Value			UpdateFormFieldApiModel 的值。 “NFC”字段值格式： { “Type”： number， // 0 - Text “Payload”： object， // Should be text for Type = 0 } “Camera”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传图像的二进制 ID （请参阅上传二进制 API） “注意”：字符串 // 引用图像的注释 } “Signature”字段值格式（二进制引用）： { “BinaryId”：字符串 // 上传图像的二进制 ID （请参阅上传二进制 API） } “Audio”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传的音频的二进制 ID （请参阅上传二进制 API） “DurationSeconds”： number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	捕获了时间点值。
FieldIndex	FieldIndex		integer	字段索引。
价值	Value			字段值。
geocode	geocode		boolean	应对地址进行地理编码。

Body: CustomerAPI.Models.ReturnIdApiModel

创建车辆

操作 ID:: VehicleController_CreateVehicle

创建车辆。

参数

名称	密钥	类型
编号	Number	string
Name	Name	string
类型	Type	string
标记	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
做	Make	string
年份	Year	integer
型号	Model	string
颜色	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
设备类型	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

Body: CustomerAPI.Models.ReturnIdApiModel

删除地理围栏

操作 ID:: GeofenceController_DeleteGeofence

按 ID 删除现有地理围栏。

参数

名称	密钥	必需	类型	说明
id	id	True	integer	地理围栏 ID。

删除客户端

操作 ID:: ClientController_Delete

按其 ID 删除现有客户端。

参数

名称	密钥	必需	类型	说明
id	id	True	string	客户端 ID。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

删除自定义事件定义

操作 ID:: EventController_Delete

删除自定义事件定义。

参数

名称	密钥	必需	类型	说明
id	id	True	string	事件定义 ID。

删除自定义列表记录

操作 ID:: CustomListController_DeleteRecord

按自定义列表的 customListId 和 ID 删除自定义列表中的现有记录。

id - 是自定义列表记录的唯一值。

错误：

404 - 找不到 customListId 或 ID。

参数

名称	密钥	必需	类型	说明
customListId	customListId	True	integer	自定义列表 ID。
id	id	True	string	唯一值。

删除车辆

操作 ID:: VehicleController_Delete

按 ID 删除车辆。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

包含事件源的 Web 挂钩回调

操作 ID:: EventController_subscribe_callback

此示例方法由事件/订阅使用客户提供的 URL 发送回事件数据馈送使用。

参数

名称	密钥	类型	说明
Id	Id	string	包含 WebHookSubscriptionParamsApiModel 地址的 URL。
事件类型	EventType	integer
EventCode	EventCode	string
EventTime	EventTime	date-time	具有本地和偏移量的 ISO 格式。
DeviceId	DeviceId	string	与订阅关联的 GpsDeviceDto Id。
设备类型	DeviceType	integer	GpsDeviceDto 类型：手机（0）、卡隆普（1）、地理表（2）、西戈（3）。
UserId	UserId	integer	用户 ID。
VehicleId	VehicleId	integer	车辆 ID。
UserLinkedToVehicle	UserLinkedToVehicle	boolean	用户是否链接到车辆。
Lat	Lat	double	纬度。
离子	Lon	double	经度。
CustomEventDefinitionId	CustomEventDefinitionId	string
EventParams	EventParams	object	事件参数。

response: object

取消订阅 GPS 数据 Web 挂钩

操作 ID:: TrackingController_RemoveGpsDataFeedSubscription

按 ID 删除 GPS 数据 Web 挂钩订阅。

参数

名称	密钥	必需	类型	说明
订阅编号	subscriptionId	True	string	要删除的订阅 ID。

取消订阅事件 Web 挂钩

操作 ID:: EventController_RemoveEventDataFeedSubscription

按 ID 删除事件 Web 挂钩订阅。

参数

名称	密钥	必需	类型	说明
订阅编号	subscriptionId	True	string	要删除的订阅 ID。

带有 GPS 数据馈送的 Webhook 回调

操作 ID:: TrackingController_subscribe_callback

此示例方法由 gpsdata/subscribe 使用客户提供的 URL 发布回数据馈送。

参数

名称	密钥	类型	说明
Id	Id	string	包含 WebHookSubscriptionParamsApiModel 地址的 URL。
DeviceId	DeviceId	string	与订阅关联的 GpsDeviceDto Id。
设备类型	DeviceType	integer	GpsDeviceDto 类型：手机（0）、卡坎（1）、地理表（2）、西戈（3）。
时间戳	Timestamp	date-time	具有本地和偏移量的 ISO 格式。
CompanyId	CompanyId	integer	公司 ID。
UserId	UserId	integer	用户 ID。
VehicleId	VehicleId	integer	车辆 ID。
UserLinkedToVehicle	UserLinkedToVehicle	boolean	用户是否链接到车辆。
LocationProvider	LocationProvider	string	位置提供程序名称。
Lat	Lat	double	纬度。
离子	Lon	double	经度。
AccuracyFt	AccuracyFt	double	位置准确性（脚）。
AltitudeFt	AltitudeFt	double	海拔高度（英尺）。
Heading	Heading	integer	以度为单位的指南针方向。
SpeedMph	SpeedMph	double	运动速度（Mph）。
BatteryStatus	BatteryStatus	integer	电池状态：未充电（0）、充电（1）。
BatteryLevel	BatteryLevel	integer	电池电量百分比。
ActivityState	ActivityState	integer	活动状态：保持（1）、模式（2）。
IsNetworkConnected	IsNetworkConnected	boolean	设备目前是否连接到网络。
Rssi	Rssi	integer	收到的信号强度指示器。
DOdoMl	DOdoMl	double	GpsDeviceDto Odometer （英里）。
VOdoMl	VOdoMl	double	车辆里程表（英里）。

response: object

按 CustomListID 获取自定义列表字段列表

操作 ID:: CustomListController_GetById

使用 CustomListID 检索单个自定义列表的字段列表。

参数

名称	密钥	必需	类型	说明
customListId	customListId	True	integer	自定义列表 ID。

自定义列表模型。

Body: CustomerAPI.Models.CustomLists.CustomListApiModel

按 CustomListID 获取自定义列表数据

操作 ID:: CustomListController_GetCustomList

使用 CustomListID 检索单个自定义列表中的所有数据记录。

结果按列排序，支持分页。

错误：

404 - 没有提供的 customListId 的自定义列表。

参数

名称	密钥	必需	类型	说明
customListId	customListId	True	integer	自定义列表 ID。
pageNumber	pageNumber		integer	起始页码。
pageSize	pageSize		integer	页面大小。

自定义列表列数据数组的容器。

Body: CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

按 ID 获取自定义事件定义

操作 ID:: EventController_Get

按 ID 检索单个自定义事件定义。

参数

名称	密钥	必需	类型	说明
id	id	True	string	事件定义 ID。

自定义事件定义模型。

Body: CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

按 ID 获取车辆

操作 ID:: VehicleController_GetVehicle

按 ID 检索单个车辆。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

车辆数据模型。

Body: CustomerAPI.Models.Vehicles.VehicleReadApi

提交事件

操作 ID:: EventController_Post

提交事件。

参数

名称	密钥	类型	说明
EventDefinitionId	EventDefinitionId	string	事件定义 ID。
员工编号	EmployeeNumber	string	员工编号。
VehicleNumber	VehicleNumber	string	车辆编号。
DeviceSerialNumber	DeviceSerialNumber	string	GpsDeviceDto 序列号。
Latitude	Latitude	double
Longitude	Longitude	double
AddressLine1	AddressLine1	string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2	string	此 LocationApiModel 的 AddressLine2。
City	City	string	LocationApiModel 市。
地区名称	RegionName	string	LocationApiModel 的区域名称。
邮政编码	PostalCode	string	LocationApiModel 的邮政编码。
国家代码	CountryCode	string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName	string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode	string	LocationApiModel 的子区域代码。
RegionCode	RegionCode	string	LocationApiModel 的区域代码。
Time	Time	date-time
参数	Parameters	object	事件参数。

更新客户端

操作 ID:: ClientController_Update

更新现有客户端。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
ExternalId	ExternalId		string	客户端的外部使用 ID - API 扩展属性。
FieldIndex	FieldIndex		integer	字段索引。
价值	Value			字段值。
Name	Name		string	客户端的名称。
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2		string	此 LocationApiModel 的 AddressLine2。
City	City		string	LocationApiModel 市。
地区名称	RegionName		string	LocationApiModel 的区域名称。
邮政编码	PostalCode		string	LocationApiModel 的邮政编码。
国家代码	CountryCode		string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName		string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode		string	LocationApiModel 的子区域代码。
RegionCode	RegionCode		string	LocationApiModel 的区域代码。
Name	Name		string	ContactApiModel 的名称。
电话号码	PhoneNumber		string	ContactApiModel 的 PhoneNumber。
Email	Email		string	ContactApiModel 的电子邮件。
geocode	geocode		boolean	应对地址进行地理编码。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

Body: CustomerAPI.Models.ReturnIdApiModel

更新现有地理围栏

操作 ID:: GeofenceController_UpdateGeofence

按 ID 更新现有地理围栏。

参数

名称	密钥	必需	类型	说明
id	id	True	integer	地理围栏 ID。
GroupNames	GroupNames		array of string	GeofenceUpdateApiModel 的 GroupPaths。
Latitude	Latitude		double
Longitude	Longitude		double
Name	Name		string	GeofenceApiModelBase 的名称。
类型	Type		string	GeofenceApiModel 的类型。
形状	Shape		integer	形状：0 表示圆形，1 表示多边形。
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2		string	此 LocationApiModel 的 AddressLine2。
City	City		string	LocationApiModel 市。
地区名称	RegionName		string	LocationApiModel 的区域名称。
邮政编码	PostalCode		string	LocationApiModel 的邮政编码。
国家代码	CountryCode		string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName		string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode		string	LocationApiModel 的子区域代码。
RegionCode	RegionCode		string	LocationApiModel 的区域代码。
半径	Radius		double	GeofenceApiModel 的半径。
UseGeofenceAddress	UseGeofenceAddress		boolean	GeofenceApiModel 的 UseGeofenceAddress。
useMetric	useMetric		boolean	使用指标系统。
geocode	geocode		boolean	应对地址进行地理编码。

Body: CustomerAPI.Models.ReturnIdApiModel

更新用户

操作 ID:: UserController_Update

更新现有用户。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
UserName	UserName		string	用户的用户名。
密码	Password		password	用户的密码。
GroupName	GroupName		string	用户组的名称。
名字	FirstName		string	用户的名字。
姓	LastName		string	用户的姓氏。
员工编号	EmployeeNumber		string	用户的员工编号。
Email	Email		string	用户的电子邮件地址。
电话	Phone		string	用户的电话号码。
RoleId	RoleId		integer	用户的 RoleId - （管理员：1、用户：3、Power User： 5）。
IsActive	IsActive		boolean	用户的活动状态。
EPTTEnabled	EPTTEnabled		boolean	用户增强的“推送到通话”功能的状态：布尔值。
EPTTNumber	EPTTNumber		string	用户增强的“推送到通话”功能的电话号码：字符串。
EPTTWebMDN	EPTTWebMDN		string	用于向 Kodiak EPTT 系统验证用户的电话号码 - 由 Kodiak 提供。
EPTTToken	EPTTToken		string	用于向 Kodiak EPTT 系统对用户进行身份验证的 API 令牌 - 由 Kodiak 提供。
GPSEnabled	GPSEnabled		boolean	用户的 GPS 功能的状态。
MobileOnly	MobileOnly		boolean	CAB 桌面 Web 应用程序访问的状态 - （无 WebApp 访问：True，完整应用访问：False）。
LicenseType	LicenseType		integer	分配给用户的许可证类型： - 0 表示未定义，1 表示常规，2 表示 WebOnly，3 表示员工。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

Body: CustomerAPI.Models.ReturnIdApiModel

更新用户的一部分

操作 ID:: UserController_PartialUpdate

更新用户属性的一部分。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
			object
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

Body: CustomerAPI.Models.ReturnIdApiModel

更新订单

操作 ID:: OrderController_Update

更新现有订单。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
ExternalOrderId	ExternalOrderId		string	客户端的外部 Use OrderId - API 扩展属性。
IsClosed	IsClosed		boolean	显示 UpdateOrderApiModel 是否关闭的状态。
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2		string	此 LocationApiModel 的 AddressLine2。
City	City		string	LocationApiModel 市。
地区名称	RegionName		string	LocationApiModel 的区域名称。
邮政编码	PostalCode		string	LocationApiModel 的邮政编码。
国家代码	CountryCode		string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName		string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode		string	LocationApiModel 的子区域代码。
RegionCode	RegionCode		string	LocationApiModel 的区域代码。
Name	Name		string	ContactApiModel 的名称。
电话号码	PhoneNumber		string	ContactApiModel 的 PhoneNumber。
Email	Email		string	ContactApiModel 的电子邮件。
截止日期	DueDate		date-time	此 BaseUpdateOrderApiModel 的完成时间点（在 v1.3 中已过时）。
StartTime	StartTime		date-time	此 BaseUpdateOrderApiModel 应启动的时间点（在 v1.3 中引入）。
EndTime	EndTime		date-time	此 BaseUpdateOrderApiModel 应结束的时间点（在 v1.3 中引入）。
标题	Caption	True	string
价值	Value			UpdateFormFieldApiModel 的值。 “NFC”字段值格式： { “Type”： number， // 0 - Text “Payload”： object， // Should be text for Type = 0 } “Camera”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传图像的二进制 ID （请参阅上传二进制 API） “注意”：字符串 // 引用图像的注释 } “Signature”字段值格式（二进制引用）： { “BinaryId”：字符串 // 上传图像的二进制 ID （请参阅上传二进制 API） } “Audio”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传的音频的二进制 ID （请参阅上传二进制 API） “DurationSeconds”： number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	捕获了时间点值。
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2		string	此 LocationApiModel 的 AddressLine2。
City	City		string	LocationApiModel 市。
地区名称	RegionName		string	LocationApiModel 的区域名称。
邮政编码	PostalCode		string	LocationApiModel 的邮政编码。
国家代码	CountryCode		string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName		string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode		string	LocationApiModel 的子区域代码。
RegionCode	RegionCode		string	LocationApiModel 的区域代码。
标题	Caption	True	string
价值	Value			UpdateFormFieldApiModel 的值。 “NFC”字段值格式： { “Type”： number， // 0 - Text “Payload”： object， // Should be text for Type = 0 } “Camera”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传图像的二进制 ID （请参阅上传二进制 API） “注意”：字符串 // 引用图像的注释 } “Signature”字段值格式（二进制引用）： { “BinaryId”：字符串 // 上传图像的二进制 ID （请参阅上传二进制 API） } “Audio”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传的音频的二进制 ID （请参阅上传二进制 API） “DurationSeconds”： number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	捕获了时间点值。
员工编号	EmployeeNumber	True	string	创建此 NewOrderStatusApiModel 的用户的 EmployeeNumber。
StatusLabel	StatusLabel	True	string	与此 NewOrderStatusApiModel 关联的 StatusLabel 的标签内容。
StatusStartDateTime	StatusStartDateTime	True	date-time	启动此 NewOrderStatusApiModel 状态的时间点。
标题	Caption	True	string
价值	Value			UpdateFormFieldApiModel 的值。 “NFC”字段值格式： { “Type”： number， // 0 - Text “Payload”： object， // Should be text for Type = 0 } “Camera”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传图像的二进制 ID （请参阅上传二进制 API） “注意”：字符串 // 引用图像的注释 } “Signature”字段值格式（二进制引用）： { “BinaryId”：字符串 // 上传图像的二进制 ID （请参阅上传二进制 API） } “Audio”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传的音频的二进制 ID （请参阅上传二进制 API） “DurationSeconds”： number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	捕获了时间点值。
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2		string	此 LocationApiModel 的 AddressLine2。
City	City		string	LocationApiModel 市。
地区名称	RegionName		string	LocationApiModel 的区域名称。
邮政编码	PostalCode		string	LocationApiModel 的邮政编码。
国家代码	CountryCode		string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName		string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode		string	LocationApiModel 的子区域代码。
RegionCode	RegionCode		string	LocationApiModel 的区域代码。
标题	Caption	True	string
价值	Value			UpdateFormFieldApiModel 的值。 “NFC”字段值格式： { “Type”： number， // 0 - Text “Payload”： object， // Should be text for Type = 0 } “Camera”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传图像的二进制 ID （请参阅上传二进制 API） “注意”：字符串 // 引用图像的注释 } “Signature”字段值格式（二进制引用）： { “BinaryId”：字符串 // 上传图像的二进制 ID （请参阅上传二进制 API） } “Audio”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传的音频的二进制 ID （请参阅上传二进制 API） “DurationSeconds”： number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	捕获了时间点值。
FieldIndex	FieldIndex		integer	字段索引。
价值	Value			字段值。
geocode	geocode		boolean	应对地址进行地理编码。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

Body: CustomerAPI.Models.ReturnIdApiModel

更新订单状态

操作 ID:: OrderController_ChangeStatus

更改现有订单状态。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
员工编号	EmployeeNumber	True	string	创建此 NewOrderStatusApiModel 的用户的 EmployeeNumber。
StatusLabel	StatusLabel	True	string	与此 NewOrderStatusApiModel 关联的 StatusLabel 的标签内容。
StatusStartDateTime	StatusStartDateTime	True	date-time	启动此 NewOrderStatusApiModel 状态的时间点。
标题	Caption	True	string
价值	Value			UpdateFormFieldApiModel 的值。 “NFC”字段值格式： { “Type”： number， // 0 - Text “Payload”： object， // Should be text for Type = 0 } “Camera”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传图像的二进制 ID （请参阅上传二进制 API） “注意”：字符串 // 引用图像的注释 } “Signature”字段值格式（二进制引用）： { “BinaryId”：字符串 // 上传图像的二进制 ID （请参阅上传二进制 API） } “Audio”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传的音频的二进制 ID （请参阅上传二进制 API） “DurationSeconds”： number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	捕获了时间点值。
Latitude	Latitude		double
Longitude	Longitude		double
AddressLine1	AddressLine1		string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2		string	此 LocationApiModel 的 AddressLine2。
City	City		string	LocationApiModel 市。
地区名称	RegionName		string	LocationApiModel 的区域名称。
邮政编码	PostalCode		string	LocationApiModel 的邮政编码。
国家代码	CountryCode		string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName		string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode		string	LocationApiModel 的子区域代码。
RegionCode	RegionCode		string	LocationApiModel 的区域代码。
标题	Caption	True	string
价值	Value			UpdateFormFieldApiModel 的值。 “NFC”字段值格式： { “Type”： number， // 0 - Text “Payload”： object， // Should be text for Type = 0 } “Camera”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传图像的二进制 ID （请参阅上传二进制 API） “注意”：字符串 // 引用图像的注释 } “Signature”字段值格式（二进制引用）： { “BinaryId”：字符串 // 上传图像的二进制 ID （请参阅上传二进制 API） } “Audio”字段值格式（二进制参考）： { “BinaryId”：字符串， // 上传的音频的二进制 ID （请参阅上传二进制 API） “DurationSeconds”： number // Audio duration in seconds }
CapturedTime	CapturedTime		date-time	捕获了时间点值。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

Body: CustomerAPI.Models.ReturnIdApiModel

更新车辆

操作 ID:: VehicleController_UpdateVehicle

按 ID 更新车辆。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
编号	Number		string
Name	Name		string
类型	Type		string
标记	Tag		string
UserEmployeeNumber	UserEmployeeNumber		string
GroupName	GroupName		string
TimeZone	TimeZone		string
做	Make		string
年份	Year		integer
型号	Model		string
颜色	Color		string
VIN	VIN		string
IsActive	IsActive		boolean
设备类型	DeviceType		integer
DeviceSerialNumber	DeviceSerialNumber		string
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

response: integer

激活用户

操作 ID:: UserController_Activate

按其 ID 激活现有用户。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

激活车辆

操作 ID:: VehicleController_Activate

按 ID 激活车辆。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

response: integer

获取 GPS 数据条目

操作 ID:: TrackingController_GetGpsData

检索指定日期范围的 GPS 数据条目。还返回一个延续标记和一个用于获取下一个数据部分的链接。可以指定返回的页数和每个页的元素数。

不会返回已删除用户/车辆的位置。但是，如果在请求数据后删除了用户/车辆，则会返回继续令牌请求的用户/车辆的数据。

结果按 UtcTime 自动排序，按升序排序。排序参数不可配置。

参数

名称	密钥	类型	说明
fromDate	fromDate	date-time	日期范围开始。建议：请使用大日期范围（>=4 小时），而不是小型日期范围。
toDate	toDate	date-time	日期范围结束。建议：请使用大日期范围（>=4 小时），而不是小型日期范围。
员工编号	employeeNumber	string	员工编号。
vin	vin	string	车辆的 VIN 号。
useMetric	useMetric	boolean	使用指标系统。
代币	token	string	初始调用返回的延续标记，应在连续调用中使用。

Body: CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

获取事件 Web 挂钩订阅列表

操作 ID:: EventController_GetSubscriptions

检索事件 Web 挂钩订阅的列表。可以指定返回的页数和每个页的元素数。结果按 SubscriptionId 自动排序，按升序排序。排序参数不可配置。

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

获取事件列表

操作 ID:: EventController_GetEvents

检索特定时间段的事件列表。可以指定返回的页数和每个页的元素数。

按事件类型进行筛选以获取特定事件。如果员工与车辆相关联，则可以为员工返回车辆事件。

参数

名称	密钥	必需	类型	说明
fromDate	fromDate	True	date-time	日期范围开始。
toDate	toDate	True	date-time	日期范围结束。
员工编号	employeeNumber		string	员工编号。
vehicleNumber	vehicleNumber		string	车辆编号。
pageNumber	pageNumber		integer	起始页码。
pageSize	pageSize		integer	页面大小。
eventType	eventType		integer	按事件类型进行筛选。指定了员工编号： UserEvents（0） - 仅用户事件。 VehicleEvents（1） - 仅车辆事件，包括传感器事件。 ExternalEvents（2） - 仅外部事件。指定车辆号： UserEvents（0） - N/A。 VehicleEvents（1） - 仅车辆事件，包括传感器事件。 ExternalEvents（2） - 仅外部事件。既未指定员工编号，也没有指定车辆编号： UserEvents（0） - 仅用户事件。 VehicleEvents（1） - 仅车辆事件，包括传感器事件。 ExternalEvents（2） - 仅外部事件。

response: array of CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

获取地理围栏

操作 ID:: GeofenceController_GetGeofence

按其 ID 检索地理围栏。

参数

名称	密钥	必需	类型	说明
id	id	True	integer	地理围栏 ID。
useMetric	useMetric		boolean	使用指标系统。

Body: CustomerAPI.Models.Geofence.GeofenceApiModel

获取地理围栏列表

操作 ID:: GeofenceController_GetGeofences

检索地理围栏的列表。可以指定返回的页数和每个页面的元素数，以及地理围栏坐标是否为指标。结果按名称自动排序，按升序排序。排序参数不可配置。

参数

名称	密钥	类型	说明
pageNumber	pageNumber	integer	起始页码。默认值为 1。
pageSize	pageSize	integer	页面大小。默认值为 500。
useMetric	useMetric	boolean	使用指标系统。

response: array of CustomerAPI.Models.Geofence.GeofenceListItemApiModel

获取客户端

操作 ID:: ClientController_Get

按其 ID 检索客户端对象。

参数

名称	密钥	必需	类型	说明
id	id	True	string	客户端 ID。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

Body: CustomerAPI.Models.Client.ReadClientApiModel

获取客户端列表

操作 ID:: ClientController_GetClients

检索客户端列表。可以指定返回的页数和每个页的元素数。结果按名称自动排序，按升序排序。排序参数不可配置。

参数

名称	密钥	必需	类型	说明
pageNumber	pageNumber		integer	起始页码。
pageSize	pageSize		integer	页面大小。

response: array of CustomerAPI.Models.Client.ReadClientApiModel

获取次要版本

操作 ID:: VersionController_Get

返回 API 的当前次要版本。

获取用户

操作 ID:: UserController_Get

按其 ID 获取用户。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

Body: CustomerAPI.Models.User.ReadUserApiModel

获取用户列表

操作 ID:: UserController_GetUsers

检索用户列表。可以指定返回的页数和每个页的元素数。结果按 UserId 自动排序，按升序排序。排序参数不可配置。

参数

名称	密钥	必需	类型	说明
pageNumber	pageNumber		integer	起始页码。默认值为 1。
pageSize	pageSize		integer	页面大小。默认值为 500。

response: array of CustomerAPI.Models.User.ReadUserListItemApiModel

获取窗体

操作 ID:: FormController_GetFormAsync

按其 ID 检索窗体。

参数

名称	密钥	必需	类型	说明
id	id	True	integer	表单 ID。

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

获取自定义事件定义列表

操作 ID:: EventController_GetList

检索自定义事件定义的列表。

response: array of CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

获取自定义列表定义

操作 ID:: CustomListController_Get

检索自定义列表定义列表。定义列表包含所有现有自定义列表的 CustomListID、名称和版本。

response: array of CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

获取行程列表

操作 ID:: TrackingController_GetTrips

检索特定时间段的行程列表。可以指定返回的页数和每个页的元素数。结果按 StartUtcTIme 自动排序，按升序排序。排序参数不可配置。

参数

名称	密钥	必需	类型	说明
fromDate	fromDate	True	date-time	日期范围开始。建议：请使用大日期范围（>=4 小时），而不是小型日期范围。
toDate	toDate	True	date-time	日期范围结束。建议：请使用大日期范围（>=4 小时），而不是小型日期范围。
员工编号	employeeNumber		string	员工编号。
vin	vin		string	车辆的 VIN 号。
pageNumber	pageNumber		integer	起始页码。默认值为 1。
pageSize	pageSize		integer	页面大小。默认值为 1000。
useMetric	useMetric		boolean	使用指标系统。

response: array of CustomerAPI.Models.Tracking.TripApiModel

获取表单列表

操作 ID:: FormController_GetFormsAsync

使用下面所示的请求参数中的任何筛选器检索表单列表。可以指定返回的页数和每个页的元素数。结果按 SubmittedTime 自动排序，按降序排序。排序参数不可配置。

参数

名称	密钥	必需	类型	说明
submittedStartDate	submittedStartDate	True	date-time	提交的表单的开始日期。
submittedEndDate	submittedEndDate	True	date-time	提交的表单的结束日期。
apiModuleId	apiModuleId		string	表单模块 ID。
员工编号	employeeNumber		string	员工编号。
reviewed	reviewed		boolean	仅检索审阅的表单。默认值为 null。
pageNumber	pageNumber		integer	起始页码。默认值为 1。
pageSize	pageSize		integer	页面大小。默认值为 1000。

response: array of CustomerAPI.Models.Forms.StandaloneFormApiModel

获取计时条目

操作 ID:: TimekeepingController_GetTimekeepingEntryAsync

按其 ID 检索条目。

参数

名称	密钥	必需	类型	说明
id	id	True	string	记录的 ID。

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

获取计时条目列表

操作 ID:: TimekeepingController_GetTimekeepingDataList

根据日期范围检索计时项的列表。可以指定返回的页数和每个页的元素数。结果按 ClockInTime 自动排序，然后按 TimekeepingStatusId 和升序排序。排序参数不可配置。

参数

名称	密钥	必需	类型	说明
fromDate	fromDate	True	date-time	开始日期。
toDate	toDate	True	date-time	结束日期。
员工编号	employeeNumber		string	员工编号。
批准	approved		boolean	仅筛选已批准的条目。
closedOnly	closedOnly		boolean	仅筛选已关闭条目。
excludeFormData	excludeFormData		boolean	筛选排除窗体数据。
pageNumber	pageNumber		integer	起始页码（默认为 1）。
pageSize	pageSize		integer	页面大小（默认为 1000）。

response: array of CustomerAPI.Models.Timekeeping.TimekeepingApiModel

获取订单

操作 ID:: OrderController_GetOrder

按 ID 获取现有订单。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
include-status-history	include-status-history		string	如果为 true，响应将包含此订单的所有状态历史记录和表单数据。
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

Body: CustomerAPI.Models.Order.OrderApiModel

获取订单列表

操作 ID:: OrderController_GetOrders

使用如下所示的请求参数中的筛选器检索订单列表。可以指定返回的页数和每个页的元素数。结果按 Client.Name 自动排序，按升序排序。排序参数不可配置。

参数

名称	密钥	必需	类型	说明
dueDateFrom	dueDateFrom	True	date-time	按截止日期开始日期进行筛选。
dueDateTo	dueDateTo	True	date-time	按截止日期结束日期进行筛选。
员工编号	employeeNumber		string	按员工编号进行筛选。
pageNumber	pageNumber		integer	起始页码（默认为 1）。
pageSize	pageSize		integer	页面大小（默认为 500）。

response: array of CustomerAPI.Models.Order.OrderListItemApiModel

获取订阅列表

操作 ID:: TrackingController_GetSubscriptions

检索 Web 挂钩订阅的列表。可以指定返回的页数和每个页的元素数。结果按 SubscriptionId 自动排序，按升序排序。排序参数不可配置。

response: array of CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

获取车辆列表

操作 ID:: VehicleController_GetVehicles

检索车辆列表。

参数

名称	密钥	类型	说明
pageNumber	pageNumber	integer	页码。
pageSize	pageSize	integer	页中的最大项数。默认值 = 1000。最大值 = 2000。
activeOnly	activeOnly	boolean	如果为 true - 仅返回活动车辆。默认值 = false。

response: array of CustomerAPI.Models.Vehicles.VehicleReadApi

订阅 GPS 数据 Web 挂钩

操作 ID:: TrackingController_SubscribeToGpsDataFeed

添加新的 GPS 跟踪数据（GPS 位置）Web 挂钩。 Web 挂钩允许你接收在指定 URL 上发生的 GPS 位置。

参数

名称	密钥	必需	类型	说明
网址	Url		string	包含 WebHookSubscriptionParamsApiModel 地址的 URL。
SecurityToken	SecurityToken		string	与此 WebHookSubscriptionParamsApiModel 关联的安全令牌。

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

订阅事件 Web 挂钩

操作 ID:: EventController_SubscribeToEventDataFeed

添加新事件 Web 挂钩订阅。 Web 挂钩允许你接收针对指定 URL 上发生的公司事件的自动通知。

参数

名称	密钥	必需	类型	说明
网址	Url		string	包含 WebHookSubscriptionParamsApiModel 地址的 URL。
SecurityToken	SecurityToken		string	与此 WebHookSubscriptionParamsApiModel 关联的安全令牌。

Body: CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

部分更新车辆

操作 ID:: VehicleController_PartialUpdateVehicle

部分按 ID 更新车辆。

参数

名称	密钥	必需	类型	说明
id	id	True	string	外部或内部 ID 取决于 use-external-id 参数中的值。
			object
use-external-id	use-external-id		boolean	使用外部 ID 或不使用。

Body: CustomerAPI.Models.ReturnIdApiModel

重置事件 Web 挂钩订阅状态

操作 ID:: EventController_ResetSubscriptionHealthStatus

将订阅状态更改为状态 = 1（“正在运行”）。

参数

名称	密钥	必需	类型	说明
订阅编号	subscriptionId	True	integer	订阅 ID。

重置订阅状态

操作 ID:: TrackingController_ResetSubscriptionHealthStatus

将订阅状态更改为状态 = 1（“正在运行”）。

参数

名称	密钥	必需	类型	说明
订阅编号	subscriptionId	True	integer	订阅 ID。

触发器

表单数据轮询	Forms API 轮询终结点允许应用程序持续轮询和处理最近提交的独立表单。集成：此终结点旨在通过 Microsoft Flow 作为轮询触发器集成来现成。或者，可以使用任何语言开发自己的自定义集成。用法：在典型方案中，对此终结点的第一个请求不应提供任何参数。有两个（2）可能成功的响应： HTTP 响应代码 200 - 最近提交的表单记录存在;响应正文将显示表单数据。 HTTP 响应代码 202 - 不存在最近提交的记录;响应正文将为空。在这两种情况下，响应中有两个（2）重要标头：位置 - 下一个请求的 URL。 Retry-After - 下一个请求的建议时间间隔（以秒为单位）。例如，如果有要检索的数据，则 Retry-After 标头的值为 1 或 60。如果没有要检索的数据，则 Retry-After 标头的值将为 300。注意：这些只是建议的值 - 应用程序可以根据要求选择以不同的频率轮询。第一个请求后，所有后续请求都应使用最新响应的 Location 标头中提供的 URL。不要向 URL 添加更多参数，因为它已包含确保请求中缺少表单所需的必要参数。结果按 ModifiedUtc 自动排序，然后按 FormHeaderId 按升序排序。排序参数不可配置。 ModifiedUtc 定义：内部时间标记 = 最新表单数据更改的时间。
计时轮询	使用 Timekeeping API 轮询终结点，应用程序可以持续轮询和处理最近提交的计时条目。集成：此终结点旨在通过 Microsoft Flow 作为轮询触发器集成来现成。或者，可以使用任何语言开发自己的自定义集成。用法：在典型方案中，对此终结点的第一个请求不应提供任何参数。有两个（2）可能成功的响应： HTTP 响应代码 200 - 最近提交的计时记录存在;响应正文将显示计时记录数据。 HTTP 响应代码 202 - 不存在最近提交的记录;响应正文将为空。在这两种情况下，响应中有两个（2）重要标头：位置 - 下一个请求的 URL。 Retry-After - 下一个请求的建议时间间隔（以秒为单位）。例如，如果有要检索的数据，则 Retry-After 标头的值为 1 或 60。如果没有要检索的数据，则 Retry-After 标头的值将为 300。注意：这些只是建议的值 - 应用程序可以根据要求选择以不同的频率轮询。第一个请求后，所有后续请求都应使用最新响应的 Location 标头中提供的 URL。不要向 URL 添加更多参数，因为它已包含确保请求中缺少计时条目所需的参数。结果由 ModifiedUtc 自动排序，然后按 TimekeepingStatusId 排序，然后按升序排序。排序参数不可配置。 ModifiedUtc 定义：内部时间标记 = 最新保持状态更改的时间。
订单状态轮询	订单状态 API 轮询终结点允许应用程序持续轮询和处理最近对订单的更改。集成：此终结点旨在通过 Microsoft Flow 作为轮询触发器集成来现成。或者，可以使用任何语言开发自己的自定义集成。用法：在典型方案中，对此终结点的第一个请求不应提供任何参数。有两个（2）可能成功的响应： HTTP 响应代码 200 - 存在最近更改的顺序状态记录;响应正文将显示订单状态数据 HTTP 响应代码 202 - 不存在最近提交的记录;响应正文将为空。在这两种情况下，响应中有两个（2）重要标头：位置 - 下一个请求的 URL。 Retry-After - 下一个请求的建议时间间隔（以秒为单位）。例如，如果有要检索的数据，则 Retry-After 标头的值为 1 或 60。如果没有要检索的数据，则 Retry-After 标头的值将为 300。注意：这些只是建议的值 - 应用程序可以根据要求选择以不同的频率轮询。第一个请求后，所有后续请求都应使用最新响应的 Location 标头中提供的 URL。不要向 URL 添加更多参数，因为它已包含确保请求中未缺少订单状态所需的参数。结果按 ModifiedUtc 排序，然后按 StatusId 按升序排序。排序参数不可配置。 ModifiedUtc 定义：内部时间标记 = 最新订单状态数据更改的时间。
订单轮询	Orders API 轮询终结点允许应用程序持续轮询和处理对订单的最新更改。集成：此终结点旨在通过 Microsoft Flow 作为轮询触发器集成来现成。或者，可以使用任何语言开发自己的自定义集成。用法：在典型方案中，对此终结点的第一个请求不应提供任何参数。有两个（2）可能成功的响应： HTTP 响应代码 200 - 存在最近更改的订单;响应正文将显示订单数据。 HTTP 响应代码 202 - 不存在最近更改的订单;响应正文将为空。在这两种情况下，响应中有两个（2）重要标头：位置 - 下一个请求的 URL。 Retry-After - 下一个请求的建议时间间隔（以秒为单位）。例如，如果有要检索的数据，则 Retry-After 标头的值为 1 或 60。如果没有要检索的数据，则 Retry-After 标头的值将为 300。注意：这些只是建议的值 - 应用程序可以根据要求选择以不同的频率轮询。第一个请求后，所有后续请求都应使用最新响应的 Location 标头中提供的 URL。不要向 URL 添加更多参数，因为它已包含确保请求中缺少订单更改所需的必要参数。结果按 ModifiedUtc 自动排序，然后按 OrderId 按升序排序。排序参数不可配置。 ModifiedUtc 定义：内部时间标记 = 最新订单数据更改的时间。

表单数据轮询

操作 ID:: FormController_Poll

Forms API 轮询终结点允许应用程序持续轮询和处理最近提交的独立表单。

集成：

此终结点旨在通过 Microsoft Flow 作为轮询触发器集成来现成。或者，可以使用任何语言开发自己的自定义集成。

用法：

在典型方案中，对此终结点的第一个请求不应提供任何参数。有两个（2）可能成功的响应：

HTTP 响应代码 200 - 最近提交的表单记录存在;响应正文将显示表单数据。
HTTP 响应代码 202 - 不存在最近提交的记录;响应正文将为空。

在这两种情况下，响应中有两个（2）重要标头：

位置 - 下一个请求的 URL。
Retry-After - 下一个请求的建议时间间隔（以秒为单位）。例如，如果有要检索的数据，则 Retry-After 标头的值为 1 或 60。如果没有要检索的数据，则 Retry-After 标头的值将为 300。

注意：这些只是建议的值 - 应用程序可以根据要求选择以不同的频率轮询。第一个请求后，所有后续请求都应使用最新响应的 Location 标头中提供的 URL。不要向 URL 添加更多参数，因为它已包含确保请求中缺少表单所需的必要参数。

结果按 ModifiedUtc 自动排序，然后按 FormHeaderId 按升序排序。排序参数不可配置。

ModifiedUtc 定义：内部时间标记 = 最新表单数据更改的时间。

Body: CustomerAPI.Models.Forms.StandaloneFormApiModel

计时轮询

操作 ID:: TimekeepingController_Poll

使用 Timekeeping API 轮询终结点，应用程序可以持续轮询和处理最近提交的计时条目。

集成：

此终结点旨在通过 Microsoft Flow 作为轮询触发器集成来现成。或者，可以使用任何语言开发自己的自定义集成。

用法：

在典型方案中，对此终结点的第一个请求不应提供任何参数。有两个（2）可能成功的响应：

HTTP 响应代码 200 - 最近提交的计时记录存在;响应正文将显示计时记录数据。
HTTP 响应代码 202 - 不存在最近提交的记录;响应正文将为空。

在这两种情况下，响应中有两个（2）重要标头：

位置 - 下一个请求的 URL。
Retry-After - 下一个请求的建议时间间隔（以秒为单位）。例如，如果有要检索的数据，则 Retry-After 标头的值为 1 或 60。如果没有要检索的数据，则 Retry-After 标头的值将为 300。

注意：这些只是建议的值 - 应用程序可以根据要求选择以不同的频率轮询。第一个请求后，所有后续请求都应使用最新响应的 Location 标头中提供的 URL。不要向 URL 添加更多参数，因为它已包含确保请求中缺少计时条目所需的参数。

结果由 ModifiedUtc 自动排序，然后按 TimekeepingStatusId 排序，然后按升序排序。排序参数不可配置。

ModifiedUtc 定义：内部时间标记 = 最新保持状态更改的时间。

参数

名称	密钥	必需	类型	说明
excludeFormData	excludeFormData		boolean	如果为 true，则 ClockInFormData 和 ClockOutFormData 始终为 null。

Body: CustomerAPI.Models.Timekeeping.TimekeepingApiModel

订单状态轮询

操作 ID:: OrderController_StatusPoll

订单状态 API 轮询终结点允许应用程序持续轮询和处理最近对订单的更改。

集成：

此终结点旨在通过 Microsoft Flow 作为轮询触发器集成来现成。或者，可以使用任何语言开发自己的自定义集成。

用法：

在典型方案中，对此终结点的第一个请求不应提供任何参数。有两个（2）可能成功的响应：

HTTP 响应代码 200 - 存在最近更改的顺序状态记录;响应正文将显示订单状态数据
HTTP 响应代码 202 - 不存在最近提交的记录;响应正文将为空。

在这两种情况下，响应中有两个（2）重要标头：

位置 - 下一个请求的 URL。
Retry-After - 下一个请求的建议时间间隔（以秒为单位）。例如，如果有要检索的数据，则 Retry-After 标头的值为 1 或 60。如果没有要检索的数据，则 Retry-After 标头的值将为 300。

注意：这些只是建议的值 - 应用程序可以根据要求选择以不同的频率轮询。第一个请求后，所有后续请求都应使用最新响应的 Location 标头中提供的 URL。不要向 URL 添加更多参数，因为它已包含确保请求中未缺少订单状态所需的参数。

结果按 ModifiedUtc 排序，然后按 StatusId 按升序排序。排序参数不可配置。

ModifiedUtc 定义：内部时间标记 = 最新订单状态数据更改的时间。

参数

名称	密钥	必需	类型	说明
excludeFormData	excludeFormData		boolean	如果为 true，FieldValues 将始终为空数组。

Body: CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

订单轮询

操作 ID:: OrderController_Poll

Orders API 轮询终结点允许应用程序持续轮询和处理对订单的最新更改。

集成：

此终结点旨在通过 Microsoft Flow 作为轮询触发器集成来现成。或者，可以使用任何语言开发自己的自定义集成。

用法：

在典型方案中，对此终结点的第一个请求不应提供任何参数。有两个（2）可能成功的响应：

HTTP 响应代码 200 - 存在最近更改的订单;响应正文将显示订单数据。
HTTP 响应代码 202 - 不存在最近更改的订单;响应正文将为空。

在这两种情况下，响应中有两个（2）重要标头：

位置 - 下一个请求的 URL。
Retry-After - 下一个请求的建议时间间隔（以秒为单位）。例如，如果有要检索的数据，则 Retry-After 标头的值为 1 或 60。如果没有要检索的数据，则 Retry-After 标头的值将为 300。

注意：这些只是建议的值 - 应用程序可以根据要求选择以不同的频率轮询。第一个请求后，所有后续请求都应使用最新响应的 Location 标头中提供的 URL。不要向 URL 添加更多参数，因为它已包含确保请求中缺少订单更改所需的必要参数。

结果按 ModifiedUtc 自动排序，然后按 OrderId 按升序排序。排序参数不可配置。

ModifiedUtc 定义：内部时间标记 = 最新订单数据更改的时间。

参数

名称	密钥	必需	类型	说明
excludeFormData	excludeFormData		boolean	如果为 true，OrderFormFields 将始终为空数组。
excludeCustomFieldData	excludeCustomFieldData		boolean	如果为 true，则不会返回 CustomFields。

Body: CustomerAPI.Models.Order.OrderHeaderApiModel

定义

CustomerAPI.Models.Binaries.UploadBinaryResultApiModel

名称	路径	类型	说明
Id	Id	string

CustomerAPI.Models.Client.ReadClientApiModel

名称	路径	类型	说明
Id	Id	integer	客户端的 ID。
ExternalId	ExternalId	string	客户端的外部使用 ID - API 扩展属性。
CreatedUtc	CreatedUtc	date-time	创建客户端的原始时间点。
ModifiedUtc	ModifiedUtc	date-time	客户端更新的最后一个时间点。
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Name	Name	string	客户端的名称。
地址	Address	CustomerAPI.Models.LocationApiModel
联系人	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Client.ReadCustomFieldDataApiModel

名称	路径	类型	说明
FieldIndex	FieldIndex	integer	字段索引。
标题	Caption	string	字段标题。
数据类型	DataType	integer	字段数据类型。
DateTimeFormat	DateTimeFormat	integer	DateTime 格式。
价值	Value		字段值。

CustomerAPI.Models.LocationApiModel

名称	路径	类型	说明
LatLon	LatLon	System.Nullable_1_Actsoft.Core.Geo.LatLon_
AddressLine1	AddressLine1	string	此 LocationApiModel 的 AddressLine1。
AddressLine2	AddressLine2	string	此 LocationApiModel 的 AddressLine2。
City	City	string	LocationApiModel 市。
地区名称	RegionName	string	LocationApiModel 的区域名称。
邮政编码	PostalCode	string	LocationApiModel 的邮政编码。
国家代码	CountryCode	string	ISO 3166-1 alpha-2 代码。
SubRegionName	SubRegionName	string	LocationApiModel 的子区域。
SubRegionCode	SubRegionCode	string	LocationApiModel 的子区域代码。
RegionCode	RegionCode	string	LocationApiModel 的区域代码。

CustomerAPI.Models.Client.ContactApiModel

名称	路径	类型	说明
Name	Name	string	ContactApiModel 的名称。
电话号码	PhoneNumber	string	ContactApiModel 的 PhoneNumber。
Email	Email	string	ContactApiModel 的电子邮件。

System.Nullable_1_Actsoft.Core.Geo.LatLon_

名称	路径	类型	说明
Latitude	Latitude	double
Longitude	Longitude	double

CustomerAPI.Models.ReturnIdApiModel

名称	路径	类型	说明
Id	Id	integer	对象 ID。

CustomerAPI.Models.CustomLists.CustomListDefinitionListItemApiModel

定义自定义列表定义列表项 API 模型。

名称	路径	类型	说明
CustomListId	CustomListId	integer	自定义列表 ID。
Name	Name	string	自定义列表名称。
版本	Version	string	自定义列表版本。

CustomerAPI.Models.CustomLists.CustomListApiModel

自定义列表模型。

名称	路径	类型	说明
CustomListId	CustomListId	integer	自定义列表 ID。
Name	Name	string	自定义列表名称。
版本	Version	string	自定义列表版本。
Definition	Definition	CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel	定义自定义列表定义 API 模型。

CustomerAPI.Models.CustomLists.CustomListDefinitionApiModel

定义自定义列表定义 API 模型。

名称	路径	类型	说明
列	Columns	array of CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel	自定义列表列。
UniqueColumnIndexIndex	UniqueColumnIndexIndex	integer	唯一的列索引。

CustomerAPI.Models.CustomLists.CustomListDefinitionColumnApiModel

定义自定义列表定义列 API 模型。

名称	路径	类型	说明
Index	Index	integer	列索引。
数据类型	DataType	integer	列数据类型（文本：0，数字：1，日期：2，时间：3，日期时间：4，电子邮件：5）。
Name	Name	string	列名称。

CustomerAPI.Models.CustomLists.CustomListColumnValuesContainerApiModel

自定义列表列数据数组的容器。

名称	路径	类型	说明
ColumnValues	ColumnValues	array of CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel	包含数据的列数组。

CustomerAPI.Models.CustomLists.CustomListColumnValueApiModel

此模型定义自定义列表列值。

名称	路径	类型	说明
ColumnIndex	ColumnIndex	integer	自定义列表列索引。
标题	Caption	string	自定义列表列标题。
价值	Value		自定义列表列值。

CustomerAPI.Models.CustomEventDefinitions.ReadCustomEventDefinitionApiModel

自定义事件定义模型。

名称	路径	类型
Id	Id	string
Name	Name	string
ReverseGeocode	ReverseGeocode	boolean
参数	Parameters	array of CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

CustomerAPI.Models.CustomEventDefinitions.CustomEventDefinitionParamApiModel

名称	路径	类型
Name	Name	string
类型	Type	integer
标题	Caption	string
必选	Required	boolean

CustomerAPI.Models.CustomEventData.ReadEventListItemApiModel

名称	路径	类型	说明
EventId	EventId	integer	事件 ID。
事件类型	EventType	integer
EventCode	EventCode	string	事件代码。
EventTime	EventTime	date-time	具有本地和偏移量的 ISO 格式。
用户	User	CustomerAPI.Models.UserReferenceApiModel
车辆	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
UserLinkedToVehicle	UserLinkedToVehicle	boolean	如果已启用，则事件车辆已分配用户。
位置	Location	CustomerAPI.Models.LocationApiModel
PrimaryGeofence	PrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
CustomEventDefinitionId	CustomEventDefinitionId	string	外部事件定义 ID。
EventParams	EventParams	object	事件参数。

CustomerAPI.Models.UserReferenceApiModel

名称	路径	类型	说明
UserId	UserId	integer	UserId。
名字	FirstName	string	用户的名字。
姓	LastName	string	用户的姓氏。
员工编号	EmployeeNumber	string	用户的员工编号。
GroupName	GroupName	string	分配给用户的组的名称。

CustomerAPI.Models.ReadVehicleApiModel

名称	路径	类型	说明
VehicleId	VehicleId	integer	BaseVehicleApiModel 的 ID。
Name	Name	string	BaseVehicleApiModel 的名称。
VIN	VIN	string	BaseVehicleApiModel 的车辆标识号。
设备名称	DeviceName	string	与 BaseVehicleApiModel 关联的 GpsDeviceDto 的名称。
序列号	SerialNumber	string	BaseVehicleApiModel 的 SerialNumber。
GroupName	GroupName	string	BaseVehicleApiModel 的 GroupName。

CustomerAPI.Models.Geofence.GeofenceInfoApiModel

名称	路径	类型	说明
GeofenceId	GeofenceId	integer	地理围栏的 ID。
Name	Name	string	地理围栏的名称。

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionResultApiModel

名称	路径	类型	说明
SubscriptionId（订阅ID）	SubscriptionId	string	WebHookSubscriptionResultApiModel 的 ID。

CustomerAPI.Models.WebHookSubscription.WebHookSubscriptionInfoApiModel

名称	路径	类型	说明
SubscriptionId（订阅ID）	SubscriptionId	string
网址	Url	string
状态	Status	integer	订阅状态 - （正在运行： 1，已停止： 2）。

CustomerAPI.Models.Forms.StandaloneFormApiModel

名称	路径	类型	说明
Id	Id	integer	与此 StandaloneFormApiModel 关联的 ID - （旧注释：FormHeaderId）。
FormId	FormId	integer	此独立FormApiModel 引用的表单的 ID。
FormName	FormName	string	此独立FormApiModel 引用的窗体的名称。
EntryNumber	EntryNumber	string	表单数据输入编号。
检讨	Reviewed	boolean	此独立FormApiModel 的评审状态。
用户	User	CustomerAPI.Models.UserReferenceApiModel
SubmittedTime	SubmittedTime	date-time	提交 StandaloneFormApiModel 的时间点。
StartTime	StartTime	date-time	启动 StandaloneFormApiModel 的时间点。
SubmittedLocation	SubmittedLocation	CustomerAPI.Models.LocationApiModel
FormData	FormData	array of CustomerAPI.Models.Forms.FormFieldDataApiModel	与此 StandaloneFormApiModel 关联的字段列表。
ApiModuleId	ApiModuleId	string	与此 StandaloneFormApiModel 关联的 ApiModule 的 ID。
SharedUrl	SharedUrl	string	此 StandaloneFormApiModel 的共享 URL。
ReviewedByUser	ReviewedByUser	CustomerAPI.Models.UserReferenceApiModel
ReviewedByTime	ReviewedByTime	date-time	表单评审的时间

CustomerAPI.Models.Forms.FormFieldDataApiModel

名称	路径	类型	说明
可重复的	Repeatables	array of array
items	Repeatables	array of CustomerAPI.Models.Forms.FormFieldDataBaseApiModel
Id	Id	string	FormFieldDataApiModel 的 ID。
价值	Value		FormFieldDataApiModel 的值。
DisplayValue	DisplayValue		FormFieldDataApiModel 的 DisplayValue。
CapturedTime	CapturedTime	date-time	捕获 FormFieldDataApiModel 的时间点值。
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
标题	Caption	string	FormFieldDataApiModel 的标题内容。
ApiFieldId	ApiFieldId	string	FormFieldDataApiModel 的 ApiField 的 ID。

CustomerAPI.Models.Forms.FormFieldDataBaseApiModel

名称	路径	类型	说明
Id	Id	string	FormFieldDataApiModel 的 ID。
价值	Value		FormFieldDataApiModel 的值。
DisplayValue	DisplayValue		FormFieldDataApiModel 的 DisplayValue。
CapturedTime	CapturedTime	date-time	捕获 FormFieldDataApiModel 的时间点值。
CapturedLocation	CapturedLocation	CustomerAPI.Models.LocationApiModel
标题	Caption	string	FormFieldDataApiModel 的标题内容。
ApiFieldId	ApiFieldId	string	FormFieldDataApiModel 的 ApiField 的 ID。

CustomerAPI.Models.Geofence.GeofenceListItemApiModel

名称	路径	类型	说明
GeofenceId	GeofenceId	integer	GeofenceApiModel 的 GeofenceId。
CreatedUtc	CreatedUtc	date-time	GeofenceApiModel 的 CreatedUtc。
ModifiedUtc	ModifiedUtc	date-time	GeofenceApiModel 的 ModifiedUtc。
GroupNames	GroupNames	array of string	GeofenceApiModel 的 GroupPaths。
Name	Name	string	GeofenceApiModelBase 的名称。
类型	Type	string	GeofenceApiModel 的类型。
形状	Shape	integer	形状：0 表示圆形，1 表示多边形。
地址	Address	CustomerAPI.Models.LocationApiModel
半径	Radius	double	GeofenceApiModel 的半径。
UseGeofenceAddress	UseGeofenceAddress	boolean	GeofenceApiModel 的 UseGeofenceAddress。

Actsoft.Core.Geo.LatLon

名称	路径	类型	说明
Latitude	Latitude	double
Longitude	Longitude	double

CustomerAPI.Models.Geofence.GeofenceApiModel

名称	路径	类型	说明
GeofenceId	GeofenceId	integer	GeofenceApiModel 的 GeofenceId。
CreatedUtc	CreatedUtc	date-time	GeofenceApiModel 的 CreatedUtc。
ModifiedUtc	ModifiedUtc	date-time	GeofenceApiModel 的 ModifiedUtc。
GroupNames	GroupNames	array of string	GeofenceApiModel 的 GroupPaths。
Polygon	Polygon	array of Actsoft.Core.Geo.LatLon	多边形点。当形状等于 1 时应填充。
Name	Name	string	GeofenceApiModelBase 的名称。
类型	Type	string	GeofenceApiModel 的类型。
形状	Shape	integer	形状：0 表示圆形，1 表示多边形。
地址	Address	CustomerAPI.Models.LocationApiModel
半径	Radius	double	GeofenceApiModel 的半径。
UseGeofenceAddress	UseGeofenceAddress	boolean	GeofenceApiModel 的 UseGeofenceAddress。

CustomerAPI.Models.Order.OrderListItemApiModel

名称	路径	类型	说明
订单编号	OrderId	integer	OrderBaseApiModel 的 ID。
ExternalOrderId	ExternalOrderId	string	客户端的外部 Use OrderId - API 扩展属性。
截止日期	DueDate	date-time	此 OrderBaseApiModel 的完成时间点（在 v1.3 中已过时）。
StartTime	StartTime	date-time	此 OrderBaseApiModel 应启动的时间点（在 v1.3 中引入）。
EndTime	EndTime	date-time	此 OrderBaseApiModel 的完成时间点（在 v1.3 中引入）。
ServiceType	ServiceType	string	与此 OrderBaseApiModel 关联的 ServiceType。
CreatedUTCDate	CreatedUTCDate	date-time	创建 OrderBaseApiModel 的时间点。
订单编号	OrderNumber	string	与此 OrderBaseApiModel 关联的订单号。
IsClosed	IsClosed	boolean	显示 OrderBaseApiModel 是否已关闭的状态。
状态	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	客户端的外部使用 ID - API 扩展属性。
ClientId	ClientId	integer	客户端的内部使用 ID - API 扩展属性。
客户	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	与此 OrderBaseApiModel 关联的 ApiService 的 ID。
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	自定义字段模块版本。
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusApiModel

名称	路径	类型	说明
StatusIndex	StatusIndex	integer	OrderStatusApiModel 的索引。
状态类型	StatusType	integer	订单状态：0 表示新订单，1 表示已调度，2 表示正在进行，3 表示已完成，4 表示已取消。
StatusLabel	StatusLabel	string	OrderStatusApiModel 的标签内容。
StatusId	StatusId	integer	OrderStatusApiModel 的 ID。
StatusStartDateTime	StatusStartDateTime	date-time	OrderStatusApiModel 的起始时间点。
用户	User	CustomerAPI.Models.UserReferenceApiModel

CustomerAPI.Models.Order.OrderClientReadApiModel

名称	路径	类型	说明
GroupNames	GroupNames	array of string	客户端组层次结构名称。
Name	Name	string	客户端的名称。
地址	Address	CustomerAPI.Models.LocationApiModel
联系人	Contact	CustomerAPI.Models.Client.ContactApiModel

CustomerAPI.Models.Order.OrderApiModel

名称	路径	类型	说明
StatusHistory	StatusHistory	array of CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel	与此 OrderApiModel 关联的 OrderStatusListItems 的列表。
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
订单编号	OrderId	integer	OrderBaseApiModel 的 ID。
ExternalOrderId	ExternalOrderId	string	客户端的外部 Use OrderId - API 扩展属性。
截止日期	DueDate	date-time	此 OrderBaseApiModel 的完成时间点（在 v1.3 中已过时）。
StartTime	StartTime	date-time	此 OrderBaseApiModel 应启动的时间点（在 v1.3 中引入）。
EndTime	EndTime	date-time	此 OrderBaseApiModel 的完成时间点（在 v1.3 中引入）。
ServiceType	ServiceType	string	与此 OrderBaseApiModel 关联的 ServiceType。
CreatedUTCDate	CreatedUTCDate	date-time	创建 OrderBaseApiModel 的时间点。
订单编号	OrderNumber	string	与此 OrderBaseApiModel 关联的订单号。
IsClosed	IsClosed	boolean	显示 OrderBaseApiModel 是否已关闭的状态。
状态	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	客户端的外部使用 ID - API 扩展属性。
ClientId	ClientId	integer	客户端的内部使用 ID - API 扩展属性。
客户	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	与此 OrderBaseApiModel 关联的 ApiService 的 ID。
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	自定义字段模块版本。
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Order.OrderStatusHistoryListItemApiModel

名称	路径	类型	说明
StatusStartDateTime	StatusStartDateTime	date-time	此 OrderStatusHistoryListItemApiModel 状态已启动的时间点。
StatusEndDateTime	StatusEndDateTime	date-time	此 OrderStatusHistoryListItemApiModel 状态已结束的时间点。
StatusId	StatusId	integer	与此 OrderStatusHistoryListItemApiModel 关联的 ID。
StatusIndex	StatusIndex	integer	与此 OrderStatusHistoryListItemApiModel 关联的索引。
StatusLabel	StatusLabel	string	标记与此 OrderStatusHistoryListItemApiModel 关联的内容。
状态类型	StatusType	integer	订单状态：0 表示新订单，1 表示已调度，2 表示正在进行，3 表示已完成，4 表示已取消。
ExternalOrderId	ExternalOrderId	string	客户端的外部 Use OrderId - API 扩展属性。
订单编号	OrderId	integer	与此 OrderStatusHistoryListItemApiModel 关联的 OrderId。
用户	User	CustomerAPI.Models.UserReferenceApiModel
StartAddress	StartAddress	CustomerAPI.Models.LocationApiModel
EndAddress	EndAddress	CustomerAPI.Models.LocationApiModel
ApiServiceId	ApiServiceId	string	与此 OrderStatusHistoryListItemApiModel 关联的 ApiService 的 ID。
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

CustomerAPI.Models.Order.OrderHeaderApiModel

名称	路径	类型	说明
OrderFormFields	OrderFormFields	array of CustomerAPI.Models.Forms.FormFieldDataApiModel
订单编号	OrderId	integer	OrderBaseApiModel 的 ID。
ExternalOrderId	ExternalOrderId	string	客户端的外部 Use OrderId - API 扩展属性。
截止日期	DueDate	date-time	此 OrderBaseApiModel 的完成时间点（在 v1.3 中已过时）。
StartTime	StartTime	date-time	此 OrderBaseApiModel 应启动的时间点（在 v1.3 中引入）。
EndTime	EndTime	date-time	此 OrderBaseApiModel 的完成时间点（在 v1.3 中引入）。
ServiceType	ServiceType	string	与此 OrderBaseApiModel 关联的 ServiceType。
CreatedUTCDate	CreatedUTCDate	date-time	创建 OrderBaseApiModel 的时间点。
订单编号	OrderNumber	string	与此 OrderBaseApiModel 关联的订单号。
IsClosed	IsClosed	boolean	显示 OrderBaseApiModel 是否已关闭的状态。
状态	Status	CustomerAPI.Models.Order.OrderStatusApiModel
ExternalClientId	ExternalClientId	string	客户端的外部使用 ID - API 扩展属性。
ClientId	ClientId	integer	客户端的内部使用 ID - API 扩展属性。
客户	Client	CustomerAPI.Models.Order.OrderClientReadApiModel
ApiServiceId	ApiServiceId	string	与此 OrderBaseApiModel 关联的 ApiService 的 ID。
CustomFieldsModuleVersion	CustomFieldsModuleVersion	integer	自定义字段模块版本。
CustomFieldsData	CustomFieldsData	array of CustomerAPI.Models.Client.ReadCustomFieldDataApiModel
Recurrence	Recurrence	boolean

CustomerAPI.Models.Timekeeping.TimekeepingApiModel

名称	路径	类型	说明
Id	Id	integer	Timekeeping 条目的 ID（旧注释：RootSubmittedStatusId）。
用户	User	CustomerAPI.Models.UserReferenceApiModel
ClockInTime	ClockInTime	date-time	用户时钟进入系统的时间点。
ClockInLocation	ClockInLocation	CustomerAPI.Models.LocationApiModel
ClockOutTime	ClockOutTime	date-time	用户从系统时钟时的时间点。
ClockOutLocation	ClockOutLocation	CustomerAPI.Models.LocationApiModel
TotalHours	TotalHours	double	此保留项的总小时数。
TotalBreakHours	TotalBreakHours	double	此时间保留项的休息时间（非工作时间）总小时数。
NetHours	NetHours	double	此计时条目的可收费小时总数。
已批准	Approved	boolean	此计时条目的主管审批状态。
休息	Breaks	array of CustomerAPI.Models.Timekeeping.TimekeepingBreakModel
ClockInFormData	ClockInFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ClockOutFormData	ClockOutFormData	CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel
ModuleVersion	ModuleVersion	System.Version
CompanyModuleId	CompanyModuleId	integer	用于提交此计时条目的公司模块的 ID。

CustomerAPI.Models.Timekeeping.TimekeepingBreakModel

名称	路径	类型	说明
Id	Id	integer	SubmittedStatusId。
StartTime	StartTime	date-time	开始时间。
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndTime	EndTime	date-time	结束时间。
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
DurationHours	DurationHours	double	持续时间（以小时为单位）。如果 EndTime 为 null，则它可以为 null。
状态类型	StatusType	integer	状态类型：1 表示休息，2 表示午餐。
StartLabel	StartLabel	string	开始标签。
EndLabel	EndLabel	string	结束标签。
标题	Caption	string	标题。

CustomerAPI.Models.Timekeeping.TimekeepingStatusFormDataApiModel

名称	路径	类型
CompanyModuleId	CompanyModuleId	integer
ModuleVersion	ModuleVersion	System.Version
FieldValues	FieldValues	array of CustomerAPI.Models.Forms.FormFieldDataApiModel

System.Version

名称	路径	类型
_主要	_Major	integer
_次要	_Minor	integer
_建	_Build	integer
_校订	_Revision	integer

CustomerAPI.Models.Tracking.TripApiModel

名称	路径	类型	说明
用户	User	CustomerAPI.Models.UserReferenceApiModel
车辆	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
StartTime	StartTime	date-time	此 TripApiModel 状态启动的时间点。
EndTime	EndTime	date-time	此 TripApiModel 状态已结束的时间点。
StartLocation	StartLocation	CustomerAPI.Models.LocationApiModel
EndLocation	EndLocation	CustomerAPI.Models.LocationApiModel
StartPrimaryGeofence	StartPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
EndPrimaryGeofence	EndPrimaryGeofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
TotalStopTime	TotalStopTime	double	与此 TripApiModel 关联的停止时间（以小时为单位）。
TotalIdleTime	TotalIdleTime	double	与此 TripApiModel 关联的空闲时间（以小时为单位）。
TotalDuration	TotalDuration	double	与此 TripApiModel 关联的完整时间（以小时为单位）。
距离	Distance	double	以与此 TripApiModel 关联的本地化单位行驶的距离。

CustomerAPI.Models.Tracking.GpsDataSegmentApiModel

名称	路径	类型	说明
记录	Records	array of CustomerAPI.Models.Tracking.GpsDataRecordApiModel
ContinuationToken（续传令牌）	ContinuationToken	string

CustomerAPI.Models.Tracking.GpsDataRecordApiModel

名称	路径	类型	说明
用户	User	CustomerAPI.Models.UserReferenceApiModel
车辆	Vehicle	CustomerAPI.Models.ReadVehicleApiModel
TimeTag	TimeTag	date-time	与此 GpsDataRecordApiModel 关联的 TimeTag。
位置	Location	System.Nullable_1_Actsoft.Core.Geo.LatLon_
地理围栏	Geofence	CustomerAPI.Models.Geofence.GeofenceInfoApiModel
Speed	Speed	double	与此 GpsDataRecordApiModel 关联的移动速度。
Heading	Heading	double	与此 GpsDataRecordApiModel 关联的度方向指南针方向。
状态	Status	integer	与 OrderBaseApiModel 关联的 ApiMovementStatus - （已停止：1，空闲：2，移动：3，NotTracking： 4）：OrderStatusApiModel。
StatusTime	StatusTime	string	设置了此 GpsDataRecordApiModel 状态的时间点。
距离	Distance	double	在与此 TripApiModel 关联的本地化单元中行驶的距离。
点火器	IgnitionOn	boolean	与此 GpsDataRecordApiModel 关联的车辆点火状态。
LocationProvider	LocationProvider	integer	与此 GpsDataRecordApiModel 关联的 Api 位置提供程序 - （GPS： 1，网络： 2）。

CustomerAPI.Models.User.ReadUserApiModel

名称	路径	类型	说明
UserName	UserName	string	用户的用户名。
UserId	UserId	integer	用户的 ID 值。
GroupName	GroupName	string	用户组的名称。
名字	FirstName	string	用户的名字。
姓	LastName	string	用户的姓氏。
员工编号	EmployeeNumber	string	用户的员工编号。
Email	Email	string	用户的电子邮件地址。
电话	Phone	string	用户的电话号码。
RoleId	RoleId	integer	用户的 RoleId - （管理员：1、用户：3、Power User： 5）。
IsActive	IsActive	boolean	用户的活动状态。
EPTTEnabled	EPTTEnabled	boolean	用户增强的“推送到通话”功能的状态：布尔值。
EPTTNumber	EPTTNumber	string	用户增强的“推送到通话”功能的电话号码：字符串。
EPTTWebMDN	EPTTWebMDN	string	用于向 Kodiak EPTT 系统验证用户的电话号码 - 由 Kodiak 提供。
EPTTToken	EPTTToken	string	用于向 Kodiak EPTT 系统对用户进行身份验证的 API 令牌 - 由 Kodiak 提供。
GPSEnabled	GPSEnabled	boolean	用户的 GPS 功能的状态。
MobileOnly	MobileOnly	boolean	CAB 桌面 Web 应用程序访问的状态 - （无 WebApp 访问：True，完整应用访问：False）。
LicenseType	LicenseType	integer	分配给用户的许可证类型： - 0 表示未定义，1 表示常规，2 表示 WebOnly，3 表示员工。

CustomerAPI.Models.User.ReadUserListItemApiModel

名称	路径	类型	说明
UserId	UserId	integer	用户的 ID 值。
名字	FirstName	string	用户的名字。
姓	LastName	string	用户的姓氏。
员工编号	EmployeeNumber	string	用户的员工编号。
Email	Email	string	用户的电子邮件地址。
电话	Phone	string	用户的电话号码。
RoleId	RoleId	integer	用户的 RoleId - （管理员：1、用户：3、Power User： 5）。
IsActive	IsActive	boolean	用户的活动状态。
EPTTEnabled	EPTTEnabled	boolean	用户增强的“推送到通话”功能的状态：布尔值。
EPTTNumber	EPTTNumber	string	用户增强的“推送到通话”功能的电话号码：字符串。
EPTTWebMDN	EPTTWebMDN	string	用于向 Kodiak EPTT 系统验证用户的电话号码 - 由 Kodiak 提供。
EPTTToken	EPTTToken	string	用于向 Kodiak EPTT 系统对用户进行身份验证的 API 令牌 - 由 Kodiak 提供。
GPSEnabled	GPSEnabled	boolean	用户的 GPS 功能的状态。
MobileOnly	MobileOnly	boolean	CAB 桌面 Web 应用程序访问的状态 - （无 WebApp 访问：True，完整应用访问：False）。
LicenseType	LicenseType	integer	分配给用户的许可证类型： - 0 表示未定义，1 表示常规，2 表示 WebOnly，3 表示员工。

CustomerAPI.Models.Vehicles.VehicleReadApi

车辆数据模型。

名称	路径	类型
InternalId	InternalId	integer
编号	Number	string
Name	Name	string
类型	Type	string
标记	Tag	string
UserEmployeeNumber	UserEmployeeNumber	string
GroupName	GroupName	string
TimeZone	TimeZone	string
做	Make	string
年份	Year	integer
型号	Model	string
颜色	Color	string
VIN	VIN	string
IsActive	IsActive	boolean
设备类型	DeviceType	integer
DeviceSerialNumber	DeviceSerialNumber	string

整数

这是基本数据类型“integer”。

对象

这是类型“object”。