資訊查詢
InfoQuery 可讓您在低程式碼解決方案中利用 Resware 資料,實現業務自動化。 您可以查看、創建、刪除和更新文件、文檔、合作夥伴等。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | InfoQuery 支援 |
| URL | https://infoquery.pro/support/ |
| support@infoquery.pro |
| 連接器中繼資料 | |
|---|---|
| Publisher | InfoQuery 有限責任公司 |
| 網站 | 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 Title Explorer 以查看所有可用的動作。
- 選取動作之後,您將需要建立新的連線。
- 輸入連線名稱、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 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API 金鑰 | securestring | 此 API 的 API 金鑰 | 對 |
| ResWare 使用者名稱 | 字串 | ResWare 的使用者名稱 | 對 |
| ResWare 密碼 | securestring | ResWare 的密碼 | 對 |
| ResWare 入口網站 URL | 字串 | ResWare 的入口網站 URL | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 刪除先前下達的訂單 |
取消先前下達的訂單。 |
| 刪除特定檔案上的合作夥伴 |
從指定的檔案中移除夥伴。 |
| 取得合作夥伴資訊 |
取得具有指定識別碼的合作夥伴相關資訊。 |
| 取得成交費估算收據 |
取得成交費估算收據。 |
| 取得成交費估算收據 PDF |
取得 pdf 格式的成交費估算收據。 |
| 取得文件 |
取得具有指定 ID 之文件的資訊。 |
| 取得特定檔案的動作 |
取得指定檔案上的所有動作。 |
| 取得特定檔案的檔 |
取得指定檔案上文件的所有相關資訊。 |
| 取得筆記 |
取得具有指定 ID 的附註。 |
| 取消先前下達的訂單 |
取消先前下達的訂單。 |
| 在特定文檔上添加或更新自定義字段 |
在指定檔案上新增或更新指定文件上的自訂欄位。 |
| 在特定檔案上建立新文件 |
在指定的檔案上建立新文件。 |
| 在特定檔案上新增或更新自訂欄位 |
新增或更新指定檔案上的自訂欄位。 |
| 將 Web URL 文件上傳至特定檔案 |
在指定的檔案上載入 Web URL 文件。 |
| 將動作新增至檔案 |
將動作新增至指定的檔案。 |
| 將合作夥伴新增至特定檔案 |
將夥伴新增至指定的檔案。 |
| 將新的合作夥伴員工新增至合作夥伴公司 |
將新的合作夥伴員工新增至合作夥伴公司。 |
| 將註釋新增至檔案 |
將新註記加入至指定的檔案。 |
| 建立新檔案 |
建立新檔案。 |
| 從給定的搜尋條件取得檔案 |
根據給定的搜尋條件取得檔案及其資訊的清單。 |
| 更新合作夥伴員工 |
更新合作夥伴員工的資訊。 |
| 更新檔案的動作 |
更新指定檔案的動作。 可以更新動作群組 ID 和開始/完成協調器類型 ID、合作夥伴類型 ID、到期日、鎖定到期日和鎖定完成日期。 此 API 呼叫無法用來將動作標示為已啟動或已完成。 |
| 更新特定檔案的合作夥伴資訊 |
更新指定檔案上的合作夥伴資訊。 |
| 獲取特定文件的各方 |
取得指定檔案上當事人及其資訊的清單。 |
| 獲取特定文件的合作夥伴 |
取得合作夥伴清單及其在指定檔案上的資訊。 |
| 獲取特定文件的自定義字段 |
取得指定檔案的自訂欄位。 |
| 獲取特定文件的註釋 |
取得指定檔案上的附註清單。 |
| 獲取特定文檔的自定義字段 |
取得指定文件上的自訂欄位。 |
| 獲取用於估算和下訂單的交易和產品類型 |
獲取交易類型和產品類型,用於費用估算和下訂單。 |
| 獲取當前用戶信息 |
取得目前連線使用者的相關資訊。 |
| 預估成交費 |
估算成交費用。 |
刪除先前下達的訂單
取消先前下達的訂單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
檔案識別碼
|
FileID | integer |
檔案識別號碼。 |
傳回
- response
- object
刪除特定檔案上的合作夥伴
從指定的檔案中移除夥伴。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
合作夥伴類型標識符
|
PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
|
合作夥伴識別碼 (PartnerID)
|
PartnerID | integer |
合作夥伴識別號碼。 |
|
|
合作夥伴類型標識符
|
PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
傳回
- response
- object
取得合作夥伴資訊
取得具有指定識別碼的合作夥伴相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
合作夥伴公司 ID
|
PartnerCompanyID | True | string |
合作夥伴公司識別號碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
合作夥伴公司標識符
|
PartnerCompanyID | integer |
合作夥伴公司識別碼。 |
|
合作夥伴類型
|
PartnerTypes | array of object |
有關合作夥伴類型的資訊。 |
|
合作夥伴類型標識符
|
PartnerTypes.PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
合作夥伴類型名稱
|
PartnerTypes.PartnerTypeName | string |
合作夥伴類型名稱。 |
|
OfficeID
|
OfficeID | integer |
辦公室識別號碼。 |
|
合作夥伴名稱
|
PartnerName | string |
夥伴名稱。 |
|
公司簡介
|
CompanyAbbreviation | string |
公司簡稱。 |
|
適當的公司名稱
|
ProperCompanyName | string |
公司全名。 |
|
地址1
|
MailingAddress.Address1 | string |
門牌號碼和名稱。 |
|
地址2
|
MailingAddress.Address2 | string |
更多地址資訊。 |
|
城市
|
MailingAddress.City | string |
城市名稱。 |
|
State
|
MailingAddress.State | string |
這兩個字母是縮寫。 |
|
壓縮檔
|
MailingAddress.Zip | string |
郵政編碼。 |
|
電話號碼
|
ContactInformation.PhoneNumber | string |
合作夥伴電話號碼。 |
|
HomePhoneNumber
|
ContactInformation.HomePhoneNumber | string |
合作夥伴的住家電話號碼。 |
|
手機號碼
|
ContactInformation.CellPhoneNumber | string |
合作夥伴手機號碼。 |
|
語音信箱
|
ContactInformation.Voicemail | string |
合作夥伴語音信箱號碼。 |
|
傳真號碼
|
ContactInformation.FaxNumber | string |
合作夥伴傳真號碼。 |
|
電子郵件地址
|
ContactInformation.EmailAddress | string |
合作夥伴電子郵件地址。 |
|
PreferredCommunication方法
|
ContactInformation.PreferredCommunicationMethod | string |
合作夥伴更喜歡溝通方式。 |
|
網站
|
ContactInformation.Website | string |
合作夥伴網站 URL。 |
|
ID
|
CompanyInformation.ParentCompany.ID | integer |
識別號碼。 |
|
名稱
|
CompanyInformation.ParentCompany.Name | string |
母公司名稱。 |
|
ID
|
CompanyInformation.PartnerEntity.ID | integer |
識別號碼。 |
|
名稱
|
CompanyInformation.PartnerEntity.name | string |
合作夥伴實體名稱。 |
|
是可計費
|
CompanyInformation.IsBillable | boolean |
合作夥伴是否可計費。 |
|
是可發票
|
CompanyInformation.IsInvoiceable | boolean |
該房產是否可開立發票。 |
|
稅務編號
|
CompanyInformation.TaxID | string |
合作夥伴稅務識別號碼。 |
|
會計代碼
|
CompanyInformation.AccountingCode | string |
會計代碼。 |
|
評價特別說明
|
CompanyInformation.CommentsSpecialInstructions | string |
對合作夥伴的評論。 |
|
DontAllowSelectionInSettlement
|
CompanyInformation.DontAllowSelectionInSettlement | boolean |
是否允許在結算中選擇。 |
|
需求1099
|
CompanyInformation.Needs1099 | boolean |
是否需要 1099。 |
|
MWBE
|
CompanyInformation.MWBE | boolean |
合夥人是否是 MWBE? |
|
將文件傳送為WebLinks
|
SendDocumentsAsWebLinks | boolean |
是否以 Web 連結形式傳送文件。 |
|
WireConfirmationEmailTemplateID
|
WireConfirmationEmailTemplateID | integer |
配線確認範本識別號碼。 |
|
使用時付款
|
CourierAddress.UseOnDisbursements | boolean |
是否將其用於支出。 |
|
地址1
|
CourierAddress.Address1 | string |
門牌號碼和名稱。 |
|
地址2
|
CourierAddress.Address2 | string |
更多地址資訊。 |
|
城市
|
CourierAddress.City | string |
城市名稱。 |
|
State
|
CourierAddress.State | string |
這兩個字母是縮寫。 |
|
壓縮檔
|
CourierAddress.Zip | string |
郵政編碼。 |
取得成交費估算收據
取得成交費估算收據。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
成交費 ID
|
ClosingFeeID | True | string |
成交費識別號碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
預估日期
|
EstimateDate | string |
預估日期。 |
|
交易類型標識符
|
Request.TransactionProductType.TransactionTypeID | integer |
交易類型識別號碼。 |
|
產品類型標識碼
|
Request.TransactionProductType.ProductTypeID | integer |
產品類型識別號碼。 |
|
結算陳述式版本
|
Request.SettlementStatementVersion | string |
結算報表版本。 |
|
銷售價格
|
Request.SalesPrice | integer |
銷售價格。 |
|
貸款
|
Request.Loans | array of object |
有關貸款的資訊。 |
|
留置權職位
|
Request.Loans.LienPosition | integer |
留置權位置。 |
|
貸款金額
|
Request.Loans.LoanAmount | integer |
貸款金額。 |
|
貸款類型
|
Request.Loans.LoanType | string |
貸款類型。 |
|
屬性
|
Request.Properties | array of object |
估計中的屬性。 |
|
是主要
|
Request.Properties.IsPrimary | boolean |
無論這是否是主要屬性。 |
|
街道號碼
|
Request.Properties.StreetNumber | string |
街道號碼。 |
|
街道名稱
|
Request.Properties.StreetName | string |
街道名稱。 |
|
城市
|
Request.Properties.City | string |
城市名稱。 |
|
State
|
Request.Properties.State | string |
這兩個字母是縮寫。 |
|
縣
|
Request.Properties.County | string |
縣名稱。 |
|
壓縮檔
|
Request.Properties.Zip | string |
郵政編碼。 |
|
檔案合作夥伴
|
Request.FilePartners | array of object |
檔案上的合作夥伴。 |
|
合作夥伴類型標識符
|
Request.FilePartners.PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
合作夥伴識別碼 (PartnerID)
|
Request.FilePartners.PartnerID | integer |
合作夥伴識別號碼。 |
|
合作夥伴類型標識符
|
Request.FilePartners.PartnerType.PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
背書
|
Request.Endorsements | array of object |
背書。 |
|
名稱
|
Request.Endorsements.Name | string |
背書的名稱。 |
|
ClosingFeeEstimateID
|
Response.ClosingFeeEstimateID | integer |
結算費預估識別號。 |
|
HUD菲斯
|
Response.HUDFees | array of object |
HUD 費用。 |
|
總數
|
Response.HUDFees.Amount | integer |
HUD 費用的金額。 |
|
Description
|
Response.HUDFees.Description | string |
費用說明。 |
|
行號
|
Response.HUDFees.LineNumber | string |
行號。 |
|
買方金額
|
Response.HUDFees.BuyerAmount | integer |
買方金額。 |
|
買家POCAmount
|
Response.HUDFees.BuyerPOCAmount | integer |
買方 POC 金額。 |
|
賣方金額
|
Response.HUDFees.SellerAmount | integer |
賣方金額。 |
|
賣家POCAmount
|
Response.HUDFees.SellerPOCAmount | integer |
賣方 POC 金額。 |
|
其他POCA安裝
|
Response.HUDFees.OtherPOCAmount | integer |
另一個 POC 金額。 |
|
合作夥伴類型標識符
|
Response.HUDFees.OtherPOCPartnerType.PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
合作夥伴類型名稱
|
Response.HUDFees.OtherPOCPartnerType.PartnerTypeName | string |
合作夥伴類型名稱。 |
|
GFE的
|
Response.GFE | array of object |
善意估計。 |
|
Description
|
Response.GFE.Description | string |
估計值的用途。 |
|
總數
|
Response.GFE.Amount | integer |
估計值的金額。 |
|
貸款人溢價
|
Response.Premiums.LendersPremium | integer |
貸方溢價。 |
|
FullLendersPremium
|
Response.Premiums.FullLendersPremium | integer |
全額貸方溢價。 |
|
時間戳
|
Response.Timestamp | string |
時間戳記。 |
取得成交費估算收據 PDF
取得 pdf 格式的成交費估算收據。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
成交費 ID
|
ClosingFeeID | True | string |
成交費識別號碼。 |
傳回
- response
- object
取得文件
取得具有指定 ID 之文件的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
文件 ID
|
DocumentID | True | string |
文件識別號碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件識別碼
|
DocumentID | integer |
文件識別號碼。 |
|
文件名稱
|
DocumentName | string |
檔名稱。 |
|
文件類型識別碼
|
DocumentType.DocumentTypeID | integer |
文件類型名稱。 |
|
名稱
|
DocumentType.Name | string |
文件類型的名稱。 |
|
Description
|
Description | string |
文件的描述。 |
|
僅內部
|
InternalOnly | boolean |
文件是否僅屬於內部文件。 |
|
已核准
|
Approved | boolean |
文件是否獲得批准。 |
|
UserID
|
CreateUser.UserID | integer |
使用者識別號碼。 |
|
建立日期
|
CreateDate | string |
文件的建立日期。 |
取得特定檔案的動作
取得指定檔案上的所有動作。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
行動
|
Actions | array of object |
動作清單。 |
|
檔案動作標識碼
|
Actions.FileActionID | integer |
檔案動作識別碼。 |
|
動作類型識別碼
|
Actions.ActionType.ActionTypeID | integer |
動作類型識別號碼。 |
|
名稱
|
Actions.ActionType.Name | string |
動作的名稱。 |
|
顯示名稱
|
Actions.ActionType.DisplayName | string |
顯示名稱。 |
|
動作群組識別碼
|
Actions.Group.ActionGroupID | integer |
動作群組識別號碼。 |
|
名稱
|
Actions.Group.Name | string |
動作的名稱。 |
|
協調器類型識別碼
|
Actions.StartTask.CoordinatorTypeID | integer |
協調器類型識別號碼。 |
|
截止日期
|
Actions.StartTask.DueDate | string |
動作的到期日。 |
|
到期日期鎖定
|
Actions.StartTask.DueDateLocked | boolean |
到期日是否已鎖定。 |
|
完成日期
|
Actions.StartTask.DoneDate | string |
動作的完成日期。 |
|
完成日期鎖定
|
Actions.StartTask.DoneDateLocked | boolean |
完成日期是否已鎖定。 |
|
UserID
|
Actions.StartTask.DoneBy.UserID | integer |
使用者識別號碼。 |
|
名稱
|
Actions.StartTask.DoneBy.Name | string |
使用者名稱。 |
|
協調器類型識別碼
|
Actions.CompleteTask.CoordinatorTypeID | integer |
協調器類型識別號碼。 |
|
截止日期
|
Actions.CompleteTask.DueDate | string |
動作的到期日。 |
|
到期日期鎖定
|
Actions.CompleteTask.DueDateLocked | boolean |
到期日是否已鎖定。 |
|
完成日期鎖定
|
Actions.CompleteTask.DoneDateLocked | boolean |
完成日期是否已鎖定。 |
|
UserID
|
Actions.CompleteTask.DoneBy.UserID | integer |
使用者識別號碼。 |
|
名稱
|
Actions.CompleteTask.DoneBy.Name | string |
用戶的名稱。 |
取得特定檔案的檔
取得指定檔案上文件的所有相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Documents
|
Documents | array of object |
檔案中的文件清單。 |
|
文件識別碼
|
Documents.DocumentID | integer |
文件識別號碼。 |
|
文件名稱
|
Documents.DocumentName | string |
檔名稱。 |
|
文件類型識別碼
|
Documents.DocumentType.DocumentTypeID | integer |
文件類型識別號碼。 |
|
名稱
|
Documents.DocumentType.Name | string |
文件類型的名稱。 |
|
Description
|
Documents.Description | string |
文件的描述。 |
|
僅內部
|
Documents.InternalOnly | boolean |
文件是否僅屬於內部文件。 |
|
已核准
|
Documents.Approved | boolean |
文件是否獲得批准。 |
|
相關註釋
|
Documents.AssociatedNotes | array of object |
與文件相關聯的附註。 |
|
NoteID
|
Documents.AssociatedNotes.NoteID | integer |
註釋識別號碼。 |
|
UserID
|
Documents.CreateUser.UserID | integer |
使用者識別號碼。 |
|
名稱
|
Documents.CreateUser.Name | string |
用戶的名稱。 |
|
建立日期
|
Documents.CreateDate | string |
文件的建立日期。 |
|
UserID
|
Documents.ModifyUser.UserID | integer |
使用者識別號碼。 |
|
名稱
|
Documents.ModifyUser.Name | string |
用戶的名稱。 |
|
修改日期
|
Documents.ModifyDate | string |
文件的修改日期。 |
取得筆記
取得具有指定 ID 的附註。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
附註 ID
|
NoteID | True | string |
註釋識別號碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
NoteID
|
NoteID | integer |
註釋識別號碼。 |
|
主旨
|
Subject | string |
筆記主題。 |
|
身體
|
Body | string |
註解內文。 |
|
UserID
|
CreatedBy.UserID | integer |
使用者識別號碼。 |
|
CreatedDate
|
CreatedDate | string |
備註的建立日期。 |
|
檔案識別碼
|
FileID | integer |
檔案識別號碼。 |
取消先前下達的訂單
取消先前下達的訂單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
檔案識別碼
|
FileID | integer |
檔案識別號碼。 |
傳回
- response
- object
在特定文檔上添加或更新自定義字段
在指定檔案上新增或更新指定文件上的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
文件 ID
|
DocumentID | True | string |
文件識別號碼。 |
|
名稱
|
Name | string |
自訂欄位的名稱。 |
|
|
價值觀
|
Value | string |
自訂欄位的值。 |
傳回
- response
- object
在特定檔案上建立新文件
在指定的檔案上建立新文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
文件名稱
|
DocumentName | string |
檔名稱。 |
|
|
文件類型識別碼
|
DocumentTypeID | integer |
文件類型識別號碼。 |
|
|
Description
|
Description | string |
文件的描述。 |
|
|
僅內部
|
InternalOnly | string |
文件是否僅屬於內部文件。 |
|
|
文件內文
|
DocumentBody | string |
文件內文。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件識別碼
|
Document.DocumentID | integer |
文件識別號碼。 |
在特定檔案上新增或更新自訂欄位
新增或更新指定檔案上的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
名稱
|
Name | string |
自訂欄位的名稱。 |
|
|
價值觀
|
Value | string |
自訂欄位的值。 |
傳回
- response
- object
將 Web URL 文件上傳至特定檔案
在指定的檔案上載入 Web URL 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
文件名稱
|
DocumentName | string |
檔名稱。 |
|
|
文件類型識別碼
|
DocumentTypeID | integer |
文件類型識別號碼。 |
|
|
Description
|
Description | string |
文件的描述。 |
|
|
僅內部
|
InternalOnly | boolean |
文件是否僅屬於內部文件。 |
|
|
Web網址
|
WebURL | string |
文件的 Web URL。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件識別碼
|
Document.DocumentID | integer |
文件識別號碼。 |
將動作新增至檔案
將動作新增至指定的檔案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
動作類型識別碼
|
ActionTypeID | integer |
動作類型識別號碼。 |
|
|
動作群組識別碼
|
ActionGroupID | integer |
動作群組識別號碼。 |
|
|
協調器類型識別碼
|
CoordinatorTypeID | integer |
協調器類型識別號碼。 |
|
|
截止日期
|
DueDate | string |
動作的到期日。 |
|
|
合作夥伴類型標識符
|
PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
|
截止日期
|
DueDate | string |
動作的到期日。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔案動作標識碼
|
FileActionID | integer |
檔案動作識別碼。 |
將合作夥伴新增至特定檔案
將夥伴新增至指定的檔案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
UserID
|
UserID | integer |
使用者識別號碼。 |
|
|
UserID
|
UserID | integer |
使用者識別號碼。 |
|
|
合作夥伴類型標識符
|
PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
|
合作夥伴識別碼 (PartnerID)
|
PartnerID | integer |
合作夥伴識別號碼。 |
|
|
合作夥伴類型標識符
|
PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
傳回
- response
- object
將新的合作夥伴員工新增至合作夥伴公司
將新的合作夥伴員工新增至合作夥伴公司。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
合作夥伴公司 ID
|
PartnerCompanyID | True | string |
合作夥伴公司識別號碼。 |
|
密碼
|
Password | string |
新員工的密碼。 |
|
|
密碼到期日期
|
PasswordExpirationDate | string |
密碼到期的日期。 |
|
|
已啟用
|
Enabled | boolean |
是否啟用新員工使用。 |
|
|
網站訪問
|
WebsiteAccess | boolean |
新員工是否具有網站存取權限。 |
|
|
名稱
|
Name | string |
新員工的全名。 |
|
|
FirstName
|
FirstName | string |
新員工的名字。 |
|
|
姓氏
|
LastName | string |
新員工的姓氏。 |
|
|
電子郵件地址
|
EmailAddress | string |
新員工的電子郵件地址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
合作夥伴公司標識符
|
Employee.PartnerCompanyID | integer |
合作夥伴公司識別碼。 |
|
已啟用
|
Employee.Enabled | boolean |
新員工是否已啟用使用。 |
|
網站訪問
|
Employee.WebsiteAccess | boolean |
員工是否有網站存取權。 |
|
UserID
|
Employee.UserID | integer |
新員工的識別號碼。 |
|
名稱
|
Employee.Name | string |
員工的全名。 |
|
FirstName
|
Employee.FirstName | string |
員工的名字。 |
|
姓氏
|
Employee.LastName | string |
員工的姓氏。 |
|
電子郵件地址
|
Employee.ContactInformation.EmailAddress | string |
員工的電子郵件地址。 |
將註釋新增至檔案
將新註記加入至指定的檔案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
主旨
|
Subject | string |
筆記主題。 |
|
|
身體
|
Body | string |
註解內文。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
NoteID
|
note.NoteID | integer |
註釋識別號碼。 |
建立新檔案
建立新檔案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
實體類型
|
EntityType | string |
實體類型的名稱。 個人、法人等 |
|
|
IsPrimary交易
|
IsPrimaryTransactee | boolean |
買方是否是主要交易對象。 |
|
|
First
|
First | string |
買方的名字。 |
|
|
Last
|
Last | string |
買方的姓氏。 |
|
|
使用屬性位址
|
UsePropertyAddress | boolean |
郵寄地址是否應該用作新檔案的屬性地址。 |
|
|
地址1
|
Address1 | string |
門牌號碼和名稱。 |
|
|
城市
|
City | string |
城市名稱。 |
|
|
State
|
State | string |
這兩個字母是縮寫。 |
|
|
壓縮檔
|
Zip | string |
郵政編碼。 |
|
|
MaritalStatus
|
MaritalStatus | string |
買方的婚姻狀況。 |
|
|
Email
|
string |
買方的電子郵件地址。 |
||
|
實體類型
|
EntityType | string |
實體類型的名稱。 個人、法人等 |
|
|
IsPrimary交易
|
IsPrimaryTransactee | boolean |
賣方是否是主要交易對象。 |
|
|
First
|
First | string |
賣家的名字。 |
|
|
Last
|
Last | string |
賣家的姓氏。 |
|
|
使用屬性位址
|
UsePropertyAddress | boolean |
郵寄地址是否應該用作新檔案的屬性地址。 |
|
|
地址1
|
Address1 | string |
門牌號碼和名稱。 |
|
|
城市
|
City | string |
城市名稱。 |
|
|
State
|
State | string |
這兩個字母是縮寫。 |
|
|
壓縮檔
|
Zip | string |
郵政編碼。 |
|
|
MaritalStatus
|
MaritalStatus | string |
賣方的婚姻狀況。 |
|
|
Email
|
string |
賣家的電子郵件地址。 |
||
|
預估結算日期
|
EstimatedSettlementDate | string |
訂單的預計結算日期。 |
|
|
交易類型標識符
|
TransactionTypeID | integer |
交易類型識別號碼。 |
|
|
產品類型標識碼
|
ProductTypeID | integer |
產品類型識別號碼。 |
|
|
銷售價格
|
SalesPrice | integer |
房產的銷售價格。 |
|
|
用戶端檔案編號
|
ClientFileNumber | string |
用戶端檔案號碼。 |
|
|
PiggybackFileNumber
|
PiggybackFileNumber | string |
捎帶檔案號碼。 |
|
|
主要檔案編號
|
MainFileNumber | string |
主要檔案號碼。 |
|
|
來源企業ID
|
SourceOfBusinessID | integer |
企業識別號碼的來源。 |
|
|
備註
|
Note | string |
要新增至新檔案的附註。 |
|
|
名稱
|
Name | string |
自訂欄位的名稱。 |
|
|
價值觀
|
Value | string |
自訂欄位的值 |
|
|
留置權職位
|
LienPosition | integer |
留置權位置。 |
|
|
借用號碼
|
LoanNumber | string |
借閱號碼。 |
|
|
貸款金額
|
LoanAmount | integer |
貸款金額。 |
|
|
貸款類型
|
LoanType | string |
貸款類型。 |
|
|
是主要
|
IsPrimary | boolean |
無論這是否是主要屬性地址。 |
|
|
街道號碼
|
StreetNumber | string |
街道號碼。 |
|
|
街道名稱
|
StreetName | string |
街道名稱。 |
|
|
城市
|
City | string |
城市名稱。 |
|
|
State
|
State | string |
這兩個字母是縮寫。 |
|
|
縣
|
County | string |
該物業所在的縣。 |
|
|
壓縮檔
|
Zip | string |
郵政編碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔案識別碼
|
FileID | integer |
新檔案的識別號碼。 |
|
檔案編號
|
FileNumber | string |
新檔案的檔案號碼。 |
|
Warnings
|
Warnings | array of string |
有關新檔案的警告。 |
從給定的搜尋條件取得檔案
根據給定的搜尋條件取得檔案及其資訊的清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案編號
|
FileNumber | string |
檔案號碼。 |
|
|
檔案識別碼
|
FileID | integer |
檔案識別號碼。 |
|
|
OfficeID
|
OfficeID | integer |
辦公室識別號碼。 |
|
|
用戶端檔案編號
|
ClientsFileNumber | string |
用戶端檔案號碼。 |
|
|
交易類型標識符
|
TransactionTypeID | integer |
交易類型識別號碼。 |
|
|
產品類型標識碼
|
ProductTypeID | integer |
產品類型識別號碼。 |
|
|
狀態標識碼
|
StatusID | integer |
狀態識別號碼。 |
|
|
名稱
|
Name | string |
狀態的名稱。 |
|
|
保單編號
|
PolicyNumber | string |
保單號碼。 |
|
|
搜尋編號
|
SearchNumber | string |
搜尋號碼。 |
|
|
借用號碼
|
LoanNumber | string |
借閱號碼。 |
|
|
是主要
|
IsPrimary | boolean |
無論這是否是主要屬性地址。 |
|
|
街道號碼
|
StreetNumber | string |
街道號碼。 |
|
|
街道名稱
|
StreetName | string |
街道名稱。 |
|
|
城市
|
City | string |
城市名稱。 |
|
|
State
|
State | string |
這兩個字母是縮寫。 |
|
|
壓縮檔
|
Zip | string |
郵政編碼。 |
|
|
細分
|
Subdivision | string |
該物業所在的分區。 |
|
|
ParcelID
|
ParcelID | string |
包裹識別號碼。 |
|
|
實體類型
|
EntityType | string |
實體類型。 |
|
|
First
|
First | string |
派對的名字。 |
|
|
Last
|
Last | string |
派對的姓氏。 |
|
|
使用屬性位址
|
UsePropertyAddress | boolean |
無論這是否是主要屬性地址。 |
|
|
MaritalStatus
|
MaritalStatus | string |
當事人的婚姻狀況。 |
|
|
UserID
|
UserID | integer |
使用者識別號碼。 |
|
|
合作夥伴類型標識符
|
PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
|
合作夥伴識別碼 (PartnerID)
|
PartnerID | integer |
合作夥伴識別號碼。 |
|
|
合作夥伴類型標識符
|
PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
|
開啟開始日期
|
OpenedFromDate | string |
檔案開啟的日期。 |
|
|
OpenedToDate
|
OpenedToDate | string |
檔案關閉的日期。 |
傳回
- response
- object
更新合作夥伴員工
更新合作夥伴員工的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
使用者識別碼
|
UserID | True | string |
使用者識別碼。 |
|
合作夥伴公司 ID
|
PartnerCompanyID | True | string |
合作夥伴公司識別號碼。 |
|
密碼
|
Password | string |
員工密碼。 |
|
|
密碼到期日期
|
PasswordExpirationDate | string |
密碼到期的日期。 |
|
|
角色標識碼
|
RoleID | integer |
角色識別號碼。 |
|
|
名稱
|
Name | string |
角色的名稱。 |
|
|
已啟用
|
Enabled | boolean |
員工是否已啟用使用。 |
|
|
網站訪問
|
WebsiteAccess | boolean |
員工是否有網站存取權。 |
|
|
名稱
|
Name | string |
員工的全名。 |
|
|
FirstName
|
FirstName | string |
員工的名字。 |
|
|
姓氏
|
LastName | string |
員工的姓氏。 |
|
|
電子郵件地址
|
EmailAddress | string |
員工的電子郵件地址。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
合作夥伴公司標識符
|
Employee.PartnerCompanyID | integer |
合作夥伴公司識別碼。 |
|
角色
|
Employee.Roles | array of object |
員工的角色。 |
|
角色標識碼
|
Employee.Roles.RoleID | integer |
角色識別號碼。 |
|
名稱
|
Employee.Roles.Name | string |
角色的名稱。 |
|
已啟用
|
Employee.Enabled | boolean |
員工是否已啟用使用。 |
|
網站訪問
|
Employee.WebsiteAccess | boolean |
員工是否有網站存取權。 |
|
UserID
|
Employee.UserID | integer |
使用者識別號碼。 |
|
名稱
|
Employee.Name | string |
員工的全名。 |
|
FirstName
|
Employee.FirstName | string |
員工的名字。 |
|
姓氏
|
Employee.LastName | string |
員工的姓氏。 |
|
電子郵件地址
|
Employee.ContactInformation.EmailAddress | string |
員工的電子郵件地址。 |
更新檔案的動作
更新指定檔案的動作。 可以更新動作群組 ID 和開始/完成協調器類型 ID、合作夥伴類型 ID、到期日、鎖定到期日和鎖定完成日期。 此 API 呼叫無法用來將動作標示為已啟動或已完成。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
檔案動作 ID
|
FileActionID | True | string |
動作的識別號碼。 |
|
協調器類型識別碼
|
CoordinatorTypeID | integer |
協調器類型識別號碼。 |
|
|
截止日期
|
DueDate | string |
動作的到期日。 |
|
|
完成日期鎖定
|
DoneDateLocked | boolean |
完成日期是否已鎖定。 |
|
|
協調器類型識別碼
|
CoordinatorTypeID | integer |
協調器類型識別號碼。 |
|
|
截止日期
|
DueDate | string |
動作的到期日。 |
|
|
完成日期鎖定
|
DoneDateLocked | boolean |
完成日期是否已鎖定。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔案動作標識碼
|
FileActionID | integer |
動作的識別號碼。 |
更新特定檔案的合作夥伴資訊
更新指定檔案上的合作夥伴資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
合作夥伴 ID
|
PartnerID | True | string |
合作夥伴識別號碼。 |
|
檔案識別碼
|
FileID | integer |
檔案識別號碼。 |
|
|
UserID
|
UserID | integer |
使用者識別號碼。 |
|
|
名稱
|
Name | string |
員工的全名。 |
|
|
FirstName
|
FirstName | string |
員工的名字。 |
|
|
姓氏
|
LastName | string |
員工的姓氏。 |
|
|
電話號碼
|
PhoneNumber | string |
員工的電話號碼。 |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
員工的住家電話號碼。 |
|
|
手機號碼
|
CellPhoneNumber | string |
員工的手機號碼。 |
|
|
語音信箱
|
Voicemail | string |
員工的語音信箱。 |
|
|
傳真號碼
|
FaxNumber | string |
員工的傳真號碼。 |
|
|
電子郵件地址
|
EmailAddress | string |
員工的電子郵件地址。 |
|
|
PreferredCommunication方法
|
PreferredCommunicationMethod | string |
員工更喜歡溝通方式。 |
|
|
網站
|
Website | string |
員工的網路連結。 |
|
|
UserID
|
UserID | integer |
使用者識別號碼。 |
|
|
名稱
|
Name | string |
次要員工的全名。 |
|
|
FirstName
|
FirstName | string |
次要員工的名字。 |
|
|
姓氏
|
LastName | string |
次要員工的姓氏。 |
|
|
電話號碼
|
PhoneNumber | string |
次要員工的電話號碼。 |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
次要員工的住家電話號碼。 |
|
|
手機號碼
|
CellPhoneNumber | string |
次要員工的手機號碼。 |
|
|
語音信箱
|
Voicemail | string |
次要員工的語音信箱。 |
|
|
傳真號碼
|
FaxNumber | string |
次要員工的傳真號碼。 |
|
|
電子郵件地址
|
EmailAddress | string |
次要員工的電子郵件地址。 |
|
|
PreferredCommunication方法
|
PreferredCommunicationMethod | string |
中學員工更喜歡溝通方式。 |
|
|
網站
|
Website | string |
次要員工的網路連結。 |
|
|
參考編號
|
ReferenceNumber | string |
參考編號。 |
|
|
遠端檔案編號
|
RemoteFileNumber | string |
遠端檔案號碼。 |
|
|
合作夥伴類型標識符
|
PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
|
合作夥伴識別碼 (PartnerID)
|
PartnerID | integer |
合作夥伴識別號碼。 |
|
|
合作夥伴類型標識符
|
PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
|
合作夥伴類型名稱
|
PartnerTypeName | string |
合作夥伴類型名稱。 |
|
|
OfficeID
|
OfficeID | integer |
辦公室識別號碼。 |
|
|
合作夥伴名稱
|
PartnerName | string |
夥伴名稱。 |
|
|
地址1
|
Address1 | string |
門牌號碼和名稱。 |
|
|
地址2
|
Address2 | string |
更多地址資訊。 |
|
|
城市
|
City | string |
城市名稱。 |
|
|
State
|
State | string |
這兩個字母是縮寫。 |
|
|
壓縮檔
|
Zip | string |
郵政編碼。 |
|
|
電話號碼
|
PhoneNumber | string |
合作夥伴電話號碼。 |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
合作夥伴的住家電話號碼。 |
|
|
手機號碼
|
CellPhoneNumber | string |
合作夥伴手機號碼。 |
|
|
語音信箱
|
Voicemail | string |
合作夥伴語音信箱號碼。 |
|
|
傳真號碼
|
FaxNumber | string |
合作夥伴傳真號碼。 |
|
|
電子郵件地址
|
EmailAddress | string |
合作夥伴電子郵件地址。 |
|
|
PreferredCommunication方法
|
PreferredCommunicationMethod | string |
合作夥伴更喜歡溝通方式。 |
|
|
網站
|
Website | string |
合作夥伴網站 URL。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檔案識別碼
|
FileID | integer |
檔案識別號碼。 |
|
檔案編號
|
FileNumber | string |
檔案編號 |
|
UserID
|
PrimaryEmployee.UserID | integer |
使用者識別號碼。 |
|
名稱
|
PrimaryEmployee.Name | string |
員工的全名。 |
|
FirstName
|
PrimaryEmployee.FirstName | string |
員工的名字。 |
|
姓氏
|
PrimaryEmployee.LastName | string |
員工的姓氏。 |
|
電話號碼
|
PrimaryEmployee.ContactInformation.PhoneNumber | string |
員工的電話號碼。 |
|
HomePhoneNumber
|
PrimaryEmployee.ContactInformation.HomePhoneNumber | string |
員工的住家電話號碼。 |
|
手機號碼
|
PrimaryEmployee.ContactInformation.CellPhoneNumber | string |
員工的手機號碼。 |
|
語音信箱
|
PrimaryEmployee.ContactInformation.Voicemail | string |
員工的語音信箱。 |
|
傳真號碼
|
PrimaryEmployee.ContactInformation.FaxNumber | string |
員工的傳真號碼。 |
|
電子郵件地址
|
PrimaryEmployee.ContactInformation.EmailAddress | string |
員工的電子郵件地址。 |
|
PreferredCommunication方法
|
PrimaryEmployee.ContactInformation.PreferredCommunicationMethod | string |
員工更喜歡溝通方式。 |
|
網站
|
PrimaryEmployee.ContactInformation.Website | string |
員工的網路連結。 |
|
中學員工
|
SecondaryEmployees | array of object |
有關次要員工的資訊。 |
|
UserID
|
SecondaryEmployees.UserID | integer |
使用者識別號碼。 |
|
名稱
|
SecondaryEmployees.Name | string |
次要員工的全名。 |
|
FirstName
|
SecondaryEmployees.FirstName | string |
次要員工的名字。 |
|
姓氏
|
SecondaryEmployees.LastName | string |
次要員工的姓氏。 |
|
電話號碼
|
SecondaryEmployees.ContactInformation.PhoneNumber | string |
次要員工的電話號碼。 |
|
HomePhoneNumber
|
SecondaryEmployees.ContactInformation.HomePhoneNumber | string |
次要員工的住家電話號碼。 |
|
手機號碼
|
SecondaryEmployees.ContactInformation.CellPhoneNumber | string |
次要員工的手機號碼。 |
|
語音信箱
|
SecondaryEmployees.ContactInformation.Voicemail | string |
次要員工的語音信箱。 |
|
傳真號碼
|
SecondaryEmployees.ContactInformation.FaxNumber | string |
次要員工的傳真號碼。 |
|
電子郵件地址
|
SecondaryEmployees.ContactInformation.EmailAddress | string |
次要員工的電子郵件地址。 |
|
PreferredCommunication方法
|
SecondaryEmployees.ContactInformation.PreferredCommunicationMethod | string |
中學員工更喜歡溝通方式。 |
|
網站
|
SecondaryEmployees.ContactInformation.Website | string |
次要員工的網路連結。 |
|
參考編號
|
ReferenceNumber | string |
參考編號。 |
|
遠端檔案編號
|
RemoteFileNumber | string |
遠端檔案號碼。 |
|
合作夥伴類型標識符
|
PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
合作夥伴識別碼 (PartnerID)
|
PartnerID | integer |
合作夥伴識別號碼。 |
|
合作夥伴類型標識符
|
PartnerType.PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
合作夥伴類型名稱
|
PartnerType.PartnerTypeName | string |
合作夥伴類型名稱。 |
|
OfficeID
|
OfficeID | integer |
辦公室識別號碼。 |
|
合作夥伴名稱
|
PartnerName | string |
夥伴名稱。 |
|
地址1
|
MailingAddress.Address1 | string |
門牌號碼和名稱。 |
|
地址2
|
MailingAddress.Address2 | string |
更多地址資訊。 |
|
城市
|
MailingAddress.City | string |
城市名稱。 |
|
State
|
MailingAddress.State | string |
這兩個字母是縮寫。 |
|
壓縮檔
|
MailingAddress.Zip | string |
郵政編碼。 |
|
電話號碼
|
ContactInformation.PhoneNumber | string |
合作夥伴電話號碼。 |
|
HomePhoneNumber
|
ContactInformation.HomePhoneNumber | string |
合作夥伴的住家電話號碼。 |
|
手機號碼
|
ContactInformation.CellPhoneNumber | string |
合作夥伴手機號碼。 |
|
語音信箱
|
ContactInformation.Voicemail | string |
合作夥伴語音信箱號碼。 |
|
傳真號碼
|
ContactInformation.FaxNumber | string |
合作夥伴傳真號碼。 |
|
電子郵件地址
|
ContactInformation.EmailAddress | string |
合作夥伴電子郵件地址。 |
|
PreferredCommunication方法
|
ContactInformation.PreferredCommunicationMethod | string |
合作夥伴更喜歡溝通方式。 |
|
網站
|
ContactInformation.Website | string |
合作夥伴網站 URL。 |
獲取特定文件的各方
取得指定檔案上當事人及其資訊的清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
買家
|
Buyers | array of object |
有關買家的信息。 |
|
法律實體標識碼
|
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 |
次要買家的姓氏。 |
|
使用屬性位址
|
Buyers.UsePropertyAddress | boolean |
是否使用該地址。 |
|
地址1
|
Buyers.Address.Address1 | string |
門牌號碼和名稱。 |
|
城市
|
Buyers.Address.City | string |
城市名稱。 |
|
State
|
Buyers.Address.State | string |
這兩個字母是縮寫。 |
|
壓縮檔
|
Buyers.Address.Zip | string |
郵政編碼。 |
|
MaritalStatus
|
Buyers.MaritalStatus | string |
當事人的婚姻狀況。 |
|
Email
|
Buyers.Email | string |
派對的電子郵件地址。 |
|
家庭電話
|
Buyers.HomePhone | string |
聚會的住家電話號碼。 |
|
電子郵件次要
|
Buyers.EmailSecondary | string |
次要方的電子郵件地址。 |
|
賣家
|
Sellers | array of object |
有關賣家的信息。 |
|
法律實體標識碼
|
Sellers.LegalEntityID | integer |
法律實體識別號碼。 |
|
實體類型
|
Sellers.EntityType | string |
實體類型。 |
|
公司名稱
|
Sellers.Primary.BusinessName | string |
公司名稱。 |
|
使用屬性位址
|
Sellers.UsePropertyAddress | boolean |
是否使用該地址。 |
|
地址1
|
Sellers.Address.Address1 | string |
門牌號碼和名稱。 |
|
城市
|
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 |
有關客戶的信息。 |
獲取特定文件的合作夥伴
取得合作夥伴清單及其在指定檔案上的資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Partners
|
Partners | array of object |
有關合作夥伴的資訊。 |
|
UserID
|
Partners.PrimaryEmployee.UserID | integer |
使用者識別號碼。 |
|
名稱
|
Partners.PrimaryEmployee.Name | string |
員工的全名。 |
|
FirstName
|
Partners.PrimaryEmployee.FirstName | string |
員工的名字。 |
|
姓氏
|
Partners.PrimaryEmployee.LastName | string |
員工的姓氏。 |
|
電話號碼
|
Partners.PrimaryEmployee.ContactInformation.PhoneNumber | string |
員工的電話號碼。 |
|
電子郵件地址
|
Partners.PrimaryEmployee.ContactInformation.EmailAddress | string |
員工的電子郵件地址。 |
|
合作夥伴類型標識符
|
Partners.PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
合作夥伴識別碼 (PartnerID)
|
Partners.PartnerID | integer |
合作夥伴識別號碼。 |
|
合作夥伴類型標識符
|
Partners.PartnerType.PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
合作夥伴類型名稱
|
Partners.PartnerType.PartnerTypeName | string |
合作夥伴類型名稱。 |
|
合作夥伴名稱
|
Partners.PartnerName | string |
夥伴名稱。 |
獲取特定文件的自定義字段
取得指定檔案的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
自訂欄位
|
CustomFields | array of object |
檔案上的自訂欄位清單。 |
|
名稱
|
CustomFields.Name | string |
自訂欄位的名稱。 |
|
價值觀
|
CustomFields.Value | string |
自訂欄位的值。 |
|
自訂欄位清單計數
|
CustomFieldListCount | integer |
檔案上的自訂欄位數目。 |
獲取特定文件的註釋
取得指定檔案上的附註清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
註釋
|
Notes | array of object |
檔案上的附註清單。 |
|
NoteID
|
Notes.NoteID | integer |
註釋識別號碼。 |
|
主旨
|
Notes.Subject | string |
筆記主題。 |
|
身體
|
Notes.Body | string |
註解內文。 |
|
UserID
|
Notes.CreatedBy.UserID | integer |
使用者識別號碼。 |
|
名稱
|
Notes.CreatedBy.Name | string |
使用者的完整名稱。 |
|
FirstName
|
Notes.CreatedBy.FirstName | string |
使用者的名字。 |
|
姓氏
|
Notes.CreatedBy.LastName | string |
使用者的姓氏。 |
|
電話號碼
|
Notes.CreatedBy.ContactInformation.PhoneNumber | string |
使用者電話號碼。 |
|
電子郵件地址
|
Notes.CreatedBy.ContactInformation.EmailAddress | string |
使用者電子郵件地址。 |
|
CreatedDate
|
Notes.CreatedDate | string |
備註的建立日期。 |
|
檔案識別碼
|
Notes.FileID | integer |
檔案識別號碼。 |
|
加快
|
Notes.Expedite | boolean |
該紙條是否加急。 |
獲取特定文檔的自定義字段
取得指定文件上的自訂欄位。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案 ID
|
FileID | True | string |
檔案識別號碼。 |
|
文件 ID
|
DocumentID | True | string |
文件識別號碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
自訂欄位
|
CustomFields | array of object |
自訂欄位。 |
|
名稱
|
CustomFields.Name | string |
自訂欄位的名稱。 |
|
價值觀
|
CustomFields.Value | string |
自訂欄位的值。 |
|
自訂欄位清單計數
|
CustomFieldListCount | integer |
檔案上的自訂欄位數目。 |
獲取用於估算和下訂單的交易和產品類型
獲取交易類型和產品類型,用於費用估算和下訂單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
State
|
State | string |
估計財產位置的狀態。 |
|
|
縣
|
County | string |
估計財產位置的縣。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
array of object | ||
|
TransactionType
|
TransactionType | string |
交易類型。 |
|
交易類型標識符
|
TransactionTypeID | integer |
交易類型識別號碼。 |
|
產品類型
|
ProductType | string |
產品類型。 |
|
產品類型標識碼
|
ProductTypeID | integer |
產品類型識別號碼。 |
|
輔助產品
|
AncillaryProducts | array of object |
輔助產品。 |
|
名稱
|
AncillaryProducts.Name | string |
輔助產品的名稱。 |
|
ID
|
AncillaryProducts.ID | integer |
產品的識別號碼。 |
|
選項
|
AncillaryProducts.Options | array of object |
選項。 |
|
ID
|
AncillaryProducts.Options.ID | integer |
選項的識別號碼。 |
|
名稱
|
AncillaryProducts.Options.Name | string |
選項的名稱。 |
|
附加產品
|
AddOnProducts | array of object |
添加的產品。 |
|
TransactionType
|
AddOnProducts.TransactionType | string |
交易類型。 |
|
交易類型標識符
|
AddOnProducts.TransactionTypeID | integer |
交易類型識別號碼。 |
|
產品類型
|
AddOnProducts.ProductType | string |
產品類型。 |
|
產品類型標識碼
|
AddOnProducts.ProductTypeID | integer |
產品類型識別號碼。 |
獲取當前用戶信息
取得目前連線使用者的相關資訊。
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Title
|
Title | string |
使用者的職稱。 |
|
密碼到期日期
|
PasswordExpirationDate | string |
密碼到期的日期。 |
|
UserID
|
UserID | integer |
使用者識別號碼。 |
|
名稱
|
Name | string |
用戶的名稱。 |
|
FirstName
|
FirstName | string |
使用者的名字。 |
|
姓氏
|
LastName | string |
使用者的姓氏。 |
|
手機號碼
|
ContactInformation.CellPhoneNumber | string |
使用者的手機號碼。 |
|
電子郵件地址
|
ContactInformation.EmailAddress | string |
用戶的電子郵件位址。 |
|
PreferredCommunication方法
|
ContactInformation.PreferredCommunicationMethod | string |
用戶首選的通信方式。 |
|
電話號碼
|
ContactInformation.PhoneNumber | string |
使用者的電話號碼。 |
|
傳真號碼
|
ContactInformation.FaxNumber | string |
使用者的傳真號碼。 |
|
網站
|
ContactInformation.Website | string |
用戶的網站。 |
預估成交費
估算成交費用。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
交易類型標識符
|
TransactionTypeID | integer |
交易類型識別號碼。 |
|
|
產品類型標識碼
|
ProductTypeID | integer |
產品類型識別號碼。 |
|
|
結算陳述式版本
|
SettlementStatementVersion | string |
結算報表版本。 |
|
|
銷售價格
|
SalesPrice | integer |
銷售價格。 |
|
|
留置權職位
|
LienPosition | integer |
留置權位置。 |
|
|
貸款金額
|
LoanAmount | integer |
貸款金額。 |
|
|
貸款類型
|
LoanType | string |
貸款類型。 |
|
|
是主要
|
IsPrimary | boolean |
無論這是否是主要屬性。 |
|
|
街道號碼
|
StreetNumber | string |
街道號碼。 |
|
|
街道名稱
|
StreetName | string |
街道名稱。 |
|
|
城市
|
City | string |
城市名稱。 |
|
|
State
|
State | string |
這兩個字母是縮寫。 |
|
|
縣
|
County | string |
縣名稱。 |
|
|
壓縮檔
|
Zip | string |
郵政編碼。 |
|
|
合作夥伴類型標識符
|
PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
|
合作夥伴識別碼 (PartnerID)
|
PartnerID | integer |
合作夥伴識別號碼。 |
|
|
合作夥伴類型標識符
|
PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
|
名稱
|
Name | string |
背書的名稱。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ClosingFeeEstimateID
|
ClosingFeeEstimate.ClosingFeeEstimateID | integer |
結算費預估識別號。 |
|
HUD菲斯
|
ClosingFeeEstimate.HUDFees | array of object |
HUD 費用。 |
|
總數
|
ClosingFeeEstimate.HUDFees.Amount | integer |
HUD 費用的金額。 |
|
Description
|
ClosingFeeEstimate.HUDFees.Description | string |
費用說明。 |
|
行號
|
ClosingFeeEstimate.HUDFees.LineNumber | string |
行號。 |
|
買方金額
|
ClosingFeeEstimate.HUDFees.BuyerAmount | integer |
買方金額。 |
|
買家POCAmount
|
ClosingFeeEstimate.HUDFees.BuyerPOCAmount | integer |
買方 POC 金額。 |
|
賣方金額
|
ClosingFeeEstimate.HUDFees.SellerAmount | integer |
賣方金額。 |
|
賣家POCAmount
|
ClosingFeeEstimate.HUDFees.SellerPOCAmount | integer |
賣方 POC 金額。 |
|
其他POCA安裝
|
ClosingFeeEstimate.HUDFees.OtherPOCAmount | integer |
另一個 POC 金額。 |
|
合作夥伴類型標識符
|
ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeID | integer |
合作夥伴類型識別號碼。 |
|
合作夥伴類型名稱
|
ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeName | string |
合作夥伴類型名稱。 |
|
GFE的
|
ClosingFeeEstimate.GFE | array of object |
善意估計。 |
|
Description
|
ClosingFeeEstimate.GFE.Description | string |
估計值的用途。 |
|
總數
|
ClosingFeeEstimate.GFE.Amount | integer |
估計值的金額。 |
|
貸款人溢價
|
ClosingFeeEstimate.Premiums.LendersPremium | integer |
貸方溢價。 |
|
FullLendersPremium
|
ClosingFeeEstimate.Premiums.FullLendersPremium | integer |
全額貸方溢價。 |
|
時間戳
|
ClosingFeeEstimate.Timestamp | string |
時間戳記。 |
定義
物件
這是類型 'object'。