InfoQuery

利用低代码解决方案中的 Resware 数据，InfoQuery 使你能够自动化业务。可以查看、创建、删除和更新文件、文档、合作伙伴等。

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

服务	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	InfoQuery 支持
URL	https://infoquery.pro/support/
Email	support@infoquery.pro

连接器元数据
发布者	InfoQuery LLC
Website	https://infoquery.pro/
隐私策略	https://infoquery.pro/privacy/
类别	内容和文件;数据

InfoQuery 游戏资源管理器允许自动更改 Resware 系统。你可以添加、删除或编辑文件、作、备注、文档等。

先决条件

必须注册 API 密钥 https://connector.infoquery.pro/
还需要一个 Resware 帐户。需要用户名、密码和门户 URL 才能形成连接。

如何获取凭据

转到 https://connector.infoquery.pro/signup 并创建帐户。从此处可以选择所选订阅，选择后将提供 API 密钥。
访问 https://connector.infoquery.pro/products 订阅和定价详细信息。
Resware 帐户详细信息将由 Resware 管理员提供。

连接器入门

转到 Power Automate。https://powerautomate.microsoft.com
创建新流或编辑现有流。
向流添加新步骤，搜索 InfoQuery 游戏资源管理器以查看所有可用作。
选择该作后，需要创建新的连接。
输入连接名称、API 密钥、Resware 用户名、密码和门户 URL。门户 URL 的格式必须为 https://portal.infoquery.com/API。
如果需要帮助，请联系 support@infoquery.pro 或访问 https://infoquery.pro/support/ 。

已知问题和限制

利用 Resware 的每个业务都能够对其进行自定义以满足其特定需求。根据设置 Resware，某些作可能需要提供特定信息才能使连接器正常工作。需要了解 Resware 系统。

常见错误和补救措施

作可能会发出 200 响应，但不会返回预期信息。这很可能是由于未提供特定 Resware 设置所需的信息。你提供的信息已成功发送到 Resware，提供 200 响应，但作可能未按预期发生。 Resware 管理员或门户将提供完成作所需的信息。

FAQ

在哪里可以找到 Resware 门户 URL？

Resware 管理员将提供门户 URL。
如何获取 API 密钥？

转到 https://connector.infoquery.pro/signup 并创建帐户。在这里，你可以选择所选的订阅，选择后将提供 API 密钥。

正在创建连接

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


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

违约

适用：所有区域

用于创建连接的参数。

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

Name	类型	Description	必选
API 密钥	securestring	此 API 的 API 密钥	True
ResWare 用户名	字符串	ResWare 的用户名	True
ResWare 密码	securestring	ResWare 的密码	True
ResWare 门户 URL	字符串	ResWare 的门户 URL	True

限制

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

操作

从给定的搜索条件获取文件	根据给定的搜索条件获取文件及其信息的列表。
估计收盘费	估计收盘费。
创建新文件	创建新文件。
删除以前下单的订单	取消以前下订单。
删除特定文件上的合作伙伴	从指定文件中删除合作伙伴。
取消以前下单	取消以前下订单。
向合作伙伴公司添加新的合作伙伴员工	向合作伙伴公司添加新的合作伙伴员工。
向文件添加作	将作添加到指定文件。
向文件添加备注	向指定文件添加新注释。
在特定文件上创建新文档	在指定文件上创建新文档。
在特定文件上添加或更新自定义字段	添加或更新指定文件上的自定义字段。
在特定文档上添加或更新自定义字段	在指定文件上添加或更新指定文档上的自定义字段。
将 Web URL 文档上传到特定文件	加载指定文件上的 Web URL 文档。
将合作伙伴添加到特定文件	将合作伙伴添加到指定文件。
文件的更新作	更新给定文件的作。可以更新作组 ID 并启动/完成协调器类型 ID、合作伙伴类型 ID、截止日期、锁定截止日期和完成日期锁定。此 API 调用不能用于将作标记为已启动或已完成。
更新合作伙伴员工	更新合作伙伴员工的信息。
更新特定文件的合作伙伴信息	更新指定文件上的合作伙伴信息。
获取合作伙伴信息	获取具有指定 ID 的伙伴的信息。
获取当前用户信息	获取当前已连接用户的信息。
获取收盘费估计收据	获取收盘费估算收据。
获取收盘费估计收据 PDF	获取 PDF 格式的结束费用估算收据。
获取文档	获取具有指定 ID 的文档的信息。
获取注释	获取具有指定 ID 的注释。
获取特定文件的作	获取指定文件上的所有作。
获取特定文件的参与方	获取有关指定文件的参与方及其信息的列表。
获取特定文件的合作伙伴	获取有关指定文件的合作伙伴及其信息的列表。
获取特定文件的文档	获取有关指定文件的文档的所有信息。
获取特定文件的注释	获取指定文件上的注释的列表。
获取特定文件的自定义字段	获取指定文件的自定义字段。
获取特定文档中的自定义字段	获取指定文档上的自定义字段。
获取用于估计和订单放置的事务和产品类型	获取用于费用估算和下单的交易类型和产品类型。

从给定的搜索条件获取文件

操作 ID:: GetsFilesFromGivenSearchCriteria

根据给定的搜索条件获取文件及其信息的列表。

参数

名称	密钥	类型	说明
FileNumber	FileNumber	string	文件编号。
FileID	FileID	integer	文件标识号。
OfficeID	OfficeID	integer	办公室标识号。
ClientsFileNumber	ClientsFileNumber	string	客户端文件编号。
TransactionTypeID	TransactionTypeID	integer	事务类型标识号。
ProductTypeID	ProductTypeID	integer	产品类型标识号。
StatusID	StatusID	integer	状态标识号。
Name	Name	string	状态的名称。
PolicyNumber	PolicyNumber	string	策略编号。
SearchNumber	SearchNumber	string	搜索编号。
LoanNumber	LoanNumber	string	贷款编号。
IsPrimary	IsPrimary	boolean	这是否是主属性地址。
StreetNumber	StreetNumber	string	街道编号。
StreetName	StreetName	string	街道名称。
City	City	string	城市名称。
State	State	string	两个字母状态缩写。
邮政编码	Zip	string	邮政编码。
细分	Subdivision	string	属性所在的细分。
ParcelID	ParcelID	string	包裹标识号。
实体类型	EntityType	string	实体类型。
First	First	string	参与方的名字。
Last	Last	string	群的姓氏。
UsePropertyAddress	UsePropertyAddress	boolean	这是否是主属性地址。
MaritalStatus	MaritalStatus	string	党的婚姻状况。
UserID	UserID	integer	用户标识号。
PartnerTypeID	PartnerTypeID	integer	合作伙伴类型标识号。
PartnerID	PartnerID	integer	合作伙伴标识号。
PartnerTypeID	PartnerTypeID	integer	合作伙伴类型标识号。
OpenedFromDate	OpenedFromDate	string	文件打开的日期。
OpenedToDate	OpenedToDate	string	文件关闭的日期。

response: object

估计收盘费

操作 ID:: EstimateClosingFee

估计收盘费。

参数

名称	密钥	类型	说明
TransactionTypeID	TransactionTypeID	integer	事务类型标识号。
ProductTypeID	ProductTypeID	integer	产品类型标识号。
SettlementStatementVersion	SettlementStatementVersion	string	settlement 语句版本。
SalesPrice	SalesPrice	integer	销售价格。
LienPosition	LienPosition	integer	连线位置。
LoanAmount	LoanAmount	integer	贷款金额。
LoanType	LoanType	string	贷款类型。
IsPrimary	IsPrimary	boolean	这是否是主属性。
StreetNumber	StreetNumber	string	街道编号。
StreetName	StreetName	string	街道名称。
City	City	string	城市名称。
State	State	string	两个字母状态缩写。
县	County	string	县名。
邮政编码	Zip	string	邮政编码。
PartnerTypeID	PartnerTypeID	integer	合作伙伴类型标识号。
PartnerID	PartnerID	integer	合作伙伴标识号。
PartnerTypeID	PartnerTypeID	integer	合作伙伴类型标识号。
Name	Name	string	认可的名称。

名称	路径	类型	说明
ClosingFeeEstimateID	ClosingFeeEstimate.ClosingFeeEstimateID	integer	收盘费估计标识号。
HUDFees	ClosingFeeEstimate.HUDFees	array of object	HUD 费用。
金额	ClosingFeeEstimate.HUDFees.Amount	integer	HUD 费用金额。
Description	ClosingFeeEstimate.HUDFees.Description	string	费用的说明。
LineNumber	ClosingFeeEstimate.HUDFees.LineNumber	string	行号。
BuyerAmount	ClosingFeeEstimate.HUDFees.BuyerAmount	integer	买家金额。
BuyerPOCAmount	ClosingFeeEstimate.HUDFees.BuyerPOCAmount	integer	买家 POC 金额。
SellerAmount	ClosingFeeEstimate.HUDFees.SellerAmount	integer	卖方金额。
SellerPOCAmount	ClosingFeeEstimate.HUDFees.SellerPOCAmount	integer	卖方 POC 金额。
OtherPOCAmount	ClosingFeeEstimate.HUDFees.OtherPOCAmount	integer	其他 POC 金额。
PartnerTypeID	ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeID	integer	合作伙伴类型标识号。
PartnerTypeName	ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeName	string	合作伙伴类型名称。
GFE	ClosingFeeEstimate.GFE	array of object	善意估计。
Description	ClosingFeeEstimate.GFE.Description	string	估计的用途。
金额	ClosingFeeEstimate.GFE.Amount	integer	估计金额。
贷款人Premium	ClosingFeeEstimate.Premiums.LendersPremium	integer	贷款人溢价。
FullLendersPremium	ClosingFeeEstimate.Premiums.FullLendersPremium	integer	完整的贷款人溢价。
时间戳	ClosingFeeEstimate.Timestamp	string	时间戳。

创建新文件

操作 ID:: CreateNewFile

创建新文件。

参数

名称	密钥	类型	说明
实体类型	EntityType	string	实体类型的名称。个人、公司等。
IsPrimaryTransactee	IsPrimaryTransactee	boolean	买家是否是主要交易人。
First	First	string	买家的名字。
Last	Last	string	买家的姓氏。
UsePropertyAddress	UsePropertyAddress	boolean	是否应将邮寄地址用作新文件的属性地址。
Address1	Address1	string	街道编号和名称。
City	City	string	城市名称。
State	State	string	两个字母状态缩写。
邮政编码	Zip	string	邮政编码。
MaritalStatus	MaritalStatus	string	买家的婚姻状况。
Email	Email	string	买家的电子邮件地址。
实体类型	EntityType	string	实体类型的名称。个人、公司等。
IsPrimaryTransactee	IsPrimaryTransactee	boolean	卖方是否是主要交易人。
First	First	string	卖方的名字。
Last	Last	string	卖方的姓氏。
UsePropertyAddress	UsePropertyAddress	boolean	是否应将邮寄地址用作新文件的属性地址。
Address1	Address1	string	街道编号和名称。
City	City	string	城市名称。
State	State	string	两个字母状态缩写。
邮政编码	Zip	string	邮政编码。
MaritalStatus	MaritalStatus	string	卖方的婚姻状况。
Email	Email	string	卖方的电子邮件地址。
EstimatedSettlementDate	EstimatedSettlementDate	string	订单的估计结算日期。
TransactionTypeID	TransactionTypeID	integer	事务类型标识号。
ProductTypeID	ProductTypeID	integer	产品类型标识号。
SalesPrice	SalesPrice	integer	该属性的销售价格。
ClientFileNumber	ClientFileNumber	string	客户端文件编号。
PiggybackFileNumber	PiggybackFileNumber	string	piggyback 文件编号。
MainFileNumber	MainFileNumber	string	主文件编号。
SourceOfBusinessID	SourceOfBusinessID	integer	业务标识号的来源。
注释	Note	string	要添加到新文件的注释。
Name	Name	string	自定义域的名称。
价值	Value	string	自定义字段的值
LienPosition	LienPosition	integer	连线位置。
LoanNumber	LoanNumber	string	贷款编号。
LoanAmount	LoanAmount	integer	贷款金额。
LoanType	LoanType	string	贷款类型。
IsPrimary	IsPrimary	boolean	这是否是主属性地址。
StreetNumber	StreetNumber	string	街道编号。
StreetName	StreetName	string	街道名称。
City	City	string	城市名称。
State	State	string	两个字母状态缩写。
县	County	string	该房产所在的县。
邮政编码	Zip	string	邮政编码。

名称	路径	类型	说明
FileID	FileID	integer	新文件的标识号。
FileNumber	FileNumber	string	新文件的文件编号。
Warnings	Warnings	array of string	有关新文件的警告。

删除以前下单的订单

操作 ID:: DeletePreviouslyPlacedOrder

取消以前下订单。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
FileID	FileID		integer	文件标识号。

response: object

删除特定文件上的合作伙伴

操作 ID:: DeletePartnerOnSpecificFile

从指定文件中删除合作伙伴。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
PartnerTypeID	PartnerTypeID		integer	合作伙伴类型标识号。
PartnerID	PartnerID		integer	合作伙伴标识号。
PartnerTypeID	PartnerTypeID		integer	合作伙伴类型标识号。

response: object

取消以前下单

操作 ID:: CancelsPreviouslyPlacedOrder

取消以前下订单。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
FileID	FileID		integer	文件标识号。

response: object

向合作伙伴公司添加新的合作伙伴员工

操作 ID:: AddNewPartnerEmployeeToPartnerCompany

向合作伙伴公司添加新的合作伙伴员工。

参数

名称	密钥	必需	类型	说明
合作伙伴公司 ID	PartnerCompanyID	True	string	合作伙伴公司标识号。
密码	Password		string	新员工的密码。
PasswordExpirationDate	PasswordExpirationDate		string	密码过期的日期。
已启用	Enabled		boolean	是否将启用新员工以供使用。
WebsiteAccess	WebsiteAccess		boolean	新员工是否具有网站访问权限。
Name	Name		string	新员工的全名。
名字	FirstName		string	新员工的名字。
姓	LastName		string	新员工的姓氏。
电子邮件地址	EmailAddress		string	新员工的电子邮件地址。

名称	路径	类型	说明
PartnerCompanyID	Employee.PartnerCompanyID	integer	合作伙伴公司标识号。
已启用	Employee.Enabled	boolean	是否已启用新员工供使用。
WebsiteAccess	Employee.WebsiteAccess	boolean	员工是否具有网站访问权限。
UserID	Employee.UserID	integer	新员工的标识号。
Name	Employee.Name	string	员工的全名。
名字	Employee.FirstName	string	员工的名字。
姓	Employee.LastName	string	员工的姓氏。
电子邮件地址	Employee.ContactInformation.EmailAddress	string	员工的电子邮件地址。

向文件添加作

操作 ID:: AddActionToFile

将作添加到指定文件。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
ActionTypeID	ActionTypeID		integer	作类型标识号。
ActionGroupID	ActionGroupID		integer	作组标识号。
CoordinatorTypeID	CoordinatorTypeID		integer	协调器类型标识号。
截止日期	DueDate		string	作的截止日期。
PartnerTypeID	PartnerTypeID		integer	合作伙伴类型标识号。
截止日期	DueDate		string	作的截止日期。

名称	路径	类型	说明
FileActionID	FileActionID	integer	文件作标识号。

向文件添加备注

操作 ID:: AddNoteToFile

向指定文件添加新注释。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
Subject	Subject		string	备注主题。
Body	Body		string	备注正文。

名称	路径	类型	说明
NoteID	note.NoteID	integer	便笺标识号。

在特定文件上创建新文档

操作 ID:: CreateNewDocumentOnSpecificFile

在指定文件上创建新文档。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
文档名称	DocumentName		string	文档名称。
DocumentTypeID	DocumentTypeID		integer	文档类型标识号。
Description	Description		string	文档的说明。
InternalOnly	InternalOnly		string	文档是否仅在内部。
文档正文	DocumentBody		string	文档正文。

名称	路径	类型	说明
DocumentID	Document.DocumentID	integer	文档标识号。

在特定文件上添加或更新自定义字段

操作 ID:: AddOrUpdateCustomFieldOnSpecificFile

添加或更新指定文件上的自定义字段。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
Name	Name		string	自定义域的名称。
价值	Value		string	自定义域的值。

response: object

在特定文档上添加或更新自定义字段

操作 ID:: AddOrUpdateCustomFieldOnSpecificDocument

在指定文件上添加或更新指定文档上的自定义字段。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
文档 ID	DocumentID	True	string	文档标识号。
Name	Name		string	自定义域的名称。
价值	Value		string	自定义域的值。

response: object

将 Web URL 文档上传到特定文件

操作 ID:: UploadWebURLDocumentToSpecificFile

加载指定文件上的 Web URL 文档。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
文档名称	DocumentName		string	文档名称。
DocumentTypeID	DocumentTypeID		integer	文档类型标识号。
Description	Description		string	文档的说明。
InternalOnly	InternalOnly		boolean	文档是否仅在内部。
WebURL	WebURL		string	文档的 Web URL。

名称	路径	类型	说明
DocumentID	Document.DocumentID	integer	文档标识号。

将合作伙伴添加到特定文件

操作 ID:: AddPartnerToSpecificFile

将合作伙伴添加到指定文件。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
UserID	UserID		integer	用户标识号。
UserID	UserID		integer	用户标识号。
PartnerTypeID	PartnerTypeID		integer	合作伙伴类型标识号。
PartnerID	PartnerID		integer	合作伙伴标识号。
PartnerTypeID	PartnerTypeID		integer	合作伙伴类型标识号。

response: object

文件的更新作

操作 ID:: UpdateActionForFile

更新给定文件的作。可以更新作组 ID 并启动/完成协调器类型 ID、合作伙伴类型 ID、截止日期、锁定截止日期和完成日期锁定。此 API 调用不能用于将作标记为已启动或已完成。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
文件作 ID	FileActionID	True	string	作的标识号。
CoordinatorTypeID	CoordinatorTypeID		integer	协调器类型标识号。
截止日期	DueDate		string	作的截止日期。
DoneDateLocked	DoneDateLocked		boolean	是否已锁定完成日期。
CoordinatorTypeID	CoordinatorTypeID		integer	协调器类型标识号。
截止日期	DueDate		string	作的截止日期。
DoneDateLocked	DoneDateLocked		boolean	是否已锁定完成日期。

名称	路径	类型	说明
FileActionID	FileActionID	integer	作的标识号。

更新合作伙伴员工

操作 ID:: UpdatePartnerEmployee

更新合作伙伴员工的信息。

参数

名称	密钥	必需	类型	说明
用户 ID	UserID	True	string	用户标识号。
合作伙伴公司 ID	PartnerCompanyID	True	string	合作伙伴公司标识号。
密码	Password		string	员工密码。
PasswordExpirationDate	PasswordExpirationDate		string	密码过期的日期。
RoleID	RoleID		integer	角色标识号。
Name	Name		string	角色的名称。
已启用	Enabled		boolean	是否为员工启用了使用状态。
WebsiteAccess	WebsiteAccess		boolean	员工是否具有网站访问权限。
Name	Name		string	员工的全名。
名字	FirstName		string	员工的名字。
姓	LastName		string	员工的姓氏。
电子邮件地址	EmailAddress		string	员工的电子邮件地址。

名称	路径	类型	说明
PartnerCompanyID	Employee.PartnerCompanyID	integer	合作伙伴公司标识号。
角色	Employee.Roles	array of object	员工的角色。
RoleID	Employee.Roles.RoleID	integer	角色标识号。
Name	Employee.Roles.Name	string	角色的名称。
已启用	Employee.Enabled	boolean	是否为员工启用了使用状态。
WebsiteAccess	Employee.WebsiteAccess	boolean	员工是否具有网站访问权限。
UserID	Employee.UserID	integer	用户标识号。
Name	Employee.Name	string	员工的全名。
名字	Employee.FirstName	string	员工的名字。
姓	Employee.LastName	string	员工的姓氏。
电子邮件地址	Employee.ContactInformation.EmailAddress	string	员工的电子邮件地址。

更新特定文件的合作伙伴信息

操作 ID:: UpdatePartnerInformationForSpecificFile

更新指定文件上的合作伙伴信息。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
合作伙伴 ID	PartnerID	True	string	合作伙伴标识号。
FileID	FileID		integer	文件标识号。
UserID	UserID		integer	用户标识号。
Name	Name		string	员工的全名。
名字	FirstName		string	员工的名字。
姓	LastName		string	员工的姓氏。
电话号码	PhoneNumber		string	员工的电话号码。
HomePhoneNumber	HomePhoneNumber		string	员工的家庭电话号码。
CellPhoneNumber	CellPhoneNumber		string	员工的手机号码。
语音邮件	Voicemail		string	员工的语音邮件。
FaxNumber	FaxNumber		string	员工的传真号。
电子邮件地址	EmailAddress		string	员工的电子邮件地址。
PreferredCommunicationMethod	PreferredCommunicationMethod		string	员工首选通信方法。
Website	Website		string	员工的 Web 链接。
UserID	UserID		integer	用户标识号。
Name	Name		string	辅助雇员的全名。
名字	FirstName		string	辅助员工的名字。
姓	LastName		string	辅助雇员的姓氏。
电话号码	PhoneNumber		string	辅助员工的电话号码。
HomePhoneNumber	HomePhoneNumber		string	辅助雇员的家庭电话号码。
CellPhoneNumber	CellPhoneNumber		string	辅助员工的移动电话。
语音邮件	Voicemail		string	辅助员工的语音邮件。
FaxNumber	FaxNumber		string	辅助员工的传真号。
电子邮件地址	EmailAddress		string	辅助员工的电子邮件地址。
PreferredCommunicationMethod	PreferredCommunicationMethod		string	辅助员工首选通信方法。
Website	Website		string	辅助员工的 Web 链接。
ReferenceNumber	ReferenceNumber		string	引用编号。
RemoteFileNumber	RemoteFileNumber		string	远程文件编号。
PartnerTypeID	PartnerTypeID		integer	合作伙伴类型标识号。
PartnerID	PartnerID		integer	合作伙伴标识号。
PartnerTypeID	PartnerTypeID		integer	合作伙伴类型标识号。
PartnerTypeName	PartnerTypeName		string	合作伙伴类型名称。
OfficeID	OfficeID		integer	办公室标识号。
PartnerName	PartnerName		string	合作伙伴名称。
Address1	Address1		string	街道编号和名称。
Address2	Address2		string	进一步的地址信息。
City	City		string	城市名称。
State	State		string	两个字母状态缩写。
邮政编码	Zip		string	邮政编码。
电话号码	PhoneNumber		string	合作伙伴电话号码。
HomePhoneNumber	HomePhoneNumber		string	合作伙伴家庭电话号码。
CellPhoneNumber	CellPhoneNumber		string	合作伙伴手机号。
语音邮件	Voicemail		string	合作伙伴语音邮件号码。
FaxNumber	FaxNumber		string	合作伙伴传真号。
电子邮件地址	EmailAddress		string	合作伙伴电子邮件地址。
PreferredCommunicationMethod	PreferredCommunicationMethod		string	合作伙伴首选通信方式。
Website	Website		string	合作伙伴网站 URL。

