Jump to

• Request
• Response

Create all academic levels

post

/fscmRestApi/resources/11.13.18.05/academicLevels

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• assignments: array Drop Scheme Settings Assignments
  Title: Drop Scheme Settings Assignments

  The assignments resource provides a list of academic entities which have been assigned.
• Description: string
  Title: Academic Level Description

  Maximum Length: 1000

  The description of the academic level.
• enrollmentInclusions: array Enrollment Inclusions
  Title: Enrollment Inclusions

  The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.
• ForCreditFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates the academic level is for credit.
• institutions: array Institutions
  Title: Institutions

  The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.
• LevelCode(required): string
  Title: Academic Level Code

  Maximum Length: 100

  The code of the academic level.
• LevelName(required): string
  Title: Academic Level Name

  Maximum Length: 100

  The name of the academic level.
• LevelStatusCode: string
  Maximum Length: 30

  Default Value: ORA_INACTIVE

  The status code of the academic level. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LEVEL_STATUS_CODE.
• MinimumFullTimeUnits: number
  Default Value: 0

  The minimum full time units indicates the minimum number of units of credit required to be considered a full time student.
• PrimacyNumber(required): integer (int32)
  Title: Primacy Number

  The primacy number of the academic level. Use primacy numbers to specify the primary program for purposes such as reporting and tuition calculation.
• RepeatFailureHandlerCode: string
  Title: Enrollment Repeat Option

  Maximum Length: 30

  Default Value: ORA_NONE

  Indicates the action to be taken when a course repeat attempt isn't successful. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.
• RequiresStudentProgramFlag(required): boolean
  Title: Requires student program

  Maximum Length: 1

  Indicates that a student can enroll only if the student is assigned to a program.
• TypeOfCreditCode(required): string
  Maximum Length: 30

  Indicates the type of credit generally earned for this academic level. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.

{
    "required":[
        "LevelCode",
        "LevelName",
        "PrimacyNumber",
        "RequiresStudentProgramFlag",
        "TypeOfCreditCode"
    ],
    "type":"object",
    "properties":{
        "RepeatFailureHandlerCode":{
            "title":"Enrollment Repeat Option",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the action to be taken when a course repeat attempt isn't successful. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.",
            "nullable":false,
            "default":"ORA_NONE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "enrollmentInclusions":{
            "title":"Enrollment Inclusions",
            "type":"array",
            "description":"The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.",
            "items":{
                "$ref":"#/components/schemas/academicLevels-enrollmentInclusions-item-post-request"
            }
        },
        "LevelCode":{
            "title":"Academic Level Code",
            "maxLength":100,
            "type":"string",
            "description":"The code of the academic level.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "Description":{
            "title":"Academic Level Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the academic level.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "assignments":{
            "title":"Drop Scheme Settings Assignments",
            "type":"array",
            "description":"The assignments resource provides a list of academic entities which have been assigned.",
            "items":{
                "$ref":"#/components/schemas/academicLevels-assignments-item-post-request"
            }
        },
        "PrimacyNumber":{
            "title":"Primacy Number",
            "type":"integer",
            "description":"The primacy number of the academic level. Use primacy numbers to specify the primary program for purposes such as reporting and tuition calculation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3,
                "PAYLOADHINT":"Show"
            }
        },
        "LevelStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the academic level. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LEVEL_STATUS_CODE.",
            "nullable":false,
            "default":"ORA_INACTIVE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MinimumFullTimeUnits":{
            "type":"number",
            "description":"The minimum full time units indicates the minimum number of units of credit required to be considered a full time student.",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":11,
                "scale":2
            }
        },
        "institutions":{
            "title":"Institutions",
            "type":"array",
            "description":"The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.",
            "items":{
                "$ref":"#/components/schemas/academicLevels-institutions-item-post-request"
            }
        },
        "RequiresStudentProgramFlag":{
            "title":"Requires student program",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a student can enroll only if the student is assigned to a program.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "TypeOfCreditCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit generally earned for this academic level. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ForCreditFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the academic level is for credit.",
            "nullable":false,
            "default":true
        },
        "LevelName":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic level.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Drop Scheme Settings Assignments

