Jump to

• Request
• Response

Create a preview of the payment plan

post

/fscmRestApi/resources/11.13.18.05/paymentPlanEnrollments/action/createPreview

To create a preview of the payment plan, the input string should include the payment plan, student information, and invoices. If invoices aren't included, all invoices are selected. A string in JSON format is returned, which contains the payment plan enrollment information.

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• paymentPlanEnrollments: array paymentPlanEnrollments
  The input string in JSON format.

{
    "type":"object",
    "properties":{
        "paymentPlanEnrollments":{
            "type":"array",
            "description":"The input string in JSON format.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : paymentPlanEnrollments

Type: array

The input string in JSON format.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"The input string in JSON format.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  The output string in JSON format.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The output string in JSON format."
        }
    },
    "additionalProperties":false
}

Back to Top