名称	路径	类型	说明
FileID	FileID	integer	文件标识号。
FileNumber	FileNumber	string	文件编号
UserID	PrimaryEmployee.UserID	integer	用户标识号。
Name	PrimaryEmployee.Name	string	员工的全名。
名字	PrimaryEmployee.FirstName	string	员工的名字。
姓	PrimaryEmployee.LastName	string	员工的姓氏。
电话号码	PrimaryEmployee.ContactInformation.PhoneNumber	string	员工的电话号码。
HomePhoneNumber	PrimaryEmployee.ContactInformation.HomePhoneNumber	string	员工的家庭电话号码。
CellPhoneNumber	PrimaryEmployee.ContactInformation.CellPhoneNumber	string	员工的手机号码。
语音邮件	PrimaryEmployee.ContactInformation.Voicemail	string	员工的语音邮件。
FaxNumber	PrimaryEmployee.ContactInformation.FaxNumber	string	员工的传真号。
电子邮件地址	PrimaryEmployee.ContactInformation.EmailAddress	string	员工的电子邮件地址。
PreferredCommunicationMethod	PrimaryEmployee.ContactInformation.PreferredCommunicationMethod	string	员工首选通信方法。
Website	PrimaryEmployee.ContactInformation.Website	string	员工的 Web 链接。
SecondaryEmployees	SecondaryEmployees	array of object	有关辅助员工的信息。
UserID	SecondaryEmployees.UserID	integer	用户标识号。
Name	SecondaryEmployees.Name	string	辅助雇员的全名。
名字	SecondaryEmployees.FirstName	string	辅助员工的名字。
姓	SecondaryEmployees.LastName	string	辅助雇员的姓氏。
电话号码	SecondaryEmployees.ContactInformation.PhoneNumber	string	辅助员工的电话号码。
HomePhoneNumber	SecondaryEmployees.ContactInformation.HomePhoneNumber	string	辅助雇员的家庭电话号码。
CellPhoneNumber	SecondaryEmployees.ContactInformation.CellPhoneNumber	string	辅助员工的移动电话。
语音邮件	SecondaryEmployees.ContactInformation.Voicemail	string	辅助员工的语音邮件。
FaxNumber	SecondaryEmployees.ContactInformation.FaxNumber	string	辅助员工的传真号。
电子邮件地址	SecondaryEmployees.ContactInformation.EmailAddress	string	辅助员工的电子邮件地址。
PreferredCommunicationMethod	SecondaryEmployees.ContactInformation.PreferredCommunicationMethod	string	辅助员工首选通信方法。
Website	SecondaryEmployees.ContactInformation.Website	string	辅助员工的 Web 链接。
ReferenceNumber	ReferenceNumber	string	引用编号。
RemoteFileNumber	RemoteFileNumber	string	远程文件编号。
PartnerTypeID	PartnerTypeID	integer	合作伙伴类型标识号。
PartnerID	PartnerID	integer	合作伙伴标识号。
PartnerTypeID	PartnerType.PartnerTypeID	integer	合作伙伴类型标识号。
PartnerTypeName	PartnerType.PartnerTypeName	string	合作伙伴类型名称。
OfficeID	OfficeID	integer	办公室标识号。
PartnerName	PartnerName	string	合作伙伴名称。
Address1	MailingAddress.Address1	string	街道编号和名称。
Address2	MailingAddress.Address2	string	进一步的地址信息。
City	MailingAddress.City	string	城市名称。
State	MailingAddress.State	string	两个字母状态缩写。
邮政编码	MailingAddress.Zip	string	邮政编码。
电话号码	ContactInformation.PhoneNumber	string	合作伙伴电话号码。
HomePhoneNumber	ContactInformation.HomePhoneNumber	string	合作伙伴家庭电话号码。
CellPhoneNumber	ContactInformation.CellPhoneNumber	string	合作伙伴手机号。
语音邮件	ContactInformation.Voicemail	string	合作伙伴语音邮件号码。
FaxNumber	ContactInformation.FaxNumber	string	合作伙伴传真号。
电子邮件地址	ContactInformation.EmailAddress	string	合作伙伴电子邮件地址。
PreferredCommunicationMethod	ContactInformation.PreferredCommunicationMethod	string	合作伙伴首选通信方式。
Website	ContactInformation.Website	string	合作伙伴网站 URL。

获取合作伙伴信息

操作 ID:: GetPartnerInformation

获取具有指定 ID 的伙伴的信息。

参数

名称	密钥	必需	类型	说明
合作伙伴公司 ID	PartnerCompanyID	True	string	合作伙伴公司标识号。

名称	路径	类型	说明
PartnerCompanyID	PartnerCompanyID	integer	合作伙伴公司标识号。
PartnerTypes	PartnerTypes	array of object	有关合作伙伴类型的信息。
PartnerTypeID	PartnerTypes.PartnerTypeID	integer	合作伙伴类型标识号。
PartnerTypeName	PartnerTypes.PartnerTypeName	string	合作伙伴类型名称。
OfficeID	OfficeID	integer	办公室标识号。
PartnerName	PartnerName	string	合作伙伴名称。
CompanyAbbreviation	CompanyAbbreviation	string	公司缩写。
ProperCompanyName	ProperCompanyName	string	完整的公司名称。
Address1	MailingAddress.Address1	string	街道编号和名称。
Address2	MailingAddress.Address2	string	进一步的地址信息。
City	MailingAddress.City	string	城市名称。
State	MailingAddress.State	string	两个字母状态缩写。
邮政编码	MailingAddress.Zip	string	邮政编码。
电话号码	ContactInformation.PhoneNumber	string	合作伙伴电话号码。
HomePhoneNumber	ContactInformation.HomePhoneNumber	string	合作伙伴家庭电话号码。
CellPhoneNumber	ContactInformation.CellPhoneNumber	string	合作伙伴手机号。
语音邮件	ContactInformation.Voicemail	string	合作伙伴语音邮件号码。
FaxNumber	ContactInformation.FaxNumber	string	合作伙伴传真号。
电子邮件地址	ContactInformation.EmailAddress	string	合作伙伴电子邮件地址。
PreferredCommunicationMethod	ContactInformation.PreferredCommunicationMethod	string	合作伙伴首选通信方式。
Website	ContactInformation.Website	string	合作伙伴网站 URL。
ID	CompanyInformation.ParentCompany.ID	integer	标识号。
Name	CompanyInformation.ParentCompany.Name	string	父公司名称。
ID	CompanyInformation.PartnerEntity.ID	integer	标识号。
姓名	CompanyInformation.PartnerEntity.name	string	合作伙伴实体名称。
IsBillable	CompanyInformation.IsBillable	boolean	合作伙伴是否计费。
IsInvoiceable	CompanyInformation.IsInvoiceable	boolean	属性是否可开票。
TaxID	CompanyInformation.TaxID	string	合作伙伴税务标识号。
AccountingCode	CompanyInformation.AccountingCode	string	会计代码。
CommentsSpecialInstructions	CompanyInformation.CommentsSpecialInstructions	string	对合作伙伴的评论。
DontAllowSelectionInSettlement	CompanyInformation.DontAllowSelectionInSettlement	boolean	是否允许在结算中选择。
Needs1099	CompanyInformation.Needs1099	boolean	是否需要 1099。
MWBE	CompanyInformation.MWBE	boolean	合作伙伴是否是MWBE？
SendDocumentsAsWebLinks	SendDocumentsAsWebLinks	boolean	是否以 Web 链接的形式发送文档。
WireConfirmationEmailTemplateID	WireConfirmationEmailTemplateID	integer	线路确认模板标识号。
UseOnDisbursements	CourierAddress.UseOnDisbursements	boolean	这是否用于付款。
Address1	CourierAddress.Address1	string	街道编号和名称。
Address2	CourierAddress.Address2	string	进一步的地址信息。
City	CourierAddress.City	string	城市名称。
State	CourierAddress.State	string	两个字母状态缩写。
邮政编码	CourierAddress.Zip	string	邮政编码。