Type: array

Title: Drop Scheme Settings Assignments

The assignments resource provides a list of academic entities which have been assigned.

Show Source

• Array of: object schema

{
    "title":"Drop Scheme Settings Assignments",
    "type":"array",
    "description":"The assignments resource provides a list of academic entities which have been assigned.",
    "items":{
        "$ref":"#/components/schemas/academicLevels-assignments-item-post-request"
    }
}

Nested Schema : Enrollment Inclusions

Type: array

Title: Enrollment Inclusions

The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.

Show Source

• Array of: object schema

{
    "title":"Enrollment Inclusions",
    "type":"array",
    "description":"The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.",
    "items":{
        "$ref":"#/components/schemas/academicLevels-enrollmentInclusions-item-post-request"
    }
}

Nested Schema : Institutions

Type: array

Title: Institutions

The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.

Show Source

• Array of: object academicLevels-institutions-item-post-request

{
    "title":"Institutions",
    "type":"array",
    "description":"The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.",
    "items":{
        "$ref":"#/components/schemas/academicLevels-institutions-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AssignedEntityId: integer (int64)
  Title: Entity ID

  The unique identifier of the associated entity.
• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssignedSettingsObjectId: integer (int64)
  The unique identifier of the associated setting.
• AssignedSettingsTypeCode: string
  Maximum Length: 30

  Default Value: ORA_HER_ACADEMIC_LEVEL

  A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_TYPE.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The end or expiration date of the entity assignment.
• AssignmentMethodTypeCode: string
  Maximum Length: 30

  Default Value: ORA_DIRECT

  The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  The start date of the entity assignment.
• RelatedEntityId: integer (int64)
  The unique identifier of the related entity.
• RelatedEntityTypeCode: string
  Maximum Length: 30

  A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.

{
    "type":"object",
    "properties":{
        "AssignmentMethodTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.",
            "nullable":false,
            "default":"ORA_DIRECT",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "AssignedSettingsObjectId":{
            "type":"integer",
            "description":"The unique identifier of the associated setting.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"The end or expiration date of the entity assignment.",
            "format":"date",
            "nullable":false
        },
        "RelatedEntityTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "AssignedSettingsTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_TYPE.",
            "nullable":false,
            "default":"ORA_HER_ACADEMIC_LEVEL",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "RelatedEntityId":{
            "type":"integer",
            "description":"The unique identifier of the related entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":30,
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"The start date of the entity assignment.",
            "format":"date",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• IncludeAcademicLevelId: integer (int64)
  Title: Included Academic Level ID

  The unique identifier for the academic level that's included for enrollment.

{
    "type":"object",
    "properties":{
        "IncludeAcademicLevelId":{
            "title":"Included Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for the academic level that's included for enrollment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : academicLevels-institutions-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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.

Body ()

Root Schema : academicLevels-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  Read Only: true

  The unique identifier for an academic level.
• ActiveFlag: boolean
  Title: Academic Level Active

  Read Only: true

  Maximum Length: 1

  Indicates the active status of the academic level.
• AllInstitutionsFlag: boolean
  Title: Available for all institutions

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates the academic level is available for all academic institutions.
• assignments: array Drop Scheme Settings Assignments
  Title: Drop Scheme Settings Assignments

  The assignments resource provides a list of academic entities which have been assigned.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date the row was created.
• Description: string
  Title: Academic Level Description

  Maximum Length: 1000

  The description of the academic level.
• enrollmentInclusions: array Enrollment Inclusions
  Title: Enrollment Inclusions

  The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.
• ForCreditFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates the academic level is for credit.
• institutions: array Institutions
  Title: Institutions

  The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• LevelCode: string
  Title: Academic Level Code

  Maximum Length: 100

  The code of the academic level.
• LevelName: string
  Title: Academic Level Name

  Maximum Length: 100

  The name of the academic level.
• LevelStatus: string
  Read Only: true

  Maximum Length: 80

  The status meaning of the academic level.
• LevelStatusCode: string
  Maximum Length: 30

  Default Value: ORA_INACTIVE

  The status code of the academic level. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LEVEL_STATUS_CODE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MinimumFullTimeUnits: number
  Default Value: 0

  The minimum full time units indicates the minimum number of units of credit required to be considered a full time student.
• PrimacyNumber: integer (int32)
  Title: Primacy Number

  The primacy number of the academic level. Use primacy numbers to specify the primary program for purposes such as reporting and tuition calculation.
• RepeatFailureHandlerCode: string
  Title: Enrollment Repeat Option

  Maximum Length: 30

  Default Value: ORA_NONE

  Indicates the action to be taken when a course repeat attempt isn't successful. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.
• RepeatFailureHandlerMeaning: string
  Title: Repeat Handler Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of repeat failure handler code. Valid values include None, Error or Warning. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.
• RequiresStudentProgramFlag: boolean
  Title: Requires student program

  Maximum Length: 1

  Indicates that a student can enroll only if the student is assigned to a program.
• TypeOfCredit: string
  Read Only: true

  Maximum Length: 80

  The meaning of the type of credit. Valid values include Continuing education units, Credit hours and No Credit Type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
• TypeOfCreditCode: string
  Maximum Length: 30

  Indicates the type of credit generally earned for this academic level. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RepeatFailureHandlerCode":{
            "title":"Enrollment Repeat Option",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the action to be taken when a course repeat attempt isn't successful. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.",
            "nullable":false,
            "default":"ORA_NONE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LevelStatus":{
            "maxLength":80,
            "type":"string",
            "description":"The status meaning of the academic level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "enrollmentInclusions":{
            "title":"Enrollment Inclusions",
            "type":"array",
            "description":"The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.",
            "items":{
                "$ref":"#/components/schemas/academicLevels-enrollmentInclusions-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LevelCode":{
            "title":"Academic Level Code",
            "maxLength":100,
            "type":"string",
            "description":"The code of the academic level.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Academic Level Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the academic level.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "assignments":{
            "title":"Drop Scheme Settings Assignments",
            "type":"array",
            "description":"The assignments resource provides a list of academic entities which have been assigned.",
            "items":{
                "$ref":"#/components/schemas/academicLevels-assignments-item-response"
            }
        },
        "PrimacyNumber":{
            "title":"Primacy Number",
            "type":"integer",
            "description":"The primacy number of the academic level. Use primacy numbers to specify the primary program for purposes such as reporting and tuition calculation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RepeatFailureHandlerMeaning":{
            "title":"Repeat Handler Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of repeat failure handler code. Valid values include None, Error or Warning. A list of accepted values is defined in the lookup type ORA_HER_REPEAT_CONTROL_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllInstitutionsFlag":{
            "title":"Available for all institutions",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the academic level is available for all academic institutions.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Academic Level Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the active status of the academic level.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TypeOfCredit":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the type of credit. Valid values include Continuing education units, Credit hours and No Credit Type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LevelStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the academic level. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_LEVEL_STATUS_CODE.",
            "nullable":false,
            "default":"ORA_INACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MinimumFullTimeUnits":{
            "type":"number",
            "description":"The minimum full time units indicates the minimum number of units of credit required to be considered a full time student.",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "institutions":{
            "title":"Institutions",
            "type":"array",
            "description":"The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.",
            "items":{
                "$ref":"#/components/schemas/academicLevels-institutions-item-response"
            }
        },
        "RequiresStudentProgramFlag":{
            "title":"Requires student program",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a student can enroll only if the student is assigned to a program.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TypeOfCreditCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of credit generally earned for this academic level. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ForCreditFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the academic level is for credit.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "LevelName":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic level.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Drop Scheme Settings Assignments

Type: array

Title: Drop Scheme Settings Assignments

The assignments resource provides a list of academic entities which have been assigned.

Show Source

• Array of: object academicLevels-assignments-item-response

{
    "title":"Drop Scheme Settings Assignments",
    "type":"array",
    "description":"The assignments resource provides a list of academic entities which have been assigned.",
    "items":{
        "$ref":"#/components/schemas/academicLevels-assignments-item-response"
    }
}

Nested Schema : Enrollment Inclusions

Type: array

Title: Enrollment Inclusions

The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.

Show Source

• Array of: object academicLevels-enrollmentInclusions-item-response

{
    "title":"Enrollment Inclusions",
    "type":"array",
    "description":"The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.",
    "items":{
        "$ref":"#/components/schemas/academicLevels-enrollmentInclusions-item-response"
    }
}

Nested Schema : Institutions

Type: array

Title: Institutions

The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.

Show Source

• Array of: object academicLevels-institutions-item-response

{
    "title":"Institutions",
    "type":"array",
    "description":"The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.",
    "items":{
        "$ref":"#/components/schemas/academicLevels-institutions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : academicLevels-assignments-item-response

Type: object

Show Source

• AssignedEntityCode: string
  Title: Entity Code

  Read Only: true

  Maximum Length: 100

  The user defined identifier of the associated entity.
• AssignedEntityId: integer (int64)
  Title: Entity ID

  The unique identifier of the associated entity.
• AssignedEntityName: string
  Title: Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the associated entity.
• AssignedEntityStatusCode: string
  Read Only: true

  Maximum Length: 30

  The status code of the entity. This controls the availability of the entity for assignments to settings.
• AssignedEntityStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The status of the entity.
• AssignedEntitySubTypeCode: string
  Title: Entity Subtype Code

  Read Only: true

  Maximum Length: 30

  The entity subtype code of the associated entity.
• AssignedEntitySubTypeMeaning: string
  Title: Entity Subtype

  Read Only: true

  Maximum Length: 80

  The entity subtype of the associated entity.
• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssignedEntityTypeMeaning: string
  Title: Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the associated entity.
• AssignedSettingsObjectId: integer (int64)
  The unique identifier of the associated setting.
• AssignedSettingsTypeCode: string
  Maximum Length: 30

  Default Value: ORA_HER_ACADEMIC_LEVEL

  A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_TYPE.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The end or expiration date of the entity assignment.
• AssignmentMethodMeaning: string
  Read Only: true

  Maximum Length: 80

  The assignment method type meaning used to indicate how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
• AssignmentMethodTypeCode: string
  Maximum Length: 30

  Default Value: ORA_DIRECT

  The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  The start date of the entity assignment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date the row was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RelatedEntityCode: string
  Read Only: true

  Maximum Length: 100

  The user defined identifier of the related entity.
• RelatedEntityId: integer (int64)
  The unique identifier of the related entity.
• RelatedEntityName: string
  Read Only: true

  Maximum Length: 100

  The name of the related entity.
• RelatedEntityTypeCode: string
  Maximum Length: 30

  A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• RelatedEntityTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The entity type of the related entity.
• SettingsAssignmentId: integer (int64)
  Title: Settings Assignment ID

  Read Only: true

  The unique identifier for the setup association record.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SettingsAssignmentId":{
            "title":"Settings Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the setup association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssignedEntityCode":{
            "title":"Entity Code",
            "maxLength":100,
            "type":"string",
            "description":"The user defined identifier of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntitySubTypeCode":{
            "title":"Entity Subtype Code",
            "maxLength":30,
            "type":"string",
            "description":"The entity subtype code of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedEntityTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RelatedEntityId":{
            "type":"integer",
            "description":"The unique identifier of the related entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignedEntityTypeMeaning":{
            "title":"Entity Type",
            "maxLength":80,
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentMethodMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The assignment method type meaning used to indicate how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntitySubTypeMeaning":{
            "title":"Entity Subtype",
            "maxLength":80,
            "type":"string",
            "description":"The entity subtype of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedSettingsObjectId":{
            "type":"integer",
            "description":"The unique identifier of the associated setting.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"The end or expiration date of the entity assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RelatedEntityCode":{
            "maxLength":100,
            "type":"string",
            "description":"The user defined identifier of the related entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityName":{
            "title":"Entity Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedEntityTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The entity type of the related entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentMethodTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.",
            "nullable":false,
            "default":"ORA_DIRECT",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignedEntityStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"The status code of the entity. This controls the availability of the entity for assignments to settings.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":30,
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"The start date of the entity assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AssignedSettingsTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_TYPE.",
            "nullable":false,
            "default":"ORA_HER_ACADEMIC_LEVEL",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RelatedEntityName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the related entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : academicLevels-enrollmentInclusions-item-response

Type: object

Show Source

• EnrollmentInclusionId: integer (int64)
  Title: Academic Level Enrollment Inclusion ID

  Read Only: true

  The unique identifier for an enrollment inclusion. Enrollment inclusions at the course academic level indicate the student academic levels that are eligible to enroll in a course. Inclusions apply only when enrollment is restricted to students who are assigned to a program.
• IncludeAcademicLevelId: integer (int64)
  Title: Included Academic Level ID

  The unique identifier for the academic level that's included for enrollment.
• IncludeLevelCode: string
  Read Only: true

  Maximum Length: 100

  The code of the academic level.
• IncludeLevelName: string
  Read Only: true

  Maximum Length: 100

  The name of the academic level.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IncludeAcademicLevelId":{
            "title":"Included Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for the academic level that's included for enrollment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "IncludeLevelName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollmentInclusionId":{
            "title":"Academic Level Enrollment Inclusion ID",
            "type":"integer",
            "description":"The unique identifier for an enrollment inclusion. Enrollment inclusions at the course academic level indicate the student academic levels that are eligible to enroll in a course. Inclusions apply only when enrollment is restricted to students who are assigned to a program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "IncludeLevelCode":{
            "maxLength":100,
            "type":"string",
            "description":"The code of the academic level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : academicLevels-institutions-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Read Only: true

  Unique identifier for an academic level.
• AcademicLevelInstitutionId: integer (int64)
  Read Only: true

  The unique identifier for the institution that's associated with an academic level.
• InstitutionId: integer (int64)
  Read Only: true

  The unique identifier of an academic institution.
• InstitutionName: string
  Title: Institution

  Read Only: true

  Maximum Length: 50

  The name of the institution.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AcademicLevelId":{
            "type":"integer",
            "description":"Unique identifier for an academic level.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of the institution.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicLevelInstitutionId":{
            "type":"integer",
            "description":"The unique identifier for the institution that's associated with an academic level.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "type":"integer",
            "description":"The unique identifier of an academic institution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

assignments

Operation: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/assignments

Parameters:

• AcademicLevelId: $request.path.AcademicLevelId

The assignments resource provides a list of academic entities which have been assigned.

enrollmentInclusions

Operation: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/enrollmentInclusions

Parameters:

• AcademicLevelId: $request.path.AcademicLevelId

The enrollment inclusions resource is a child of the academic levels resource and provides a complete list of enrollment inclusions associated with an academic level.

institutions

Operation: /fscmRestApi/resources/11.13.18.05/academicLevels/{AcademicLevelId}/child/institutions

Parameters:

• AcademicLevelId: $request.path.AcademicLevelId

The institutions resource is a child of the academic levels resource and provides a complete list of institutions associated with an academic level.

Back to Top