Set Plan

Method: HTTP POST method

Endpoint: http://<host_address>:<port_address>/v1/plan

Parameters
Name Type Value
businessTransactionID (optional) string (query) businessTransactionID
CorrectionID (optional) string (query) CorrectionID
notificationType Boolean (query) true or false
orderId (optional) string (query) orderid
Note: The value of orderId must not contain ":"
orderRef (optional) string (query) orderRef
Note: You must enter the orderRef value for the older orders where the orderRef was unique and there was no orderId. For the new orders, both the orderId and orderRef are the same, you can enter either one.
Note: The value of orderRef must not contain ":"
planID (optional) string (query) planID
replaceInHeader (optional) Boolean (query) true or false
setPlanRequest (mandatory) body request values

Example of setPlanRequest value: 

{
  "businessTransactionID": "string",
  "plan": {
    "orderID": "string",
    "orderRef": "string",
    "planID": "string",
    "planItem": [
      {
        "planItemID": "string",
        "planItemName": "string",
        "udf": [
          {
            "evaluationPriority": "string",
            "flavor": "string",
            "name": "string",
            "type": "string",
            "value": "string"
          }
        ]
      }
    ],
    "udf": [
      {
        "evaluationPriority": "string",
        "flavor": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      }
    ]
  },
  "replace": {}
}