获取当前用户信息

操作 ID:: GetCurrentUserInfo

获取当前已连接用户的信息。

名称	路径	类型	说明
Title	Title	string	用户的标题。
PasswordExpirationDate	PasswordExpirationDate	string	密码过期的日期。
UserID	UserID	integer	用户标识号。
Name	Name	string	用户的名称。
名字	FirstName	string	用户的名字。
姓	LastName	string	用户的姓氏。
CellPhoneNumber	ContactInformation.CellPhoneNumber	string	用户的手机号码。
电子邮件地址	ContactInformation.EmailAddress	string	用户的电子邮件地址。
PreferredCommunicationMethod	ContactInformation.PreferredCommunicationMethod	string	用户首选通信方法。
电话号码	ContactInformation.PhoneNumber	string	用户的电话号码。
FaxNumber	ContactInformation.FaxNumber	string	用户的传真号。
Website	ContactInformation.Website	string	用户的网站。

获取收盘费估计收据

操作 ID:: GetClosingFeeEstimateReceipt

获取收盘费估算收据。

参数

名称	密钥	必需	类型	说明
关闭费用 ID	ClosingFeeID	True	string	关闭费用标识号。

名称	路径	类型	说明
EstimateDate	EstimateDate	string	估计的日期。
TransactionTypeID	Request.TransactionProductType.TransactionTypeID	integer	事务类型标识号。
ProductTypeID	Request.TransactionProductType.ProductTypeID	integer	产品类型标识号。
SettlementStatementVersion	Request.SettlementStatementVersion	string	settlement 语句版本。
SalesPrice	Request.SalesPrice	integer	销售价格。
贷款	Request.Loans	array of object	有关贷款的信息。
LienPosition	Request.Loans.LienPosition	integer	连线位置。
LoanAmount	Request.Loans.LoanAmount	integer	贷款金额。
LoanType	Request.Loans.LoanType	string	贷款类型。
属性	Request.Properties	array of object	估计中的属性。
IsPrimary	Request.Properties.IsPrimary	boolean	这是否是主属性。
StreetNumber	Request.Properties.StreetNumber	string	街道编号。
StreetName	Request.Properties.StreetName	string	街道名称。
City	Request.Properties.City	string	城市名称。
State	Request.Properties.State	string	两个字母状态缩写。
县	Request.Properties.County	string	县名。
邮政编码	Request.Properties.Zip	string	邮政编码。
FilePartners	Request.FilePartners	array of object	文件中的合作伙伴。
PartnerTypeID	Request.FilePartners.PartnerTypeID	integer	合作伙伴类型标识号。
PartnerID	Request.FilePartners.PartnerID	integer	合作伙伴标识号。
PartnerTypeID	Request.FilePartners.PartnerType.PartnerTypeID	integer	合作伙伴类型标识号。
认可	Request.Endorsements	array of object	认可。
Name	Request.Endorsements.Name	string	认可的名称。
ClosingFeeEstimateID	Response.ClosingFeeEstimateID	integer	收盘费估计标识号。
HUDFees	Response.HUDFees	array of object	HUD 费用。
金额	Response.HUDFees.Amount	integer	HUD 费用金额。
Description	Response.HUDFees.Description	string	费用的说明。
LineNumber	Response.HUDFees.LineNumber	string	行号。
BuyerAmount	Response.HUDFees.BuyerAmount	integer	买家金额。
BuyerPOCAmount	Response.HUDFees.BuyerPOCAmount	integer	买家 POC 金额。
SellerAmount	Response.HUDFees.SellerAmount	integer	卖方金额。
SellerPOCAmount	Response.HUDFees.SellerPOCAmount	integer	卖方 POC 金额。
OtherPOCAmount	Response.HUDFees.OtherPOCAmount	integer	其他 POC 金额。
PartnerTypeID	Response.HUDFees.OtherPOCPartnerType.PartnerTypeID	integer	合作伙伴类型标识号。
PartnerTypeName	Response.HUDFees.OtherPOCPartnerType.PartnerTypeName	string	合作伙伴类型名称。
GFE	Response.GFE	array of object	善意估计。
Description	Response.GFE.Description	string	估计的用途。
金额	Response.GFE.Amount	integer	估计金额。
贷款人Premium	Response.Premiums.LendersPremium	integer	贷款人溢价。
FullLendersPremium	Response.Premiums.FullLendersPremium	integer	完整的贷款人溢价。
时间戳	Response.Timestamp	string	时间戳。

获取收盘费估计收据 PDF

操作 ID:: GetClosingFeeEstimateReceiptPDF

获取 PDF 格式的结束费用估算收据。

参数

名称	密钥	必需	类型	说明
关闭费用 ID	ClosingFeeID	True	string	关闭费用标识号。

response: object

获取文档

操作 ID:: GetDocument

获取具有指定 ID 的文档的信息。

参数

名称	密钥	必需	类型	说明
文档 ID	DocumentID	True	string	文档标识号。

名称	路径	类型	说明
DocumentID	DocumentID	integer	文档标识号。
文档名称	DocumentName	string	文档名称。
DocumentTypeID	DocumentType.DocumentTypeID	integer	文档类型名称。
Name	DocumentType.Name	string	文档类型的名称。
Description	Description	string	文档的说明。
InternalOnly	InternalOnly	boolean	文档是否仅在内部。
已批准	Approved	boolean	是否批准该文档。
UserID	CreateUser.UserID	integer	用户标识号。
CreateDate	CreateDate	string	文档的创建日期。

获取注释

操作 ID:: GetNote

获取具有指定 ID 的注释。

参数

名称	密钥	必需	类型	说明
注释 ID	NoteID	True	string	记下标识号。

名称	路径	类型	说明
NoteID	NoteID	integer	便笺标识号。
Subject	Subject	string	备注主题。
Body	Body	string	备注正文。
UserID	CreatedBy.UserID	integer	用户标识号。
CreatedDate	CreatedDate	string	创建笔记的日期。
FileID	FileID	integer	文件标识号。

获取特定文件的作

操作 ID:: GetActionsForSpecificFile

获取指定文件上的所有作。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。

名称	路径	类型	说明
行动	Actions	array of object	操作列表。
FileActionID	Actions.FileActionID	integer	文件作标识号。
ActionTypeID	Actions.ActionType.ActionTypeID	integer	作类型标识号。
Name	Actions.ActionType.Name	string	操作的名称。
显示名称	Actions.ActionType.DisplayName	string	显示名称。
ActionGroupID	Actions.Group.ActionGroupID	integer	作组标识号。
Name	Actions.Group.Name	string	操作的名称。
CoordinatorTypeID	Actions.StartTask.CoordinatorTypeID	integer	协调器类型标识号。
截止日期	Actions.StartTask.DueDate	string	作的截止日期。
DueDateLocked	Actions.StartTask.DueDateLocked	boolean	是否锁定截止日期。
DoneDate	Actions.StartTask.DoneDate	string	作的完成日期。
DoneDateLocked	Actions.StartTask.DoneDateLocked	boolean	是否已锁定完成日期。
UserID	Actions.StartTask.DoneBy.UserID	integer	用户标识号。
Name	Actions.StartTask.DoneBy.Name	string	用户名。
CoordinatorTypeID	Actions.CompleteTask.CoordinatorTypeID	integer	协调器类型标识号。
截止日期	Actions.CompleteTask.DueDate	string	作的截止日期。
DueDateLocked	Actions.CompleteTask.DueDateLocked	boolean	是否锁定截止日期。
DoneDateLocked	Actions.CompleteTask.DoneDateLocked	boolean	是否已锁定完成日期。
UserID	Actions.CompleteTask.DoneBy.UserID	integer	用户标识号。
Name	Actions.CompleteTask.DoneBy.Name	string	用户的名称。

获取特定文件的参与方

操作 ID:: GetPartiesForSpecificFile

获取有关指定文件的参与方及其信息的列表。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。

名称	路径	类型	说明
买家	Buyers	array of object	有关买家的信息。
LegalEntityID	Buyers.LegalEntityID	integer	法律实体标识号。
实体类型	Buyers.EntityType	string	实体类型的名称。
前缀	Buyers.Primary.Prefix	string	买家的前缀。
First	Buyers.Primary.First	string	买家的名字。
中间	Buyers.Primary.Middle	string	买家的中间名称。
Last	Buyers.Primary.Last	string	买家的姓氏。
后缀	Buyers.Primary.Suffix	string	买家的后缀。
前缀	Buyers.Secondary.Prefix	string	辅助买家的前缀。
First	Buyers.Secondary.First	string	次要买家的名字。
中间	Buyers.Secondary.Middle	string	次要买家的中间名称。
Last	Buyers.Secondary.Last	string	次要买家的姓氏。
UsePropertyAddress	Buyers.UsePropertyAddress	boolean	是否使用地址。
Address1	Buyers.Address.Address1	string	街道编号和名称。
City	Buyers.Address.City	string	城市名称。
State	Buyers.Address.State	string	两个字母状态缩写。
邮政编码	Buyers.Address.Zip	string	邮政编码。
MaritalStatus	Buyers.MaritalStatus	string	党的婚姻状况。
Email	Buyers.Email	string	参与方的电子邮件地址。
HomePhone	Buyers.HomePhone	string	聚会的主电话号码。
EmailSecondary	Buyers.EmailSecondary	string	辅助方的电子邮件地址。
卖家	Sellers	array of object	有关卖家的信息。
LegalEntityID	Sellers.LegalEntityID	integer	法律实体标识号。
实体类型	Sellers.EntityType	string	实体类型。
BusinessName	Sellers.Primary.BusinessName	string	业务名称。
UsePropertyAddress	Sellers.UsePropertyAddress	boolean	是否使用地址。
Address1	Sellers.Address.Address1	string	街道编号和名称。
City	Sellers.Address.City	string	城市名称。
State	Sellers.Address.State	string	两个字母状态缩写。
邮政编码	Sellers.Address.Zip	string	邮政编码。
MaritalStatus	Sellers.MaritalStatus	string	党的婚姻状况。
Email	Sellers.Email	string	参与方的电子邮件地址。
客户	Customers	array of string	有关客户的信息。

获取特定文件的合作伙伴

操作 ID:: GetPartnersForSpecificFile

获取有关指定文件的合作伙伴及其信息的列表。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。

名称	路径	类型	说明
合作伙伴	Partners	array of object	有关合作伙伴的信息。
UserID	Partners.PrimaryEmployee.UserID	integer	用户标识号。
Name	Partners.PrimaryEmployee.Name	string	员工的全名。
名字	Partners.PrimaryEmployee.FirstName	string	员工的名字。
姓	Partners.PrimaryEmployee.LastName	string	员工的姓氏。
电话号码	Partners.PrimaryEmployee.ContactInformation.PhoneNumber	string	员工的电话号码。
电子邮件地址	Partners.PrimaryEmployee.ContactInformation.EmailAddress	string	员工的电子邮件地址。
PartnerTypeID	Partners.PartnerTypeID	integer	合作伙伴类型标识号。
PartnerID	Partners.PartnerID	integer	合作伙伴标识号。
PartnerTypeID	Partners.PartnerType.PartnerTypeID	integer	合作伙伴类型标识号。
PartnerTypeName	Partners.PartnerType.PartnerTypeName	string	合作伙伴类型名称。
PartnerName	Partners.PartnerName	string	合作伙伴名称。

获取特定文件的文档

操作 ID:: GetDocumentsForSpecificFile

获取有关指定文件的文档的所有信息。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。

名称	路径	类型	说明
文档	Documents	array of object	文件上的文档列表。
DocumentID	Documents.DocumentID	integer	文档标识号。
文档名称	Documents.DocumentName	string	文档名称。
DocumentTypeID	Documents.DocumentType.DocumentTypeID	integer	文档类型标识号。
Name	Documents.DocumentType.Name	string	文档类型的名称。
Description	Documents.Description	string	文档的说明。
InternalOnly	Documents.InternalOnly	boolean	文档是否仅在内部。
已批准	Documents.Approved	boolean	是否批准该文档。
AssociatedNotes	Documents.AssociatedNotes	array of object	与文档关联的备注。
NoteID	Documents.AssociatedNotes.NoteID	integer	记下标识号。
UserID	Documents.CreateUser.UserID	integer	用户标识号。
Name	Documents.CreateUser.Name	string	用户的名称。
CreateDate	Documents.CreateDate	string	文档的创建日期。
UserID	Documents.ModifyUser.UserID	integer	用户标识号。
Name	Documents.ModifyUser.Name	string	用户的名称。
ModifyDate	Documents.ModifyDate	string	修改文档的日期。

获取特定文件的注释

操作 ID:: GetNotesForSpecificFile

获取指定文件上的注释的列表。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。

名称	路径	类型	说明
注释	Notes	array of object	文件上的备注列表。
NoteID	Notes.NoteID	integer	便笺标识号。
Subject	Notes.Subject	string	备注主题。
Body	Notes.Body	string	备注正文。
UserID	Notes.CreatedBy.UserID	integer	用户标识号。
Name	Notes.CreatedBy.Name	string	用户的全名。
名字	Notes.CreatedBy.FirstName	string	用户的名字。
姓	Notes.CreatedBy.LastName	string	用户的姓氏。
电话号码	Notes.CreatedBy.ContactInformation.PhoneNumber	string	用户电话号码。
电子邮件地址	Notes.CreatedBy.ContactInformation.EmailAddress	string	用户电子邮件地址。
CreatedDate	Notes.CreatedDate	string	创建笔记的日期。
FileID	Notes.FileID	integer	文件标识号。
加速	Notes.Expedite	boolean	是否加快了注释。

获取特定文件的自定义字段

操作 ID:: GetCustomFieldsForSpecificFile

获取指定文件的自定义字段。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。

名称	路径	类型	说明
CustomFields	CustomFields	array of object	文件上的自定义字段列表。
Name	CustomFields.Name	string	自定义域的名称。
价值	CustomFields.Value	string	自定义域的值。
CustomFieldListCount	CustomFieldListCount	integer	文件上的自定义字段数。

获取特定文档中的自定义字段

操作 ID:: GetCustomFieldsOnSpecificDocument

获取指定文档上的自定义字段。

参数

名称	密钥	必需	类型	说明
文件 ID	FileID	True	string	文件标识号。
文档 ID	DocumentID	True	string	文档标识号。

名称	路径	类型	说明
CustomFields	CustomFields	array of object	自定义字段。
Name	CustomFields.Name	string	自定义域的名称。
价值	CustomFields.Value	string	自定义域的值。
CustomFieldListCount	CustomFieldListCount	integer	文件上的自定义字段数。

获取用于估计和订单放置的事务和产品类型

操作 ID:: GetTransactionAndProductTypesForEstimationAndOrderPlacement

获取用于费用估算和下单的交易类型和产品类型。

参数

名称	密钥	必需	类型	说明
State	State		string	估计属性位置的状态。
县	County		string	估计物业位置的县。

名称	路径	类型	说明
		array of object
TransactionType	TransactionType	string	交易记录类型。
TransactionTypeID	TransactionTypeID	integer	事务类型标识号。
ProductType	ProductType	string	产品类型。
ProductTypeID	ProductTypeID	integer	产品类型标识号。
AncillaryProducts	AncillaryProducts	array of object	辅助产品。
Name	AncillaryProducts.Name	string	辅助产品的名称。
ID	AncillaryProducts.ID	integer	产品的标识号。
选项	AncillaryProducts.Options	array of object	选项。
ID	AncillaryProducts.Options.ID	integer	选项的标识号。
Name	AncillaryProducts.Options.Name	string	选项的名称。
AddOnProducts	AddOnProducts	array of object	在产品中添加的项。
TransactionType	AddOnProducts.TransactionType	string	交易记录类型。
TransactionTypeID	AddOnProducts.TransactionTypeID	integer	事务类型标识号。
ProductType	AddOnProducts.ProductType	string	产品类型。
ProductTypeID	AddOnProducts.ProductTypeID	integer	产品类型标识号。

定义

对象

这是类型“object”。

通过