Update Transaction

Note: This API is being replaced by the Update Transaction API within EZ Config Services and soon will be deprecated. Refer to the EZ Gateway Web Service Guide for the new Update Transaction API available there.

Overview

The update-transaction API combines the submitted transaction with the default data, resulting in a single updated transaction. Document Generation Services calls the Expere EZ Config Default Data APIs https://<hostname>/DefaultData/api/v1/integration/accounts/{accountId}/organizations/{organizationId} and https://<hostname>/DefaultData/api/v1/integration/accounts/{accountId}/products/{productId}; Expere EZ Config Default Data passes the transaction XML and organization and product to the Expere update-transaction companion API.

Request

Table 1. Method
Method URL Description
POST https://<hostname>/DefaultData/api/v1/integration/accounts/{accountId}/update-transaction Used to pass the account ID ("accountId") and request parameters to obtain an updated Transaction XML using the XML provided in the request and merging Expere EZ Config data for the requested Organization ID and/or Product ID (including assigned policies defaulted data).
Table 2. Parameters
Name Type Constraints Description
accountID integer required The "accountID" parameter is used to retrieve a list of organizations associated with the user's account.
transactionXml string required The "transactionXml" parameter is the request XNL to be updated with default data from the requested Organization and/or Product.
organizationId integer optional – if ProductId exists in the request otherwise required The "OrganizationId" parameter retrieves the organization associated with the account.
productId integer optional – if OrganizationId exists in the request otherwise required The "ProductId" parameter retrieves the product associated with the account.
Note: You must use either the "OrganizationId" or "ProductId" parameters with the API. You can also use both parameters.

Response

The update-transaction response returns an updated transaction XML.

Response Message: the response message displays an HTTP Status Code of either 200, 401, 404, or 500 with the respective Reason.

HTTP Status Code Reason Response Model Headers
200 Success

Response Body: provides the updated transaction XML.

{
  "transactionXml": "<p:Txn xmlns:p=\"http://schemas.bankerssystems.com/2004/ExpereTxn\">\n  <p:Borrowers>\n
<p:Borrower index=\"1\">\n      <p:Phones>\n      <p:Phone index=\"1\">\n        <p:Desc>Home</p:Desc>\n
<p:PhoneNumber>301-123-4567</p:PhoneNumber>\n        <p:PrimaryPhoneInd>1</p:PrimaryPhoneInd>\n      </p:Phone>\n
</p:Phones>\n      <p:CitizenType>1</p:CitizenType>\n      <p:DateOfBirth>19600711</p:DateOfBirth>\n
<p:FirstName>Jane</p:FirstName>\n      <p:GenderType>F</p:GenderType>\n      <p:LastName>Doe</p:LastName>\n
<p:PartyType>1</p:PartyType>\n      <p:RembrandtID>1</p:RembrandtID>\n      <p:SSN>123-45-6789</p:SSN>\n
</p:Borrower>\n  </p:Borrowers>\ 
…
</p:OrgMailingAddressStreetAddress1><p:OrgState>ME</p:OrgState></p:Txn>"
}

Response Code: provides the user with the appropriate HTTP status code based on the request:

200

Response Headers: the response header provides 


  access-control-allow-credentials:  true
  access-control-allow-origin: 
  cache-control: no-cache
  content-type: application/json; charset=utf-8
  date: Wed, 29 May 2019 13:50:02 GMT
  pragma: no-cache
  server: Kestrel
  transfer-encoding": "chunked",
  x-frame-options: SAMEORIGIN
  x-powered-by: ASP.NET