Get a program
get
/fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/program/{programUniqID}
Request
Path Parameters
-
curriculumItemsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Curriculum Items resource and used to uniquely identify an instance of Curriculum Items. The client should not generate the hash key value. Instead, the client should query on the Curriculum Items collection resource in order to navigate to a specific instance of Curriculum Items to get the hash key.
-
programUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Programs resource and used to uniquely identify an instance of Programs. The client should not generate the hash key value. Instead, the client should query on the Programs collection resource in order to navigate to a specific instance of Programs to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : curriculumItems-program-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
Read Only:true
The unique identifier for an academic level that is associated with a program. -
AcademicLevelName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of an academic level that is associated with a program. -
AdmissionRequiredFlag: boolean
Title:
Admission Required
Read Only:true
Maximum Length:1
Default Value:true
Indicates whether admission is required for the program. -
CampusId: integer
Title:
Campus ID
Read Only:true
The unique identifier for a campus that is associated with a program. -
CampusName: string
Title:
Name
Read Only:true
The name of the campus associated with the program. -
CredentialId: integer
Title:
Program Credential ID
Read Only:true
The unique identifier of the credential associated with the program. -
CredentialName: string
Title:
Name
Read Only:true
The name of the credential associated with the program. -
CreditTypeCode: string
Title:
Type of Credit
Read Only:true
Maximum Length:30
The unique identifier for the type of credit associated with the program. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CreditTypeMeaning: string
Title:
Type of Credit Meaning
Read Only:true
Maximum Length:80
The meaning of the type of credit of the program. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CurriculumFormatCode: string
Title:
Format
Read Only:true
Maximum Length:30
The code for the format of the program. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE. -
CurriculumFormatMeaning: string
Title:
Curriculum Format Meaning
Read Only:true
Maximum Length:80
The meaning of the format of the program. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE. -
CurriculumId: integer
(int64)
Title:
Curriculum ID
Read Only:true
The generated identifier of the program. -
CurriculumLongDescription: string
Title:
Long Description
Read Only:true
The description of the program. -
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:150
The name of the program. -
CurriculumStatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
The unique identifier of the status of the program. -
CurriculumTitle: string
Title:
Title
Read Only:true
Maximum Length:100
The title of the program. -
EnforceRequirementSequenceFlag: boolean
Title:
List by Sequence
Read Only:true
Maximum Length:1
Default Value:false
Indicates how to enforce requirements for the program. -
FirstAdmitDate: string
(date)
Title:
First Admit Date
Read Only:true
The first date when students can be admitted into the program. -
images: array
Images
Title:
Images
The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a unscheduled course offering. -
InstitutionId: integer
(int64)
Title:
Institution
Read Only:true
The identifier for the institution to which the program belongs. -
IsCartableFlag: boolean
Title:
Shopping Cart Enabled
Read Only:true
Maximum Length:255
Indicates whether the program can be added to the shopping cart. The default value is true. -
IsWishableFlag: boolean
Title:
Wish List Enabled
Read Only:true
Maximum Length:255
Indicates whether the program can be added to the wish list. The default value is true. -
LastAdmitDate: string
(date)
Title:
Last Admit Date
Read Only:true
The last date when students can be admitted into the program. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumTimespanMeasure: string
Title:
Maximum Duration
Read Only:true
Maximum Length:30
A unit of measure for the maximum length of time allowed to complete the program. -
MaximumTimespanMeasureMeaning: string
Title:
Maximum Duration Meaning
Read Only:true
Maximum Length:80
The meaning of the unit of measure for the maximum length of time allowed to complete the program. -
MaximumTimespanQuantity: integer
Title:
Maximum Duration Quantity
Read Only:true
A quantity, which, along with the unit of measure, defines the maximum length of time allowed to complete the program. -
offeringCampuses: array
Offering Campuses
Title:
Offering Campuses
The offering campuses resource is a child of the unscheduled course offering resource and provides a list of campuses associated with a unscheduled course offering. -
offeringCredentials: array
Offering Credentials
Title:
Offering Credentials
The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program. -
parameters: array
Parameters
Title:
Parameters
The parameters resource is a child of the programs resource and provides a list of program parameters for a program. -
ProgramTypeId: integer
(int64)
Title:
Program Type ID
Read Only:true
The unique identifier for a program type that is associated with a program. -
ProgramTypeMainFlag: boolean
Title:
Main Program
Read Only:true
Maximum Length:1
Indicates whether a program is a main program. -
ProgramTypeName: string
Title:
Program Type
Read Only:true
Maximum Length:50
The name of a program type that is associated with a program. -
tags: array
Tags
Title:
Tags
The tags resource is a child of the unscheduled course offering resource and provides a list of tags associated with a unscheduled course offering. -
TypicalTimespanMeasure: string
Title:
Duration Measurement
Read Only:true
Maximum Length:30
A numeric value which indicates the typical length of the program. -
TypicalTimespanMeasureMeaning: string
Title:
Typical Time Span
Read Only:true
Maximum Length:80
The unit value of the time span associated with the length of the program. -
TypicalTimespanQuantity: integer
Title:
Typical Duration
Read Only:true
The numeric value, along with time span, used to capture the typical length of the program. -
URLAddress: string
Title:
URL Address
Read Only:true
The URL for a webpage associated with a program.
Nested Schema : Images
Type:
array
Title:
Images
The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a unscheduled course offering.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Offering Campuses
Type:
array
Title:
Offering Campuses
The offering campuses resource is a child of the unscheduled course offering resource and provides a list of campuses associated with a unscheduled course offering.
Show Source
Nested Schema : Offering Credentials
Type:
array
Title:
Offering Credentials
The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.
Show Source
Nested Schema : Parameters
Type:
array
Title:
Parameters
The parameters resource is a child of the programs resource and provides a list of program parameters for a program.
Show Source
Nested Schema : curriculumItems-program-images-item-response
Type:
Show Source
object
-
ImageContent: string
(byte)
Title:
Attachment Content
Read Only:true
The content associated with an attachment in the attachment framework (such as a document or image). -
ImageContextCode: string
Title:
Curriculum Attachment Context
Read Only:true
Maximum Length:30
The context or usage of a curriculum item attachment file. -
ImageId: integer
(int64)
Title:
Curriculum Attachment ID
Read Only:true
The unique identifier for an attachment associated with a curriculum item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : curriculumItems-program-offeringCampuses-item-response
Type:
Show Source
object
-
CampusId: integer
(int64)
Title:
Campus
Read Only:true
The unique identifier for the campus where a program or course is offered. -
CampusName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the campus where a program or course is offered. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : curriculumItems-program-offeringCredentials-item-response
Type:
Show Source
object
-
CredentialDisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
A sequence number that overrides the default sort order for a program's credentials. -
CredentialFormalName: string
Read Only:
true
Maximum Length:100
The formal name of the credential. -
CredentialId: integer
(int64)
Title:
Credential
Read Only:true
The unique identifier for a credential value that is associated with a program. -
CredentialName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the credential. -
FinalCredentialFlag: boolean
Title:
Final Credential
Read Only:true
Maximum Length:1
An indicator that identifies a credential as the final or maximum credential available for a program. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : curriculumItems-program-parameters-item-response
Type:
Show Source
object
-
ContactHoursQuantity: integer
(int32)
Title:
Contact Hours
Read Only:true
Default Value:0
The number of contact hours required to satisfy a program parameter. -
DisplaySequenceNumber: integer
(int32)
Title:
Display Sequence
Read Only:true
A sequence number that overrides the default sort order for a program's child courses. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumCoursesQuantity: integer
(int32)
Title:
Maximum Number of Courses
Read Only:true
Default Value:0
The maximum number of courses that can be taken towards satisfying a program parameter. -
MaximumUnitsQuantity: integer
(int32)
Title:
Maximum Units
Read Only:true
Default Value:0
The maximum number of credits available for a program. -
MinimumCoursesQuantity: integer
(int32)
Title:
Minimum Number of Courses
Read Only:true
Default Value:0
The minimum number of courses that must be taken towards satisfying a program parameter. -
MinimumUnitsQuantity: integer
(int32)
Title:
Minimum Units
Read Only:true
Default Value:0
The minimum number of credits available for a program. -
ParameterSequenceNumber: integer
(int32)
Title:
Parameter Sequence Number
Read Only:true
The sequence number for a program parameter row. -
RequirementCategoryCode: string
Title:
Requirement Category Code
Read Only:true
Maximum Length:30
A code that categorizes program course requirements. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category ID
Read Only:true
The unique identifier for a requirement category code assigned to a program parameter. -
RequirementCategoryName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the requirement category code.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- images
-
Parameters:
- curriculumItemsUniqID:
$request.path.curriculumItemsUniqID
- programUniqID:
$request.path.programUniqID
The images resource is a child of the unscheduled course offering resource and provides a list of image attachments associated with a unscheduled course offering. - curriculumItemsUniqID:
- offeringCampuses
-
Parameters:
- curriculumItemsUniqID:
$request.path.curriculumItemsUniqID
- programUniqID:
$request.path.programUniqID
The offering campuses resource is a child of the unscheduled course offering resource and provides a list of campuses associated with a unscheduled course offering. - curriculumItemsUniqID:
- offeringCredentials
-
Parameters:
- curriculumItemsUniqID:
$request.path.curriculumItemsUniqID
- programUniqID:
$request.path.programUniqID
The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program. - curriculumItemsUniqID:
- parameters
-
Parameters:
- curriculumItemsUniqID:
$request.path.curriculumItemsUniqID
- programUniqID:
$request.path.programUniqID
The parameters resource is a child of the programs resource and provides a list of program parameters for a program. - curriculumItemsUniqID:
- tags
-
Parameters:
- curriculumItemsUniqID:
$request.path.curriculumItemsUniqID
- programUniqID:
$request.path.programUniqID
The tags resource is a child of the unscheduled course offering resource and provides a list of tags associated with a unscheduled course offering. - curriculumItemsUniqID: