Sample Hold Request View Request and Response in the JSON 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 JSON Format

{
    "C1-GetHoldRequestHistory":
    {
        "getHoldReqHistRequest": ""
        {
            "sourceSystem": "SIMPLE_PRIME_HOLD"
            "externalSourceId": "ESI1"
            "c1ExternalTransactionId": "ETI1"
            "getHoldReqStartDt": "2022-01-01"
            "getHoldReqEndDt": ""
            "getHoldReqEntity": "ACCT"
            "getHoldReqReason": "TORNADO_IN_TX"
            "getHoldReqEntIdentType": "SSN_NO"
            "getHoldReqEntIdentValue": "987-65-4321"
            "getHoldReqEntityId": "003526636627"
            "getHoldReqProcess": "ATPY"
        }
    }
}

Sample Hold Request View Response in the JSON Format

{
    "C1-GetHoldRequestHistory":
    {
        "getHoldReqHistRequest": ""
        {
            "sourceSystem": "SIMPLE_PRIME_HOLD"
            "externalSourceId": "ESI1"
            "c1ExternalTransactionId": "ETI1"
            "getHoldReqStartDt": "2022-01-01"
            "getHoldReqEndDt": ""
            "getHoldReqEntity": "ACCT"
            "getHoldReqReason": "TORNADO_IN_TX"
            "getHoldReqEntIdentType": "SSN_NO"
            "getHoldReqEntIdentValue": "987-65-4321"
            "getHoldReqEntityId": "003526636627"
            "getHoldReqProcess": "ATPY"
        }
        "holdReqHistResponse":
        {
            "statusCd": "SUCCESS",
            "messageText": ""
            "holdReqHistList":
            {
                "holdReqId": "006046575162",
                "holdReqStartDt": "2022-01-01",
                "holdReqEndDt": "",
                "holdReqStatus": "ACTIVE",
                "holdReqType": "HOLD_WITHOUT_APPROVAL",
                "holdReqReason": "TORNADO_IN_TX",
                "holdReqEntity": "003526636627",
                "holdReqProcesses": "ATPY"
            }
        }
    }
}

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_HOLD"
            "externalSourceId": "ESI1"
            "c1ExternalTransactionId": "ETI1"
            "getHoldReqStartDt": "2022-01-01"
            "getHoldReqEndDt": ""
            "getHoldReqEntity": "ACCT"
            "getHoldReqReason": "TORNADO_IN_TX"
            "getHoldReqEntIdentType": "SSN_NO"
            "getHoldReqEntIdentValue": "987-65-4321"
            "getHoldReqEntityId": "003526636627"
            "getHoldReqProcess": "ATPY"
        }
        "holdReqHistResponse":
        {
            "statusCd": "FAILURE",
            "messageText": "The system could not retrieve hold request ID based on the search parameters."
            "holdReqHistList":
            {
                "holdReqId": "",
                "holdReqStartDt": "",
                "holdReqEndDt": "",
                "holdReqStatus": "",
                "holdReqType": "",
                "holdReqReason": "",
                "holdReqEntity": "",
                "holdReqProcesses": ""
            }
        }
    }
}

Note: We have given the above request and response samples to illustrate how the attribute value pairs should be structured 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 - Attribute/Value Pairs in JSON Format	Hold Request View Request and Response - Attribute/Value Pairs in JSON Format