Default Data REST API - updateTransaction

Overview

The Default Data REST API allows you to retrieve the defined EZ Config organizations, policies, products, and lines of business in order to populate a template. This allows you to define data for an organization or policy and either use a path or query.

Path-based Request - updateTransaction

The updateTransaction API updates the submitted transaction with the default data, merging the two together into an updated transaction.

Rest Services

Table 1. Method: http://localhost:8080/services/api/rest/defaultdata/updateTransaction
Method URL Description
POST http://localhost:8080/services/api/rest/defaultdata Post method that takes the txn file(as XML string) and a list of xpaths and returns updated Expere TXN transaction
Table 2. Parameters
Name Type Constraints Description
body string required Txn data and xpath information.
Example Value | Model 
{
  "transactionXml": "string",
  "xpathValues": [
    {
      "name": "578948.Mortgage2.8.ORG.USBank",
      "type": "ORG",
      "xpathvalue": "<DataItems><DataItem><XPath>/Txn/RestOfYourXpath</XPath><VisibilityTag>true</VisibilityTag><Value>10</Value></DataItem></DataItems>"
    }
  ]
}
Table 3. Responses
Code Description
Response content type application/json
200 The TXN was updated successfully
Example Value | Model
[
 "txnDataXML": "string"
 ]
400 Invalid input.
500 Exception in processing, likely cannot parse xml provided.
Table 4. Models
UpdateTransactionRequest {
Description Request object for updating txn with provided xpath information
transactionXml string
Valid Txn xml
xpathValues Xpath information {
description: Object to pass in xpath information
name string
example: 578948.Mortgage2.8.ORG.USBank
Name of the org, policy or product associated with the xpath
type string
example: ORG
org, policy or product
xpathvalue string
example: <DataItems><DataItem><XPath>/Txn/RestOfYourXpath</XPath><VisibilityTag>true</VisibilityTag><Value>10</Value></DataItem></DataItems>
Xpath value
}]
}
UpdateTransactionResponse {
Description Response object for updating a TXN transaction with xpath info provided
txnDataXML string
Updated Txn xml for the provided Txn and xpath info.
}
Xpath information {
Description Object to pass in xpath information
txnDataXML string
example: 578948.Mortgage2.8.ORG.USBank
Name of the org, policy or product associated with the xpath.
Type string
example: ORG
org, policy or product
xpathvalue string
example: <DataItems><DataItem><XPath>/Txn/RestOfYourXpath</XPath><VisibilityTag>true</VisibilityTag><Value>10</Value></DataItem></DataItems>
Xpath value
}