Prerequisites

The following table lists the prerequisites for hold request creation, modification, release, and view through an inbound web service:

If you want to... Then...
C1-CreateHoldRequest You need to do the following:

  • Define a REST or SOAP based inbound web service to call the C1-CreateHoldRequest business service.

  • Authorize the ORMB user to access the required application service

  • Define the required hold request type for the hold request where the Approval Required flag is configured as No.

  • Define the required hold reason and comments

  • Define the required values for the HOLD_​ENTITY_​LVL_​FLG lookup field.

  • Define the required values for the HOLD_​PROCESS_​FLG lookup field.

  • Define the required characteristic types where the characteristic entity is set to Hold Request

C1-UpdateHoldRequest Used to edit an active hold request. Through this service, you can edit the following details of an active hold request:

  • End date, comments, and characteristics of a hold request

  • End date of a single hold entity in a hold request

  • End date of multiple hold processes in a hold request

It also allows you to delete a characteristic of a hold request. While sending the request for hold request modification, you need to specify the following details:

  • Hold request ID

  • Hold entity ID (i.e. person ID, account ID, or bill ID)

Once the hold request is edited through the service, the hold request ID is sent in the response. The system enables you to track the hold request modification response sent to the external system using the Inbound Web Service History feature.
C1-GetHoldRequestHistory Used to fetch the details of an active hold request with a single entity (i.e. person, account, or bill). The system enables you to track the hold request view response sent to the external system using the Inbound Web Service History feature.
C1-ReleaseHoldRequest Used to release an active hold request with a single entity (i.e. person, account, or bill). While sending the request for hold request release, you need to specify the following details:

  • Hold request ID

  • Hold release reason and comments

Once the hold request is released through the service, the hold request ID is sent in the response along with its status and end date. Note that the hold request end date is set to the system date. The system enables you to track the hold request release response sent to the external system using the Inbound Web Service History feature.

Related Topics

For more information on... See...
How to setup the C1-HOLDSRCH feature configuration Setting the C1-HOLDSRCH Feature Configuration