Hold Creation Request in the JSON Format

The following code snippet illustrates how the attribute/value pairs should be structured while receiving the hold creation request in the JSON format:

 {
    "C1-CreateHoldRequest": {
        "holdRequest": {
            "sourceSystem": "",
            "externalTransactionId": "",
            "externalSourceId": "",
            "holdStartDate": "",
            "holdEndDate": "",
            "holdDays": "",
            "holdRequestType": "",
            "holdEntity": "",
            "holdReason": "",
            "holdComments": "",
            "entityIdentifierType": "",
            "entityIdentifierValue": "",
            "entityId": "",
            "holdEntityEndDate": "",
            "hierarchySwitch": "",
            "holdProcessData": {
                "holdProcess": "",
                "holdProcessEndDate": ""
            },
            "characteristics": {
                "characteristicType": "",
                "characteristicValue": "",
                "effectiveDate": ""
            }
        }
    }
 }

Note: Here, the C1-CreateHoldRequest attribute represents the operation in the inbound web service which is used to call the C1-CreateHoldRequest business service. This attribute would change depending on the operation name specified in your REST based inbound web service. For example, if you have set the operation name to CreateHoldRequest, then you need to specify the CreateHoldRequest attribute instead of the C1-CreateHoldRequest attribute in the above request.

Related Topics

For more information on...	See...
Hold Creation Response in the JSON Format	Hold Creation Response in the JSON Format
Hold Creation Request and Response - Attribute/Value Pairs in JSON Format	Hold Creation Request and Response - Attribute/Value Pairs in JSON Format
Sample Hold Creation Request and Response in the JSON Format	Sample Hold Creation Request and Response in the JSON Format