Jump to

• Request
• Response

Validate scheduled items

post

/fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/action/validateItems

Validates all scheduled items passed in via the scheduled items element. The scheduled items element can contain an array of scheduled item IDs.

Request

Path Parameters

• studentScheduleByPeriodsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Student Schedule by Periods resource and used to uniquely identify an instance of Student Schedule by Periods. The client should not generate the hash key value. Instead, the client should query on the Student Schedule by Periods collection resource in order to navigate to a specific instance of Student Schedule by Periods to get the hash key.

Header Parameters

• Metadata-Context:
  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:
  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

• scheduledItems: array scheduledItems
  Contains an array of scheduled item IDs that need to be validated.

{
    "type":"object",
    "properties":{
        "scheduledItems":{
            "type":"array",
            "description":"Contains an array of scheduled item IDs that need to be validated.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : scheduledItems

Type: array

Contains an array of scheduled item IDs that need to be validated.

Show Source

• Array of: number

{
    "type":"array",
    "description":"Contains an array of scheduled item IDs that need to be validated.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

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): array result
  The response will contain an array of objects. Each returned object will contain the scheduled item ID and an array of warning messages for that scheduled item ID.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"array",
            "description":"The response will contain an array of objects. Each returned object will contain the scheduled item ID and an array of warning messages for that scheduled item ID.",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: array

The response will contain an array of objects. Each returned object will contain the scheduled item ID and an array of warning messages for that scheduled item ID.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"The response will contain an array of objects. Each returned object will contain the scheduled item ID and an array of warning messages for that scheduled item ID.",
    "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