C1-GetHoldRequestHistory Business Service
The Inquire Hold Request Details (C1-GetHoldRequestHistory) business service enables you to view the details of an existing hold request which is in the Active status. At a time, you can view the hold request details of a single entity (i.e., for a particular person, account, or bill). You can call this business service from an external system through an inbound web service. If you want to send the hold view request in the XML and/or JSON format, you need to ensure that you create a REST based inbound web service in Oracle Revenue Management and Billing. However, if you want to send the hold view request in the XML format, you can create a SOAP or REST based inbound web service in Oracle Revenue Management and Billing.
While sending the hold view request, you need to specify the following details:
-
Entity (i.e., Person, Account, or Bill) whose hold requests you want to view.
-
Entity identifiers or entity ID when the entity is an account or a person, and the entity ID when the entity is a bill.
In addition, you can specify the following filter criteria – Hold Request Start Date, Hold Request End Date, Hold Reason, and Hold Process. On specifying the hold process, the system fetches one or more active hold requests of the entity with the given hold process. This hold request may have one or more hold processes including the given hold process.
Once the hold view request is processed through an inbound web service, the system displays the details of one or more active hold requests that meet the search criteria. If an error occurs while retrieving the hold requests for the entity, the system sends the error message in the response. The system enables you to track the hold view response sent to the external system using the Inbound Web Service History feature.
For more information, see Inbound Web Service History.
Related Topics
| For more information on... | See... |
|---|---|
| Hold View Request in the XML Format | Hold View Request in the XML Format |
| Hold View Response in the XML Format | Hold View Response in the XML Format |
| Hold View Request in the JSON Format | Hold View Request in the JSON Format |
| Hold View Response in the JSON Format | Hold View Response in the JSON Format |
| Hold View Request and Response - Tags in XML Format | Hold View Request and Response - Tags in XML Format |
| Hold View Request and Response - Attribute/Value Pairs in JSON Format | Hold View Request and Response - Attribute/Value Pairs in JSON Format |
| Sample Hold View Request and Response in the XML Format | Sample Hold View Request and Response in the XML Format |
| Sample Hold View Request and Response in the JSON Format | Sample Hold View Request and Response in the JSON Format |
Parent Topic: Hold Request Creation, Modification, Release, and View Through Inbound Web Service
