Hold Request Release Request and Response - Tags in XML Format

Note: We recommend you to refer the Hold Request Release Request in the XML Format andHold Request Release Response in the XML Format topics in parallel while understanding the below mentioned tags. This will help you to understand how the tags are nested in the XML format.

Before calling the C1-ReleaseHoldRequest 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-ReleaseHoldRequest Used to indicate that you want to invoke the C1-ReleaseHoldRequest business service. Yes
sourceSystem Used to indicate the external system from which the hold release 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
externalTransactionId Used to indicate the transaction in the external system through which the hold request release 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
holdRequestId Used to specify the hold request ID of the hold request for which the hold request release request is sent.
Note: You must specify the hold request ID which is already defined in the system.
 Yes
holdReleaseReason Used to specify the reason for releasing the hold request.
Note: You must specify a value which is already defined in the HOLD_​REASON_​FLG lookup field. It must be in the Active status.
 Yes
holdComments Used to specify additional information about the hold request. No

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

Tag Name Tag Description
requestProcessStatus Indicates whether the hold request view request is successfully processed or not. The valid values are:

  • Success

  • Failure
holdRequestId Displays the hold request ID.
holdReleaseReason Indicates the reason which was specified when the hold request was released.
holdComments Displays additional information about the hold request.
errormsg Indicates the error that occurred while creating the hold request.
Note: This tag appears when the value in the requestProcessStatus tag is set to Failure.
holdEndDate Displays the date till when the hold request was effective.
holdStatus Indicates the current status of the hold request.

Related Topics

For more information on... See...
Sample Hold Request Release Request and Response in the XML Format Sample Hold Request Release Request and Response in the XML Format