Hold Request View Request and Response - Attribute/Value Pairs in JSON Format

Note: We recommend you to refer the Hold Request View Request in the JSON Format and Hold Request View Response in the JSON Format topics in parallel while understanding the below mentioned attributes. This will help you to understand how the attribute/value pairs are structured in the JSON format.

Before calling the C1-GetHoldRequestHistory business service through an inbound web service, you need to ensure that the hold request view request contains the following tags:

Tag Name Tag Description Mandatory (Yes or No)
C1-GetHoldRequestHistory Used to indicate that you want to invoke the C1-GetHoldRequestHistory business service. Yes
getHoldReqHistRequest Used to specify the details of the hold request which you want to view. Yes
sourceSystem Used to indicate the external system from which the hold view request is received.
Note:

You must specify an external system which is already defined in the system.

The external system is used when the Inbound Web Service History feature is enabled. The specified external system should match the external system which is associated with the outbound message type specified in the C1-IWSHIST algorithm. If the external system is not specified in the hold request view request, the system, by default, stamps the external system associated with the outbound message type (specified in the C1-IWSHIST algorithm) corresponding to the record in the C1_​IWS_​HIST table. For more information, see Inbound Web Service History.

 No
c1ExternalTransactionId Used to indicate the transaction in the external system through which the hold request view request is sent.
Note: The external transaction ID is used when the Inbound Web Service History feature is enabled.
 No
externalSourceId Used to specify the external source system ID.
Note: The external source system ID is used when the Inbound Web Service History feature is enabled.
 No
getHoldReqStartDt Used when you want to view hold request details which are created from a particular date onwards. Yes
getHoldReqEndDt Used when you want to view hold request details which are created till a particular date. No
getHoldReqEntity Used when you want to view the hold request details for a particular entity. The valid values are:

  • ACCT

  • BILL

  • PERS

Yes
getHoldReqReason Used when you want to view the hold request details based on a specific reason.
Note: You must specify a value which is already defined in the HOLD_​REASON_​FLG lookup field and is in the Active status.
 Yes
getHoldReqEntIdentType Used to specify the entity type.
Note: You cannot specify BILL as a type for the entity identifier.
 Yes (Conditional)
Note: This data is required while viewing a hold request.
getHoldReqEntIdentValue Used to specify the entity identifier (i.e. account or person).
Note: You cannot specify BILL as a value for the entity identifier.
 Yes (Conditional)
Note: This data is required while viewing a hold request.
getHoldReqEntityId Used to specify a list of entities for which you want to create a hold request.
Note: You need to specify the entityId when BILL is used as a hold entity.
 Yes (Conditional)
Note: This data is required while viewing a hold request.
getHoldReqProcess Used when you want to view the hold request details for a specific process. The valid values are:

  • ATPY

  • BILL

  • FNDG

  • OVDU

Yes

The following table lists and describes the tags which appear in the hold request view response in the XML format:

Tag Name Tag Description
holdReqHistResponse Displays the response returned by the business service in relation to the hold request.
statusCd Indicates whether the hold request view request is successfully processed or not. The valid values are:

  • Success

  • Failure
messageText Indicates the error that occurred while creating the hold request.
Note: This tag appears when the value in the statusCd tag is set to Failure.
holdReqHistList Displays the details of a hold request.
holdRequestId Displays the hold request ID.
holdReqStartDt Displays the date from when the hold request was effective.
holdReqEndDt Displays the date till when the hold request was effective.
holdStatus Indicates the current status of the hold request.
holdReqType Indicates the type using which the hold request was created.
holdReqReason Indicates the reason which was specified when the hold request was created.
holdReqEntity Indicates the entity for which the hold request was created.
holdReqProcesses Indicates the process which was kept on hold in the hold request.

Related Topics

For more information on... See...
Sample Hold Request View Request and Response in the JSON Format Sample Hold Request View Request and Response in the JSON Format