Sample Hold Request View Request and Response in the XML Format
Using the below example, you can view a hold request for the ACCT account entity where ATPY auto pay process is on hold.
Sample Hold Request View Request in the XML Format
<C1-GetHoldRequestHistory>
<getHoldReqHistRequest>
<sourceSystem>SIMPLE_PRIME_HOLD</sourceSystem>
<externalSourceId>ESI1</externalSourceId>
<c1ExternalTransactionId>ETI1</c1ExternalTransactionId>
<getHoldReqStartDt>2022-01-01</getHoldReqStartDt>
<getHoldReqEndDt></getHoldReqEndDt>
<getHoldReqEntity>ACCT</getHoldReqEntity>
<getHoldReqReason>TORNADO_IN_TX</getHoldReqReason>
<getHoldReqEntIdentType>SSN_NO</getHoldReqEntIdentType>
<getHoldReqEntIdentValue>987-65-4321</getHoldReqEntIdentValue>
<getHoldReqEntityId>003526636627</getHoldReqEntityId>
<getHoldReqProcess>ATPY</getHoldReqProcess>
</getHoldReqHistRequest>
</C1-GetHoldRequestHistory>
Sample Hold Request View Response in the XML Format
The following information is received as response when the hold request is processed successfully.
<C1-GetHoldRequestHistory>
<getHoldReqHistRequest>
<sourceSystem>SIMPLE_PRIME_HOLD</sourceSystem>
<externalSourceId>ESI1</externalSourceId>
<c1ExternalTransactionId>ETI1</c1ExternalTransactionId>
<getHoldReqStartDt>2022-01-01</getHoldReqStartDt>
<getHoldReqEndDt></getHoldReqEndDt>
<getHoldReqEntity>ACCT</getHoldReqEntity>
<getHoldReqReason>TORNADO_IN_TX</getHoldReqReason>
<getHoldReqEntIdentType>SSN_NO</getHoldReqEntIdentType>
<getHoldReqEntIdentValue>987-65-4321</getHoldReqEntIdentValue>
<getHoldReqEntityId>003526636627</getHoldReqEntityId>
<getHoldReqProcess>ATPY</getHoldReqProcess>
</getHoldReqHistRequest>
<holdReqHistResponse>
<statusCd>SUCCESS</statusCd>
<messageText></messageText>
<holdReqHistList>
<holdReqId>006046575162</holdReqId>
<holdReqStartDt>2022-01-01</holdReqStartDt>
<holdReqEndDt></holdReqEndDt>
<holdReqStatus>ACTIVE</holdReqStatus>
<holdReqType>HOLD_WITHOUT_APPROVAL</holdReqType>
<holdReqReason>TORNADO_IN_TX</holdReqReason>
<holdReqEntity>003526636627</holdReqEntity>
<holdReqProcesses>ATPY</holdReqProcesses>
</holdReqHistList>
</holdReqHistResponse>
</C1-GetHoldRequestHistory>
The following information is received from the hold request when the requested search parameters fail to return any search results.
<C1-GetHoldRequestHistory>
<getHoldReqHistRequest>
<sourceSystem>SIMPLE_PRIME_TEST</sourceSystem>
<externalSourceId>ESI55</externalSourceId>
<c1ExternalTransactionId>ETI33</c1ExternalTransactionId>
<getHoldReqStartDt>2021-12-01</getHoldReqStartDt>
<getHoldReqEndDt></getHoldReqEndDt>
<getHoldReqEntity>PERS</getHoldReqEntity>
<getHoldReqReason>FLOODS_IN_TX</getHoldReqReason>
<getHoldReqEntIdentType>SSN_NO</getHoldReqEntIdentType>
<getHoldReqEntIdentValue>987-65-4323</getHoldReqEntIdentValue>
<getHoldReqEntityId>004556623427</getHoldReqEntityId>
<getHoldReqProcess>ATPY</getHoldReqProcess>
</getHoldReqHistRequest>
<holdReqHistResponse>
<statusCd>FAILURE</statusCd>
<messageText>The system could not retrieve hold request ID based on the search parameters.
</messageText>
<holdReqHistList>
<holdReqId></holdReqId>
<holdReqStartDt></holdReqStartDt>
<holdReqEndDt></holdReqEndDt>
<holdReqStatus></holdReqStatus>
<holdReqType></holdReqType>
<holdReqReason></holdReqReason>
<holdReqEntity></holdReqEntity>
<holdReqProcesses></holdReqProcesses>
</holdReqHistList>
</holdReqHistResponse>
</C1-GetHoldRequestHistory>
Note: We have given the above request and response samples to illustrate
how the tags should be nested while sending a hold view request from
the external system. However, you should not seamlessly use this request
sample in your environment because the required pre-requisite data
may not be available in your environment. In such case, the system
will give erroneous results.
Related Topics
For more information on... | See... |
---|---|
Hold Request View Request and Response - Tags in XML Format | Hold Request View Request and Response - Tags in XML Format |