Update an admission application
patch
/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}
Request
Path Parameters
-
ApplicationId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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/json
Root Schema : schema
Type:
Show Source
object
-
AcademicGroupStatusCode: string
Title:
Academic Group Status Code
Maximum Length:30
Item status code associated with the program group. -
AcademicGroupStatusDate: string
(date)
Title:
Academic Group Status Date
Date when the program group item status was applied. -
academicHistories: array
Academic Histories
Title:
Academic Histories
The academic history section is a child resource of an admissions application and provides information about an applicant's academic history. -
addresses: array
Addresses
Title:
Addresses
The addresses resource contains information about the various addresses provided on the application. -
applicationAttachments: array
Application Attachments
Title:
Application Attachments
The application attachments are a child resource of an admissions application and provide information about the documents attached to an application. -
applicationLongTextItems: array
Application Long Text Items
Title:
Application Long Text Items
The application long text items resource captures application-specific long text data. -
applicationPrograms: array
Application Programs
Title:
Application Programs
The application programs resource captures the programs for an application. -
courseSelections: array
Course Selections
Title:
Course Selections
The course selections resource captures course preference selections for an admissions application. -
emails: array
Emails
Title:
Emails
The emails resource contains information about the various email addresses provided on the application. -
emergencyContacts: array
Emergency Contacts
Title:
Emergency Contacts
The emergency contacts resource contains information about the various emergency contacts provided on the application. -
EvaluationStatusCode: string
Title:
Evaluation Status Code
Maximum Length:30
Status code associated with the application evaluation process. It indicates the various stages of evaluation such as in process, assigned, and in review. -
EvaluatorComment: string
Title:
Evaluator Comment
Maximum Length:1000
User entered comment for this evaluation. -
EvaluatorId: integer
(int64)
Title:
Evaluator ID
Trading community architecture party identifier for the person evaluating the admissions application. -
extracurricularActivities: array
Extracurricular Activities
Title:
Extracurricular Activities
The extracurricular activities section is a child resource of an admissions application and provides information about an applicant's extracurricular activities. -
names: array
Names
Title:
Names
The names resource contains information about the various names provided on the application. -
PaymentStatusCode: string
Title:
Payment Status Code
Maximum Length:30
Indicates the payment status of the application. -
PercentComplete: number
Title:
Percent Complete
Percent complete for the application form. -
personDetails: array
Person Details
Title:
Person Details
The person details resource provides information about the applicant's person profile. -
phones: array
Phones
Title:
Phones
The phones resource contains information about the various phone numbers provided on the application. -
races: array
Races
Title:
Races
The races resource contains information about the various races provided on the application. -
recommendations: array
Recommendations
Title:
Recommendations
The recommendation section is a child resource of an admissions application and provides information about an applicant's recommenders. -
relationships: array
Relationships
Title:
Relationships
The relationships section is a child resource of an admissions application and provides information about an applicant's relationships.
Nested Schema : Academic Histories
Type:
array
Title:
Academic Histories
The academic history section is a child resource of an admissions application and provides information about an applicant's academic history.
Show Source
Nested Schema : Addresses
Type:
array
Title:
Addresses
The addresses resource contains information about the various addresses provided on the application.
Show Source
Nested Schema : Application Attachments
Type:
array
Title:
Application Attachments
The application attachments are a child resource of an admissions application and provide information about the documents attached to an application.
Show Source
Nested Schema : Application Long Text Items
Type:
array
Title:
Application Long Text Items
The application long text items resource captures application-specific long text data.
Show Source
Nested Schema : Application Programs
Type:
array
Title:
Application Programs
The application programs resource captures the programs for an application.
Show Source
Nested Schema : Course Selections
Type:
array
Title:
Course Selections
The course selections resource captures course preference selections for an admissions application.
Show Source
Nested Schema : Emails
Type:
array
Title:
Emails
The emails resource contains information about the various email addresses provided on the application.
Show Source
Nested Schema : Emergency Contacts
Type:
array
Title:
Emergency Contacts
The emergency contacts resource contains information about the various emergency contacts provided on the application.
Show Source
Nested Schema : Extracurricular Activities
Type:
array
Title:
Extracurricular Activities
The extracurricular activities section is a child resource of an admissions application and provides information about an applicant's extracurricular activities.
Show Source
Nested Schema : Names
Type:
array
Title:
Names
The names resource contains information about the various names provided on the application.
Show Source
Nested Schema : Person Details
Type:
array
Title:
Person Details
The person details resource provides information about the applicant's person profile.
Show Source
Nested Schema : Phones
Type:
array
Title:
Phones
The phones resource contains information about the various phone numbers provided on the application.
Show Source
Nested Schema : Races
Type:
array
Title:
Races
The races resource contains information about the various races provided on the application.
Show Source
Nested Schema : Recommendations
Type:
array
Title:
Recommendations
The recommendation section is a child resource of an admissions application and provides information about an applicant's recommenders.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships section is a child resource of an admissions application and provides information about an applicant's relationships.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AcademicLevelCode: string
Title:
Academic Level Code
Maximum Length:30
Code for the academic level in which student studied, such as a code for grade 9 level or grade 10 level. -
ClassRankPosition: integer
(int32)
Title:
Class Rank Position
Rank position of the student in the class. -
ClassRankSize: integer
(int32)
Title:
Class Rank Size
Size of the class in which the student had a rank. -
ContactAddress: string
Title:
Contact Address
Maximum Length:1000
Location address of the external contact associated with an academic history. -
ContactEmailAddress: string
Title:
Contact Email Address
Maximum Length:1000
Email address of the external contact associated with an academic history. -
ContactFirstName: string
Title:
Contact First Name
Maximum Length:150
First name of the external contact associated with an academic history. -
ContactLastName: string
Title:
Contact Last Name
Maximum Length:150
Last name of the external contact associated with an academic history. -
ContactNameTitle: string
Title:
Contact Title
Maximum Length:100
Title of external contact, such as counselor. -
ContactPartyId: integer
(int64)
Title:
Contact Party ID
Trading community party identifier for the contact. -
DegreeCode: string
Title:
Degree Code
Maximum Length:30
Code of the degree or qualification which the student earned. -
DegreeEarned: string
Title:
Degree Earned
Maximum Length:200
Degree or qualification which the student earned. -
EntryDate: string
(date)
Title:
Entry Date
Date the student was admitted to the external organization. -
GPA: number
Title:
GPA
School grade point average of the student. -
GPAWeightingCode: string
Title:
GPA Weighting
Maximum Length:30
Code for the weighting used to calculate the school grade point average of the student. -
GraduationDate: string
(date)
Title:
Graduation Date
The date the student graduated from the external organization. -
GraduationFlag: boolean
Title:
Graduation Indicator
Maximum Length:1
Indicates whether the student graduated from the external organization. -
HomeSchoolFlag: boolean
Title:
Home School Indicator
Maximum Length:1
Indicates whether the student has been home schooled. -
MajorProgramCode: string
Title:
Major Program Code
Maximum Length:30
Major or program which the student earned a degree from. -
OrganizationOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. -
OrganizationOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name was entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
OrganizationPartyId: integer
(int64)
Title:
External Organization Party ID
Trading community party identifier for the external organization associated with an academic history. -
OrganizationTypeCode: string
Title:
External Organization Type Code
Maximum Length:30
External organization type, for example secondary school. -
PhoneAreaCode: string
Title:
Contact Phone Area Code
Maximum Length:10
Phone area code of the external contact associated with an academic history. -
PhoneCountryCode: string
Title:
Contact Phone Country Code
Maximum Length:10
Phone country code of the external contact associated with an academic history. -
PhoneNumber: string
Title:
Contact Phone Number
Maximum Length:40
Phone contact number of the external contact associated with an academic history. -
ReducedPriceMealFlag: boolean
Title:
Free or Reduced Price Meal Indicator
Maximum Length:1
Indicates whether the student qualified for free or reduced price meals at school. -
StudentIdentifier: string
Title:
Student ID
Maximum Length:50
Identifier assigned to the student by the organization.
Nested Schema : admissionApplications-applicationAttachments-item-patch-request
Type:
Show Source
object
-
AttachmentMetadata: string
Title:
Attachment Metadata
Maximum Length:4000
Additional information about the attachment stored and utilized by the owning functional area. -
DatatypeCode: string
Title:
Data Type Code
Unique identifier for the data type code for an attachment. -
Description: string
Title:
Description
Description of the attached file. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attached file. -
FileName: string
Title:
File Name
Name of the attached file. -
FileURL: string
Title:
File URL
The URL for the attached file. -
HeyCategoryCode: string
Title:
HEY Category Code
Maximum Length:30
User-defined code that indicates the higher education attachment type. -
PkOneValue: string
Title:
Primary Key Value 1
Maximum Length:150
First primary key of the business object the attachment is associated with. -
Title: string
Title:
Title
Title of the attached file. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Type of content for the attached file, for example text or plain.
Nested Schema : admissionApplications-applicationLongTextItems-item-patch-request
Type:
Show Source
object
-
CategoryCode: string
Title:
Category Code
Maximum Length:30
Identifies the category of the long text data. -
ClobData: string
(byte)
Title:
Long Text
The long text data associated with the application. -
ClobMetadata: string
(byte)
Title:
Long Text Metadata
Additional information about the long text data stored and utilized by the owning functional area.
Nested Schema : admissionApplications-applicationPrograms-item-patch-request
Type:
Show Source
object
-
AcademicGroupActionCode: string
Title:
Academic Group Action Code
Maximum Length:30
Item action code associated with the program group. -
AcademicGroupActionReasonCode: string
Title:
Academic Group Action Reason Code
Maximum Length:30
Action reason code associated with the program group. -
AcademicGroupActionReasonId: integer
(int64)
Title:
Academic Group Action Reason ID
Action reason identifier associated with the program group. -
applicationProgramItemStatuses: array
Application Program Item Statuses
Title:
Application Program Item Statuses
The application program item statuses resource captures the status history of an application program.
Nested Schema : Application Program Item Statuses
Type:
array
Title:
Application Program Item Statuses
The application program item statuses resource captures the status history of an application program.
Show Source
Nested Schema : admissionApplications-applicationPrograms-applicationProgramItemStatuses-item-patch-request
Type:
Show Source
object
Nested Schema : schema
Type:
Show Source
object
-
CourseCurriculumId: integer
(int64)
Title:
Course Curriculum ID
The curriculum identifier for the selected course. -
CourseListCurriculumId: integer
(int64)
Title:
Course List Curriculum ID
The curriculum identifier for the course list of the selected course. -
CourseListSequence: integer
(int32)
Title:
Course List Sequence
Default Value:1
The sequence of the course list for the associated course selection. -
CoursePreference: integer
(int32)
Title:
Course Preference
Default Value:1
Course selection preference sequence number. -
ProgramCurriculumId: integer
(int64)
Title:
Program Curriculum ID
The curriculum identifier for the program of the selected course. -
SelectionDateTime: string
(date-time)
Title:
Selection Date
The date of the course selection.
Nested Schema : schema
Type:
Show Source
object
-
AcademicLevelCode: string
Title:
Academic Level Code
Maximum Length:30
Academic level code when the activity occurred. -
ActivityDescription: string
Title:
Activity Description
Maximum Length:1000
Description of the extracurricular activity. -
ActivityTypeCode: string
Title:
Activity Type Code
Maximum Length:30
Activity type code of the extracurricular activity. -
ContactAddress: string
Title:
Contact Address
Maximum Length:1000
Location address of the external contact associated with an extracurricular activity. -
ContactEmailAddress: string
Title:
Contact Email Address
Maximum Length:1000
Email address of the external contact associated with an extracurricular activity. -
ContactFirstName: string
Title:
Contact First Name
Maximum Length:150
First name of the external contact associated with an extracurricular activity. -
ContactLastName: string
Title:
Contact Last Name
Maximum Length:150
Last name of the external contact associated with an extracurricular activity. -
ContactNameTitle: string
Title:
Contact Title
Maximum Length:100
Title of external contact, such as counselor. -
EndDate: string
(date)
Title:
End Date
Date when the extracurricular activity ended. -
HoursPERWeek: integer
(int32)
Title:
Hours per Week
Number of hours per week that student participates in the activity. -
InterestedInPursuingCode: string
Title:
Interested in Pursuing Code
Maximum Length:30
Indicates if student is interested in pursuing the activity at the institution. -
OrganizationOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
OrganizationOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
OrganizationPartyId: integer
(int64)
Title:
External Organization Party ID
Trading community party identifier for the external organization where the activity occurred. -
PhoneAreaCode: string
Title:
Contact Phone Area Code
Maximum Length:10
Phone area code of the external contact associated with an extracurricular activity. -
PhoneCountryCode: string
Title:
Contact Phone Country Code
Maximum Length:10
Phone country code of the external contact associated with an extracurricular activity. -
PhoneNumber: string
Title:
Contact Phone Number
Maximum Length:40
Phone contact number of the external contact associated with an extracurricular activity. -
PositionHeld: string
Title:
Position Held
Maximum Length:100
Position held for the extracurricular activity, such as captain or treasurer. -
StartDate: string
(date)
Title:
Start Date
Date when the extracurricular activity started. -
WeeksPERYear: integer
(int32)
Title:
Weeks per Year
Number of weeks per year that student participates in the activity.
Nested Schema : admissionApplications-recommendations-item-patch-request
Type:
Show Source
object
-
LengthOfRelationship: number
Title:
Length of Relationship
Indicates how long the student has known the recommender, in years. -
OrganizationAddress: string
Title:
External Organization Address
Maximum Length:500
Location address of the external organization associated with the recommender. -
OrganizationOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
OrganizationOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
OrganizationPartyId: integer
(int64)
Title:
External Organization Party ID
Trading community party identifier for the external organization associated with the recommender. -
PhoneAreaCode: string
Title:
Recommender Phone Area Code
Maximum Length:10
Phone area code of the recommender. -
PhoneCountryCode: string
Title:
Recommender Phone Country Code
Maximum Length:10
Phone country code of the recommender. -
PhoneNumber: string
Title:
Recommender Phone Number
Maximum Length:40
Phone Number of the recommender. -
RecommendationTypeCode: string
Title:
Recommendation Type Code
Maximum Length:30
Type code for the individual, group, or organization offering the recommendation. -
RecommenderAddress: string
Title:
Recommender Address
Maximum Length:1000
Address of the recommender. -
RecommenderDescription: string
Title:
Recommender Description
Maximum Length:1000
Description of the recommender. -
RecommenderEmailAddress: string
Title:
Recommender Email Address
Maximum Length:1000
Email address of the recommender. -
RecommenderFirstName: string
Title:
Recommender First Name
Maximum Length:150
First name of the recommender. -
RecommenderLastName: string
Title:
Recommender Last Name
Maximum Length:150
Last name of the recommender. -
RecommenderNameTitle: string
Title:
Recommender Title
Maximum Length:100
Title of the recommender, such as counselor. -
RelationshipToStudent: string
Title:
Relationship to Student
Maximum Length:200
Indicates how the student knows the recommender. -
SendInviteFlag: boolean
Title:
Send Invite Indicator
Indicates if invite has been sent.
Nested Schema : admissionApplications-relationships-item-patch-request
Type:
Show Source
object
-
AttendedInstDegreeRecCode: string
Title:
Institution Degree Code
Maximum Length:30
Code of the highest degree earned by the relationship specified. -
AttendedInstitutionDate: string
(date)
Title:
Institution Degree Date
Date the degree was received at this institution for the relationship specified. -
AttendedInstitutionFlag: boolean
Title:
Attended Institution
Maximum Length:1
Indicates whether the relationship specified has attended this institution. -
HighestDegreeEarnedCode: string
Title:
Highest Degree Earned Code
Maximum Length:30
Name of the degree earned at this institution for the relationship specified. -
HighestDegreeEarnedDate: string
(date)
Title:
Highest Degree Earned Date
Date on which the highest degree was earned for the relationship specified. -
HighestDegreeOrgPartyId: integer
(int64)
Title:
Highest Degree Institution ID
Trading community party identifier for the external organization where the relative has earned the highest degree. -
HighestOrgOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
HighestOrgOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
PhoneAreaCode: string
Title:
Phone Area Code
Maximum Length:10
Phone area code of the relationship specified. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
Phone country code of the relationship specified. -
PhoneNumber: string
Title:
Phone Number
Maximum Length:40
Phone contact number of the relationship specified. -
RelationshipEmployedIn: string
Title:
Relationship Place of Employment
Maximum Length:60
Place where the relationship specified is employed. -
RelationshipFirstName: string
Title:
Relationship First Name
Maximum Length:150
First name of the relationship specified. -
RelationshipGenderCode: string
Title:
Relationship Gender Code
Maximum Length:30
Gender of the relationship specified. -
RelationshipLastName: string
Title:
Relationship Last Name
Maximum Length:150
Last name of the relationship specified. -
RelationshipLivingFlag: boolean
Title:
Relationship Living
Maximum Length:1
Indicates whether the relationship specified is alive or deceased. -
RelationshipMailingAddr: string
Title:
Relationship Mailing Address
Maximum Length:1000
Mailing address of the relationship specified. -
RelationshipMiddleName: string
Title:
Relationship Middle Name
Maximum Length:60
Middle name of the relationship specified. -
RelationshipOccupation: string
Title:
Relationship Occupation
Maximum Length:60
Occupation or professional title of the relationship specified. -
RelationshipPersonalEmail: string
Title:
Relationship Personal Email
Maximum Length:1000
Email of the relationship specified. -
RelationshipPrefix: string
Title:
Relationship Prefix
Maximum Length:100
Name prefix for the relationship specified. -
RelationshipSuffix: string
Title:
Relationship Suffix
Maximum Length:30
Name suffix for the relationship specified. -
RelationshipTypeCode: string
Title:
Relationship Type Code
Maximum Length:30
Type code of the relationship. -
RelativesBirthCountryCode: string
Title:
Relationship Birth Country Code
Maximum Length:30
Country where the relationship specified was born. -
UndergradDegreeDate: string
(date)
Title:
Undergrad Degree Earned Date
Date the undergrad degree was earned for the relationship specified. -
UndergradDegreeEarnFlag: boolean
Title:
Undergrad Degree Earned
Maximum Length:1
Indicates whether the relationship specified holds an undergrad degree. -
UndergradOrgOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
UndergradOrgOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
UndergradOrgPartyId: integer
(int64)
Title:
Undergrad Institution ID
Trading community party identifier for the external organization associated with the relationship specified.
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.
Root Schema : admissionApplications-item-response
Type:
Show Source
object
-
AcademicGroupItemId: integer
(int64)
Title:
Academic Group ID
Curriculum item identifier for the program's academic group. -
AcademicGroupStatusCode: string
Title:
Academic Group Status Code
Maximum Length:30
Item status code associated with the program group. -
AcademicGroupStatusCodeMeaning: string
Title:
Academic Group Status
Read Only:true
Maximum Length:80
Meaning for item status code associated with the program group. -
AcademicGroupStatusDate: string
(date)
Title:
Academic Group Status Date
Date when the program group item status was applied. -
academicHistories: array
Academic Histories
Title:
Academic Histories
The academic history section is a child resource of an admissions application and provides information about an applicant's academic history. -
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
Admissions application academic level identifier. -
AcademicLevelName: string
Title:
Academic Level
Read Only:true
Maximum Length:100
Name of academic level. -
AcademicProgramItemId: integer
(int64)
Title:
Academic Program ID
Curriculum item identifier for the program. -
AcademicProgramItemName: string
Title:
Name
Read Only:true
Maximum Length:150
Curriculum item name of the program. -
addresses: array
Addresses
Title:
Addresses
The addresses resource contains information about the various addresses provided on the application. -
AdmitAcademicPeriodId: integer
(int64)
Title:
Admit Academic Period ID
Admit academic period identifier. -
AdmitAcademicPeriodName: string
Title:
Admit Academic Period
Read Only:true
Maximum Length:50
Name of admit academic period. -
AdmitEndDate: string
(date)
Title:
Admit End Date
Read Only:true
The end date of the date range to which the applicant is applying. -
AdmitStartDate: string
(date)
Title:
Admit Start Date
Read Only:true
The start date of the date range to which the applicant is applying. -
AdmitStartTypeCode: string
Title:
Admit Start Type
Read Only:true
Maximum Length:30
The admit start type, for example, period or date range. -
AdmitStartTypeMeaning: string
Title:
Admit Start Type
Read Only:true
Maximum Length:80
Meaning of admit start type code. -
AdmitTypeCode: string
Title:
Admit Type
Maximum Length:30
Type of applicant before entry to the academic institution, for example a transfer applicant. -
AdmitTypeMeaning: string
Title:
Admit Type
Read Only:true
Maximum Length:80
Meaning of admit type code. -
applicationAttachments: array
Application Attachments
Title:
Application Attachments
The application attachments are a child resource of an admissions application and provide information about the documents attached to an application. -
ApplicationDate: string
(date)
Title:
Date of Application
Read Only:true
Date when the admissions application was submitted. -
ApplicationExternalIdentifier: string
Title:
Application External Identifier
Maximum Length:30
Admissions application external identifier, for example the Common Application identifier. -
ApplicationId: integer
(int64)
Title:
Application ID
Read Only:true
The generated unique identifier for an application. -
applicationLongTextItems: array
Application Long Text Items
Title:
Application Long Text Items
The application long text items resource captures application-specific long text data. -
applicationPrograms: array
Application Programs
Title:
Application Programs
The application programs resource captures the programs for an application. -
ApplicationSourceCode: string
Title:
Application Source
Maximum Length:30
Source of the admissions application, for example the Common Application or a paper application. -
ApplicationSourceMeaning: string
Title:
Application Source
Read Only:true
Maximum Length:80
Meaning of application source code. -
ApplicationURL: string
Title:
Application URL
Read Only:true
The URL that will display the application. -
BaseApplicationId: integer
(int64)
Title:
Base Application ID
Read Only:true
Identifier for the admissions application this row belongs to. -
CampusId: integer
(int64)
Title:
Campus ID
Unique identifier for the campus the student is attending. -
CampusName: string
Title:
Campus
Read Only:true
Maximum Length:50
Name of the campus the student is attending. -
ConstituentId: string
Title:
Constituent ID
Read Only:true
Maximum Length:30
The unique identifier for a constituent. -
courseSelections: array
Course Selections
Title:
Course Selections
The course selections resource captures course preference selections for an admissions application. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the application row was created. -
emails: array
Emails
Title:
Emails
The emails resource contains information about the various email addresses provided on the application. -
emergencyContacts: array
Emergency Contacts
Title:
Emergency Contacts
The emergency contacts resource contains information about the various emergency contacts provided on the application. -
EvaluationStatusCode: string
Title:
Evaluation Status Code
Maximum Length:30
Status code associated with the application evaluation process. It indicates the various stages of evaluation such as in process, assigned, and in review. -
EvaluationStatusMeaning: string
Title:
Evaluation Status
Read Only:true
Maximum Length:80
Meaning of the evaluation status. -
EvaluatorComment: string
Title:
Evaluator Comment
Maximum Length:1000
User entered comment for this evaluation. -
EvaluatorId: integer
(int64)
Title:
Evaluator ID
Trading community architecture party identifier for the person evaluating the admissions application. -
EvaluatorName: string
Title:
Evaluator Name
Read Only:true
Maximum Length:360
Trading community architecture party name of the person evaluating the admissions application. -
extracurricularActivities: array
Extracurricular Activities
Title:
Extracurricular Activities
The extracurricular activities section is a child resource of an admissions application and provides information about an applicant's extracurricular activities. -
InstitutionId: integer
(int64)
Title:
Institution ID
Admissions application institution identifier. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
Name of institution. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
names: array
Names
Title:
Names
The names resource contains information about the various names provided on the application. -
PartyId: integer
(int64)
Title:
Party ID
Person trading community architecture party identifier associated with the admissions application. -
PaymentStatusCode: string
Title:
Payment Status Code
Maximum Length:30
Indicates the payment status of the application. -
PaymentStatusMeaning: string
Title:
Payment Status Meaning
Read Only:true
Maximum Length:80
Meaning of the payment status. -
PercentComplete: number
Title:
Percent Complete
Percent complete for the application form. -
personDetails: array
Person Details
Title:
Person Details
The person details resource provides information about the applicant's person profile. -
phones: array
Phones
Title:
Phones
The phones resource contains information about the various phone numbers provided on the application. -
PreferredName: string
Title:
Name
Read Only:true
The preferred name of the applicant. If the preferred name isn't found, then the party name will be used. -
PrimaryEmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The primary email address of the person. -
ProgramSequence: integer
(int32)
Title:
Program Sequence
Admissions application program sequence, for example application submission order. -
races: array
Races
Title:
Races
The races resource contains information about the various races provided on the application. -
ReapplicationFlag: boolean
Title:
Reapplication
Read Only:true
Maximum Length:1
Indicates whether the applicant has already applied to this program. -
recommendations: array
Recommendations
Title:
Recommendations
The recommendation section is a child resource of an admissions application and provides information about an applicant's recommenders. -
relationships: array
Relationships
Title:
Relationships
The relationships section is a child resource of an admissions application and provides information about an applicant's relationships. -
RowSequence: integer
(int32)
Title:
Row Sequence
Read Only:true
Sequence number of the application row. -
RowTypeCode: string
Title:
Row Type
Read Only:true
Maximum Length:30
Default Value:ORA_HEQ_APPLICATION
Indicates the type of application row, such as application or application snapshot. -
RowTypeMeaning: string
Title:
Row Type
Read Only:true
Maximum Length:80
The meaning of the row type code. A list of accepted values is defined in the lookup type ORA_HEQ_APPLICATION_REC_TYPE. -
SubmissionDate: string
(date-time)
Title:
Submission Date
Read Only:true
The date the application was submitted. -
SupportedPrivileges: string
Title:
Supported Privileges
Read Only:true
Maximum Length:255
Indicates the supported privileges for this application row.
Nested Schema : Academic Histories
Type:
array
Title:
Academic Histories
The academic history section is a child resource of an admissions application and provides information about an applicant's academic history.
Show Source
Nested Schema : Addresses
Type:
array
Title:
Addresses
The addresses resource contains information about the various addresses provided on the application.
Show Source
Nested Schema : Application Attachments
Type:
array
Title:
Application Attachments
The application attachments are a child resource of an admissions application and provide information about the documents attached to an application.
Show Source
Nested Schema : Application Long Text Items
Type:
array
Title:
Application Long Text Items
The application long text items resource captures application-specific long text data.
Show Source
Nested Schema : Application Programs
Type:
array
Title:
Application Programs
The application programs resource captures the programs for an application.
Show Source
Nested Schema : Course Selections
Type:
array
Title:
Course Selections
The course selections resource captures course preference selections for an admissions application.
Show Source
Nested Schema : Emails
Type:
array
Title:
Emails
The emails resource contains information about the various email addresses provided on the application.
Show Source
Nested Schema : Emergency Contacts
Type:
array
Title:
Emergency Contacts
The emergency contacts resource contains information about the various emergency contacts provided on the application.
Show Source
Nested Schema : Extracurricular Activities
Type:
array
Title:
Extracurricular Activities
The extracurricular activities section is a child resource of an admissions application and provides information about an applicant's extracurricular activities.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Names
Type:
array
Title:
Names
The names resource contains information about the various names provided on the application.
Show Source
Nested Schema : Person Details
Type:
array
Title:
Person Details
The person details resource provides information about the applicant's person profile.
Show Source
Nested Schema : Phones
Type:
array
Title:
Phones
The phones resource contains information about the various phone numbers provided on the application.
Show Source
Nested Schema : Races
Type:
array
Title:
Races
The races resource contains information about the various races provided on the application.
Show Source
Nested Schema : Recommendations
Type:
array
Title:
Recommendations
The recommendation section is a child resource of an admissions application and provides information about an applicant's recommenders.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships section is a child resource of an admissions application and provides information about an applicant's relationships.
Show Source
Nested Schema : admissionApplications-academicHistories-item-response
Type:
Show Source
object
-
AcademicHistoryTransactionId: integer
(int64)
Title:
Academic History Transaction ID
Read Only:true
Academic history transaction unique identifier. -
AcademicLevelCode: string
Title:
Academic Level Code
Maximum Length:30
Code for the academic level in which student studied, such as a code for grade 9 level or grade 10 level. -
AcademicLevelCodeMeaning: string
Title:
Academic Level
Read Only:true
Maximum Length:80
Meaning of academic level code. -
ClassRankPosition: integer
(int32)
Title:
Class Rank Position
Rank position of the student in the class. -
ClassRankSize: integer
(int32)
Title:
Class Rank Size
Size of the class in which the student had a rank. -
ContactAddress: string
Title:
Contact Address
Maximum Length:1000
Location address of the external contact associated with an academic history. -
ContactEmailAddress: string
Title:
Contact Email Address
Maximum Length:1000
Email address of the external contact associated with an academic history. -
ContactFirstName: string
Title:
Contact First Name
Maximum Length:150
First name of the external contact associated with an academic history. -
ContactLastName: string
Title:
Contact Last Name
Maximum Length:150
Last name of the external contact associated with an academic history. -
ContactNameTitle: string
Title:
Contact Title
Maximum Length:100
Title of external contact, such as counselor. -
ContactPartyId: integer
(int64)
Title:
Contact Party ID
Trading community party identifier for the contact. -
DegreeCode: string
Title:
Degree Code
Maximum Length:30
Code of the degree or qualification which the student earned. -
DegreeCodeMeaning: string
Title:
Degree
Read Only:true
Maximum Length:80
Meaning of degree code. -
DegreeEarned: string
Title:
Degree Earned
Maximum Length:200
Degree or qualification which the student earned. -
EntryDate: string
(date)
Title:
Entry Date
Date the student was admitted to the external organization. -
GPA: number
Title:
GPA
School grade point average of the student. -
GPAWeightingCode: string
Title:
GPA Weighting
Maximum Length:30
Code for the weighting used to calculate the school grade point average of the student. -
GPAWeightingMeaning: string
Title:
GPA Weighting
Read Only:true
Maximum Length:80
Meaning of the GPA weighting code. -
GraduationDate: string
(date)
Title:
Graduation Date
The date the student graduated from the external organization. -
GraduationFlag: boolean
Title:
Graduation Indicator
Maximum Length:1
Indicates whether the student graduated from the external organization. -
HomeSchoolFlag: boolean
Title:
Home School Indicator
Maximum Length:1
Indicates whether the student has been home schooled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorProgramCode: string
Title:
Major Program Code
Maximum Length:30
Major or program which the student earned a degree from. -
MajorProgramCodeMeaning: string
Title:
Major Program
Read Only:true
Maximum Length:80
Meaning of the major program code. -
OrganizationName: string
Title:
Organization Name
Read Only:true
Maximum Length:100
Name of the external organization associated with the academic history. -
OrganizationOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. -
OrganizationOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name was entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
OrganizationPartyId: integer
(int64)
Title:
External Organization Party ID
Trading community party identifier for the external organization associated with an academic history. -
OrganizationTypeCode: string
Title:
External Organization Type Code
Maximum Length:30
External organization type, for example secondary school. -
OrganizationTypeCodeMeaning: string
Title:
External Organization Type
Read Only:true
Maximum Length:80
Meaning of organization type code. -
PhoneAreaCode: string
Title:
Contact Phone Area Code
Maximum Length:10
Phone area code of the external contact associated with an academic history. -
PhoneCountryCode: string
Title:
Contact Phone Country Code
Maximum Length:10
Phone country code of the external contact associated with an academic history. -
PhoneNumber: string
Title:
Contact Phone Number
Maximum Length:40
Phone contact number of the external contact associated with an academic history. -
ReducedPriceMealFlag: boolean
Title:
Free or Reduced Price Meal Indicator
Maximum Length:1
Indicates whether the student qualified for free or reduced price meals at school. -
StudentIdentifier: string
Title:
Student ID
Maximum Length:50
Identifier assigned to the student by the organization.
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 : admissionApplications-addresses-item-response
Type:
Show Source
object
-
AddrElementAttributeFive: string
Title:
Additional Address Element 5
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeFour: string
Title:
Additional Address Element 4
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeOne: string
Title:
Additional Address Element 1
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeThree: string
Title:
Additional Address Element 3
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttributeTwo: string
Title:
Additional Address Element 2
Read Only:true
Maximum Length:150
The additional address element to support flexible address format. -
AddressFour: string
Title:
Address Line 4
Read Only:true
Maximum Length:240
The fourth line for address. -
AddressId: integer
(int64)
Title:
Address ID
Read Only:true
Unique identifier for an address associated with an application. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Read Only:true
Maximum Length:560
The phonetic or Kana representation of the Kanji address line. Used in Japan. -
AddressOne: string
Title:
Address Line 1
Read Only:true
Maximum Length:240
The first line for address. -
AddressThree: string
Title:
Address Line 3
Read Only:true
Maximum Length:240
The third line for address. -
AddressTwo: string
Title:
Address Line 2
Read Only:true
Maximum Length:240
The second line for address. -
AddressUseTypeCode: string
Title:
Address Type
Read Only:true
Maximum Length:30
The type of address usage, such as home or legal. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE. -
AddressUseTypeMeaning: string
Title:
Address Type
Read Only:true
Maximum Length:80
The meaning of the site use type code. A list of accepted values is defined in the lookup type ORA_HEY_PARTY_SITE_USE. -
Building: string
Title:
Building
Read Only:true
Maximum Length:240
The building name or number at a given address. -
City: string
Title:
City
Read Only:true
Maximum Length:60
The city for the address. -
CountryCode: string
Title:
Country Code
Read Only:true
Maximum Length:2
The 2-letter country code. For example, FR for France. -
County: string
Title:
County
Read Only:true
Maximum Length:60
The county for the address. -
EndDate: string
(date)
Title:
End Date
Read Only:true
The end date for the address row. -
FloorNumber: string
Title:
Floor Number
Read Only:true
Maximum Length:40
The floor number at a given address or in a particular building when building number is provided. -
FutureAddressFlag: boolean
Title:
Future Address Indicator
Read Only:true
Indicates that the address is future dated. -
HouseType: string
Title:
House Type
Read Only:true
Maximum Length:30
The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
HouseTypeMeaning: string
Title:
House Type
Read Only:true
Maximum Length:80
The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDirections: string
Title:
Location Directions
Read Only:true
Maximum Length:640
The directions to the location. -
Position: string
Title:
Position
Read Only:true
Maximum Length:50
The primary direction such as North or East that's used to access the location. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
The postal code for the address. -
PostalPlusFourCode: string
Title:
Postal Code Extension
Read Only:true
Maximum Length:20
The four digit extension to the United States postal code. -
PreferredFlag: boolean
Title:
Preferred
Read Only:true
Maximum Length:1
Indicates the preferred address. The default value is: false. -
Province: string
Title:
Province Code
Read Only:true
Maximum Length:60
The province for the address. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
The start date for the address row. -
StateCode: string
Title:
State Code
Read Only:true
Maximum Length:60
The state for the address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-applicationAttachments-item-response
Type:
Show Source
object
-
ActivatedFlag: boolean
Title:
Activated Indicator
Read Only:true
Maximum Length:1
Default Value:false
Indicates if the attachment is activated or pending activation. -
AttachmentMetadata: string
Title:
Attachment Metadata
Maximum Length:4000
Additional information about the attachment stored and utilized by the owning functional area. -
DatatypeCode: string
Title:
Data Type Code
Unique identifier for the data type code for an attachment. -
Description: string
Title:
Description
Description of the attached file. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attached file. -
FileName: string
Title:
File Name
Name of the attached file. -
FileURL: string
Title:
File URL
The URL for the attached file. -
HeyAttachmentId: integer
(int64)
Title:
HEY Attachment ID
Read Only:true
Unique identifier for higher education attachment. -
HeyCategoryCode: string
Title:
HEY Category Code
Maximum Length:30
User-defined code that indicates the higher education attachment type. -
HeyCategoryMeaning: string
Title:
HEY Category
Read Only:true
Maximum Length:80
Meaning of category code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockedFlag: boolean
Title:
Locked Indicator
Read Only:true
Maximum Length:1
Default Value:false
Indicates the attachment can't be modified or deleted. -
PartyId: integer
(int64)
Title:
Party ID
Person trading community architecture party identifier associated with the attachment. -
PkOneValue: string
Title:
Primary Key Value 1
Maximum Length:150
First primary key of the business object the attachment is associated with. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:30
Identifies the business object the attachment is associated with. -
SourceObjectMeaning: string
Title:
Source Object Meaning
Read Only:true
Maximum Length:80
Meaning of source object. -
Title: string
Title:
Title
Title of the attached file. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Type of content for the attached file, for example text or plain.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-applicationLongTextItems-item-response
Type:
Show Source
object
-
ApplicationClobDataId: integer
(int64)
Title:
Long Text Item ID
Read Only:true
Unique identifier for a long text data item associated with an application. -
CategoryCode: string
Title:
Category Code
Maximum Length:30
Identifies the category of the long text data. -
CategoryCodeMeaning: string
Title:
Category
Read Only:true
Maximum Length:80
The name of the long text category. -
ClobData: string
(byte)
Title:
Long Text
The long text data associated with the application. -
ClobMetadata: string
(byte)
Title:
Long Text Metadata
Additional information about the long text data stored and utilized by the owning functional area. -
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 : admissionApplications-applicationPrograms-item-response
Type:
Show Source
object
-
AcademicGroupActionCode: string
Title:
Academic Group Action Code
Maximum Length:30
Item action code associated with the program group. -
AcademicGroupActionDate: string
(date)
Title:
Academic Group Action Date
Read Only:true
Date when the program group item action was applied. -
AcademicGroupActionMeaning: string
Title:
Academic Group Action
Read Only:true
Maximum Length:80
Item action meaning associated with the program group. -
AcademicGroupActionReasonCode: string
Title:
Academic Group Action Reason Code
Maximum Length:30
Action reason code associated with the program group. -
AcademicGroupActionReasonId: integer
(int64)
Title:
Academic Group Action Reason ID
Action reason identifier associated with the program group. -
AcademicGroupActionReasonName: string
Title:
Academic Group Action Reason
Read Only:true
Maximum Length:50
Action reason name associated with the program group. -
AcademicGroupItemId: integer
(int64)
Title:
Academic Group ID
Read Only:true
Curriculum item identifier for the program's academic group. -
AcademicGroupItemName: string
Title:
Academic Group
Read Only:true
Maximum Length:150
Curriculum item name of the program's academic group. -
AcademicGroupStatusCode: string
Title:
Academic Group Status Code
Read Only:true
Maximum Length:30
Item status code associated with the program group. -
AcademicGroupStatusCodeMeaning: string
Title:
Academic Group Status
Read Only:true
Maximum Length:80
Item status meaning associated with the program group. -
AcademicGroupStatusDate: string
(date)
Title:
Academic Group Status Date
Read Only:true
Date when the program group item status was applied. -
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
Read Only:true
Academic level identifier for the program. -
AcademicLevelName: string
Title:
Academic Level
Read Only:true
Maximum Length:100
Academic level name of the program. -
AcademicProgramItemId: integer
(int64)
Title:
Academic Program ID
Read Only:true
Curriculum item identifier for the program. -
AcademicProgramItemName: string
Title:
Name
Read Only:true
Maximum Length:150
Curriculum item name of the program. -
ApplicationProgramId: integer
(int64)
Title:
Application Program ID
Read Only:true
Admissions application program identifier. -
applicationProgramItemStatuses: array
Application Program Item Statuses
Title:
Application Program Item Statuses
The application program item statuses resource captures the status history of an application program. -
CampusId: integer
(int64)
Title:
Campus ID
Read Only:true
Unique identifier for the campus of the program to which the applicant is applying. -
CampusName: string
Title:
Campus
Read Only:true
Maximum Length:50
Name of the campus of the program to which the applicant is applying. -
InstitutionId: integer
(int64)
Title:
Institution ID
Read Only:true
Admissions application institution identifier. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
Admissions application institution name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramSequence: integer
(int32)
Title:
Program Sequence
Read Only:true
Admissions application program sequence, for example, application submission order.
Nested Schema : Application Program Item Statuses
Type:
array
Title:
Application Program Item Statuses
The application program item statuses resource captures the status history of an application program.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-applicationPrograms-applicationProgramItemStatuses-item-response
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Read Only:true
Maximum Length:30
Action code associated with the admissions application or program item. -
ActionDate: string
(date)
Title:
Action Date
Read Only:true
Date when the admissions application or program item action was applied. -
ActionMeaning: string
Title:
Action
Read Only:true
Maximum Length:80
Action meaning associated with the admissions application or program item. -
ActionReasonCode: string
Title:
Action Reason Code
Read Only:true
Maximum Length:30
Action reason code associated with the admissions application or program action. -
ActionReasonId: integer
(int64)
Title:
Action Reason ID
Read Only:true
Action reason identifier associated with the admissions application or program action. -
ActionReasonName: string
Title:
Action Reason
Read Only:true
Maximum Length:50
Action reason name associated with the admissions application or program action. -
ApplicationProgramItemStatusId: integer
(int64)
Title:
Application Program Item Status ID
Read Only:true
Admissions application program item status identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
Status code associated with the program item or admissions application. -
StatusDate: string
(date)
Title:
Status Date
Read Only:true
Date when the admissions application or program item status was applied. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
Status code meaning associated with the program item or admissions application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-courseSelections-item-response
Type:
Show Source
object
-
CatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
The catalog number of the course selection. -
CourseCurriculumId: integer
(int64)
Title:
Course Curriculum ID
The curriculum identifier for the selected course. -
CourseDescription: string
(byte)
Title:
Description
Read Only:true
The description of the selected course. -
CourseListCurriculumId: integer
(int64)
Title:
Course List Curriculum ID
The curriculum identifier for the course list of the selected course. -
CourseListName: string
Title:
Course List Name
Read Only:true
Maximum Length:50
The name for the course list of the selected course. -
CourseListSequence: integer
(int32)
Title:
Course List Sequence
Default Value:1
The sequence of the course list for the associated course selection. -
CourseListTitle: string
Title:
Course List Title
Read Only:true
Maximum Length:100
The title for the course list of the selected course. -
CourseName: string
Title:
Course Name
Read Only:true
Maximum Length:50
The name of the selected course. -
CoursePreference: integer
(int32)
Title:
Course Preference
Default Value:1
Course selection preference sequence number. -
CourseSelectionId: integer
(int64)
Title:
Course Selection ID
Read Only:true
Unique identifier for the course selection. -
CourseTitle: string
Title:
Course Title
Read Only:true
Maximum Length:100
The title of the selected course. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramCurriculumId: integer
(int64)
Title:
Program Curriculum ID
The curriculum identifier for the program of the selected course. -
ProgramName: string
Title:
Program Name
Read Only:true
Maximum Length:50
The name for the academic program of the selected course. -
ProgramTitle: string
Title:
Program Title
Read Only:true
Maximum Length:100
The title for the academic program of the selected course. -
SelectionDateTime: string
(date-time)
Title:
Selection Date
The date of the course selection. -
Subject: string
Title:
Subject
Read Only:true
Maximum Length:50
The subject of the course selection. -
SubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
The subject code of the course selection.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-emails-item-response
Type:
Show Source
object
-
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the person. -
EmailId: integer
(int64)
Title:
Email ID
Read Only:true
The unique identifier for an email address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PreferredFlag: boolean
Title:
Preferred
Read Only:true
Maximum Length:1
Indicates the preferred email address. -
PurposeCode: string
Title:
Purpose
Read Only:true
Maximum Length:30
The type of purpose for email contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type ORA_HEY_EMAIL_CONTACT_PURPOSE. -
PurposeMeaning: string
Title:
Purpose
Read Only:true
Maximum Length:80
The meaning of the purpose code. A list of accepted values is defined in the lookup type ORA_HEY_EMAIL_CONTACT_PURPOSE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-emergencyContacts-item-response
Type:
Show Source
object
-
ContactTypeCode: string
Title:
Contact Type Code
Read Only:true
Maximum Length:30
The emergency contact type of the person. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE. -
ContactTypeMeaning: string
Title:
Relationship Type
Read Only:true
Maximum Length:80
The meaning of emergency contact type. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE. -
Email: string
Title:
Email
Read Only:true
Maximum Length:1000
The email address of the emergency contact. -
EmergencyContactId: integer
(int64)
Title:
Emergency Contact ID
Read Only:true
The unique identifier for emergency contact. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name by which emergency contact is known. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name by which emergency contact is known. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneAreaCode: string
Title:
Area Code
Read Only:true
Maximum Length:10
The country area code for the emergency contact phone number. -
PhoneCountryCode: string
Title:
Select Country
Read Only:true
Maximum Length:10
The international country code for the emergency contact phone number. -
PhoneExtension: string
Title:
Extension
Read Only:true
Maximum Length:10
The extension number for the emergency contact phone number. -
PhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:40
The emergency contact phone number. -
PreferredFlag: boolean
Title:
Preferred
Read Only:true
Maximum Length:1
Indicates the preferred emergency contact. -
SingleNameFlag: boolean
Title:
Only One Name
Read Only:true
Maximum Length:1
Indicates if the person has single name.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-extracurricularActivities-item-response
Type:
Show Source
object
-
AcademicLevelCode: string
Title:
Academic Level Code
Maximum Length:30
Academic level code when the activity occurred. -
AcademicLevelCodeMeaning: string
Title:
Academic Level
Read Only:true
Maximum Length:80
Meaning of academic level code. -
ActivityDescription: string
Title:
Activity Description
Maximum Length:1000
Description of the extracurricular activity. -
ActivityTypeCode: string
Title:
Activity Type Code
Maximum Length:30
Activity type code of the extracurricular activity. -
ActivityTypeCodeMeaning: string
Title:
Activity Type
Read Only:true
Maximum Length:80
Meaning of activity type code. -
ContactAddress: string
Title:
Contact Address
Maximum Length:1000
Location address of the external contact associated with an extracurricular activity. -
ContactEmailAddress: string
Title:
Contact Email Address
Maximum Length:1000
Email address of the external contact associated with an extracurricular activity. -
ContactFirstName: string
Title:
Contact First Name
Maximum Length:150
First name of the external contact associated with an extracurricular activity. -
ContactLastName: string
Title:
Contact Last Name
Maximum Length:150
Last name of the external contact associated with an extracurricular activity. -
ContactNameTitle: string
Title:
Contact Title
Maximum Length:100
Title of external contact, such as counselor. -
EndDate: string
(date)
Title:
End Date
Date when the extracurricular activity ended. -
ExtracurricularTransactionId: integer
(int64)
Title:
Extracurricular Transaction ID
Read Only:true
Extracurricular activity transaction unique identifier. -
HoursPERWeek: integer
(int32)
Title:
Hours per Week
Number of hours per week that student participates in the activity. -
InterestedInPursuingCode: string
Title:
Interested in Pursuing Code
Maximum Length:30
Indicates if student is interested in pursuing the activity at the institution. -
InterestedInPursuingCodeMeaning: string
Title:
Interested in Pursuing
Read Only:true
Maximum Length:80
Meaning of pursuing code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Title:
Organization Name
Read Only:true
Maximum Length:100
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
OrganizationOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
OrganizationOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
OrganizationPartyId: integer
(int64)
Title:
External Organization Party ID
Trading community party identifier for the external organization where the activity occurred. -
PhoneAreaCode: string
Title:
Contact Phone Area Code
Maximum Length:10
Phone area code of the external contact associated with an extracurricular activity. -
PhoneCountryCode: string
Title:
Contact Phone Country Code
Maximum Length:10
Phone country code of the external contact associated with an extracurricular activity. -
PhoneNumber: string
Title:
Contact Phone Number
Maximum Length:40
Phone contact number of the external contact associated with an extracurricular activity. -
PositionHeld: string
Title:
Position Held
Maximum Length:100
Position held for the extracurricular activity, such as captain or treasurer. -
StartDate: string
(date)
Title:
Start Date
Date when the extracurricular activity started. -
WeeksPERYear: integer
(int32)
Title:
Weeks per Year
Number of weeks per year that student participates in the activity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-names-item-response
Type:
Show Source
object
-
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of a person. -
FullName: string
Title:
Full Name
Read Only:true
Maximum Length:360
The full name of the person. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of a person. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The middle name of a person. -
NameId: integer
(int64)
Title:
Name ID
Read Only:true
The unique identifier for a name. -
NameSuffix: string
Title:
Name Suffix
Read Only:true
Maximum Length:30
The suffix can be junior or senior. -
NameTypeCode: string
Title:
Name Type
Read Only:true
Maximum Length:30
The type of the name. It's a value defined by the Additional Party Name and Identifier Type entity. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE. -
NameTypeMeaning: string
Title:
Name Type
Read Only:true
Maximum Length:80
The meaning of the name type code. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE. -
PreferredFlag: boolean
Title:
Preferred
Read Only:true
Maximum Length:1
Indicates the name as preferred name for this party within this name type. -
SingleNameFlag: boolean
Title:
Only One Name
Read Only:true
Maximum Length:1
Indicates if the person has single name. -
Title: string
Title:
Title
Read Only:true
Maximum Length:60
The title of the person, such as Mr or Mrs.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-personDetails-item-response
Type:
Show Source
object
-
BirthCountryCode: string
Title:
Country of Birth
Read Only:true
Maximum Length:30
The country where this person was born. -
BirthCountryName: string
Title:
Country of Birth
Read Only:true
Maximum Length:80
The name of the birth country code. -
CitizenshipCountryCode: string
Title:
Country of Citizenship
Read Only:true
Maximum Length:2
The code for the country from which a person claims citizenship. -
CitizenshipCountryName: string
Title:
Country of Citizenship
Read Only:true
Maximum Length:80
The name of the citizenship country code. -
CitizenshipStatusCode: string
Title:
Citizenship Status
Read Only:true
Maximum Length:30
The primary citizenship status, for example, Citizen, Permanent Resident, and Noncitizen. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS. -
CitizenshipStatusMeaning: string
Title:
Citizenship Status
Read Only:true
Maximum Length:80
The meaning of the citizenship status. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS. -
DateOfBirth: string
(date)
Title:
Date of Birth
Read Only:true
The date when the person was born. -
GenderCode: string
Title:
Gender
Read Only:true
Maximum Length:30
The gender of the person, such as male, female, or unknown. A list of accepted values is defined in the lookup type HZ_GENDER. -
GenderIdentityCode: string
Title:
Gender Identity
Read Only:true
Maximum Length:30
The gender identity of the person. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY. -
GenderIdentityMeaning: string
Title:
Gender Identity
Read Only:true
Maximum Length:80
The meaning of gender identity. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY. -
GenderIdentityValue: string
Title:
Gender Identity Value
Read Only:true
Maximum Length:100
The gender identity value of the person, to capture the free text value when the GENDER_IDENTITY_CODE is Not Listed. -
GenderMeaning: string
Title:
Gender
Read Only:true
Maximum Length:80
The meaning of the gender code. A list of accepted values is defined in the lookup type HZ_GENDER. -
HispanicOrLatinoCode: string
Title:
Hispanic or Latino
Read Only:true
Maximum Length:60
The hispanic or latino code of the student, if any. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY. -
HispanicOrLatinoMeaning: string
Title:
Hispanic or Latino
Read Only:true
Maximum Length:80
The meaning of the hispanic or latino code. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaritalStatusCode: string
Title:
Marital Status
Read Only:true
Maximum Length:30
The marital status of the person. A list of accepted values is defined in the lookup type MARITAL_STATUS. -
MaritalStatusEffectiveDate: string
(date)
Title:
Marital Status as Of
Read Only:true
The date when the person's marital status changed. -
MaritalStatusMeaning: string
Title:
Marital Status
Read Only:true
Maximum Length:80
The meaning of the marital status code. A list of accepted values is defined in the lookup type MARITAL_STATUS. -
PersonalDetailId: integer
(int64)
Title:
Personal Detail ID
Read Only:true
Unique identifier for personal data information associated with an application. -
PlaceOfBirth: string
Title:
Place of Birth
Read Only:true
Maximum Length:60
The place of birth of the student. -
PreferredPronounsCode: string
Title:
Preferred Pronouns
Read Only:true
Maximum Length:30
The preferred pronouns of the person. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN. -
PreferredPronounsMeaning: string
Title:
Preferred Pronouns
Read Only:true
Maximum Length:80
The meaning of preferred pronouns. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN. -
PreferredPronounsValue: string
Title:
Preferred Pronouns Value
Read Only:true
Maximum Length:100
The preferred pronouns value of the person, to capture the free text value when the PREFERRED_PRONOUNS_CODE is Not Listed. -
PrimaryLanguageCode: string
Title:
Primary Language
Read Only:true
Maximum Length:30
The primary language of the person. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE. -
PrimaryLanguageMeaning: string
Title:
Primary Language
Read Only:true
Maximum Length:80
The meaning of primary language. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE. -
PrimaryLanguageValue: string
Title:
Primary Language Value
Read Only:true
Maximum Length:100
The primary language value of the person, to capture the free text value when the PRIMARY_LANGUAGE_CODE is Not Listed. -
ResidenceCountryCode: string
Title:
Country of Residence
Read Only:true
Maximum Length:30
The country this person normally resides in. -
ResidenceCountryName: string
Title:
Country of Residence
Read Only:true
Maximum Length:80
The name of the residency country code. -
VisaTypeCode: string
Title:
Visa Type
Read Only:true
Maximum Length:30
The visa type of the person. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE. -
VisaTypeMeaning: string
Title:
Visa Type
Read Only:true
Maximum Length:80
The meaning of visa type. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-phones-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneAreaCode: string
Title:
Area Code
Read Only:true
Maximum Length:20
The area code within a country code. -
PhoneCountryCode: string
Title:
Country Code
Read Only:true
Maximum Length:10
The international country code for a phone number. For example, 33 for France. -
PhoneExtension: string
Title:
Phone Extension
Read Only:true
Maximum Length:20
The extension number for a phone number. -
PhoneId: integer
(int64)
Title:
Phone ID
Read Only:true
The unique identifier for the phone number. -
PhoneNumber: string
Title:
Phone Number
Read Only:true
Maximum Length:40
The phone number formatted in the local format. The number should not include area code, country code, or extension. -
PreferredFlag: boolean
Title:
Preferred
Read Only:true
Maximum Length:1
Indicates the preferred phone number. -
PurposeCode: string
Title:
Purpose
Read Only:true
Maximum Length:30
The type of purpose for phone contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type ORA_HEY_PHONE_CONTACT_PURPOSE. -
PurposeMeaning: string
Title:
Purpose
Read Only:true
Maximum Length:80
The meaning of the purpose code. A list of accepted values is defined in the lookup type ORA_HEY_PHONE_CONTACT_PURPOSE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-races-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RaceCode: string
Title:
Race
Read Only:true
Maximum Length:30
The race of the person. A list of accepted values is defined in the lookup type ORA_HEY_RACE. -
RaceCodeMeaning: string
Title:
Race
Read Only:true
Maximum Length:80
The meaning of race. A list of accepted values is defined in the lookup type ORA_HEY_RACE. -
RaceId: integer
(int64)
Title:
Race ID
Read Only:true
The unique identifier of person's race.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-recommendations-item-response
Type:
Show Source
object
-
LastInviteSentDate: string
(date-time)
Title:
Last Invite Sent Date
Read Only:true
The last date and time a recommendation invite was sent for the row. -
LengthOfRelationship: number
Title:
Length of Relationship
Indicates how long the student has known the recommender, in years. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationAddress: string
Title:
External Organization Address
Maximum Length:500
Location address of the external organization associated with the recommender. -
OrganizationName: string
Title:
Organization Name
Read Only:true
Maximum Length:100
Indicates whether an external organization name has been entered by the student. -
OrganizationOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
OrganizationOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
OrganizationPartyId: integer
(int64)
Title:
External Organization Party ID
Trading community party identifier for the external organization associated with the recommender. -
PhoneAreaCode: string
Title:
Recommender Phone Area Code
Maximum Length:10
Phone area code of the recommender. -
PhoneCountryCode: string
Title:
Recommender Phone Country Code
Maximum Length:10
Phone country code of the recommender. -
PhoneNumber: string
Title:
Recommender Phone Number
Maximum Length:40
Phone Number of the recommender. -
RecommendationTransactionId: integer
(int64)
Title:
Recommendation Transaction ID
Read Only:true
Recommendation transaction unique identifier. -
RecommendationTypeCode: string
Title:
Recommendation Type Code
Maximum Length:30
Type code for the individual, group, or organization offering the recommendation. -
RecommendationTypeCodeMeaning: string
Title:
Recommendation Type
Read Only:true
Maximum Length:80
Meaning of recommendation type code. -
RecommenderAddress: string
Title:
Recommender Address
Maximum Length:1000
Address of the recommender. -
RecommenderDescription: string
Title:
Recommender Description
Maximum Length:1000
Description of the recommender. -
RecommenderEmailAddress: string
Title:
Recommender Email Address
Maximum Length:1000
Email address of the recommender. -
RecommenderFirstName: string
Title:
Recommender First Name
Maximum Length:150
First name of the recommender. -
RecommenderLastName: string
Title:
Recommender Last Name
Maximum Length:150
Last name of the recommender. -
RecommenderNameTitle: string
Title:
Recommender Title
Maximum Length:100
Title of the recommender, such as counselor. -
RelationshipToStudent: string
Title:
Relationship to Student
Maximum Length:200
Indicates how the student knows the recommender. -
SendInviteFlag: boolean
Title:
Send Invite Indicator
Indicates if invite has been sent.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : admissionApplications-relationships-item-response
Type:
Show Source
object
-
AttendedInstDegreeRecCode: string
Title:
Institution Degree Code
Maximum Length:30
Code of the highest degree earned by the relationship specified. -
AttendedInstDegreeRecMeaning: string
Title:
Institution Degree
Read Only:true
Maximum Length:80
Meaning of the highest degree earned by the relationship specified. -
AttendedInstitutionDate: string
(date)
Title:
Institution Degree Date
Date the degree was received at this institution for the relationship specified. -
AttendedInstitutionFlag: boolean
Title:
Attended Institution
Maximum Length:1
Indicates whether the relationship specified has attended this institution. -
HighestDegreeEarnedCode: string
Title:
Highest Degree Earned Code
Maximum Length:30
Name of the degree earned at this institution for the relationship specified. -
HighestDegreeEarnedDate: string
(date)
Title:
Highest Degree Earned Date
Date on which the highest degree was earned for the relationship specified. -
HighestDegreeEarnedMeaning: string
Title:
Highest Degree Earned
Read Only:true
Maximum Length:80
Meaning of the degree earned for the relationship specified. -
HighestDegreeOrgPartyId: integer
(int64)
Title:
Highest Degree Institution ID
Trading community party identifier for the external organization where the relative has earned the highest degree. -
HighestDegreeOrgPartyName: string
Title:
Highest Degree Institution
Read Only:true
Maximum Length:100
Trading community party name of the external organization where the relative has earned the highest degree. -
HighestOrgOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
HighestOrgOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneAreaCode: string
Title:
Phone Area Code
Maximum Length:10
Phone area code of the relationship specified. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
Phone country code of the relationship specified. -
PhoneNumber: string
Title:
Phone Number
Maximum Length:40
Phone contact number of the relationship specified. -
RelationshipEmployedIn: string
Title:
Relationship Place of Employment
Maximum Length:60
Place where the relationship specified is employed. -
RelationshipFirstName: string
Title:
Relationship First Name
Maximum Length:150
First name of the relationship specified. -
RelationshipGenderCode: string
Title:
Relationship Gender Code
Maximum Length:30
Gender of the relationship specified. -
RelationshipGenderMeaning: string
Title:
Relationship Gender
Read Only:true
Maximum Length:80
Meaning of relationship specified gender. -
RelationshipLastName: string
Title:
Relationship Last Name
Maximum Length:150
Last name of the relationship specified. -
RelationshipLivingFlag: boolean
Title:
Relationship Living
Maximum Length:1
Indicates whether the relationship specified is alive or deceased. -
RelationshipMailingAddr: string
Title:
Relationship Mailing Address
Maximum Length:1000
Mailing address of the relationship specified. -
RelationshipMiddleName: string
Title:
Relationship Middle Name
Maximum Length:60
Middle name of the relationship specified. -
RelationshipOccupation: string
Title:
Relationship Occupation
Maximum Length:60
Occupation or professional title of the relationship specified. -
RelationshipPersonalEmail: string
Title:
Relationship Personal Email
Maximum Length:1000
Email of the relationship specified. -
RelationshipPrefix: string
Title:
Relationship Prefix
Maximum Length:100
Name prefix for the relationship specified. -
RelationshipSuffix: string
Title:
Relationship Suffix
Maximum Length:30
Name suffix for the relationship specified. -
RelationshipTransactionId: integer
(int64)
Title:
Relationship Transaction ID
Read Only:true
Relationship transaction unique identifier. -
RelationshipTypeCode: string
Title:
Relationship Type Code
Maximum Length:30
Type code of the relationship. -
RelationshipTypeMeaning: string
Title:
Relationship Type
Read Only:true
Maximum Length:80
Meaning of the relationship code. -
RelativesBirthCountryCode: string
Title:
Relationship Birth Country Code
Maximum Length:30
Country where the relationship specified was born. -
RelativesBirthCountryName: string
Title:
Relationship Country of Birth
Read Only:true
Maximum Length:80
Name of country where the relationship specified was born. -
UndergradDegreeDate: string
(date)
Title:
Undergrad Degree Earned Date
Date the undergrad degree was earned for the relationship specified. -
UndergradDegreeEarnFlag: boolean
Title:
Undergrad Degree Earned
Maximum Length:1
Indicates whether the relationship specified holds an undergrad degree. -
UndergradOrgOtherName: string
Title:
Other External Organization Name
Maximum Length:200
Trading community party name of the external organization name entered by the student. If the student enters an organization name, the external organization entered didn't exist in the database. -
UndergradOrgOtherNameFlag: boolean
Title:
Other External Organization Name Indicator
Maximum Length:1
Indicates whether an external organization name has been entered by the student. -
UndergradOrgPartyId: integer
(int64)
Title:
Undergrad Institution ID
Trading community party identifier for the external organization associated with the relationship specified. -
UndergradOrgPartyName: string
Title:
Undergrad Institution
Read Only:true
Maximum Length:100
Trading community party name of the external organization associated with the relationship specified.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AcademicGroupLOV
-
Parameters:
- finder:
ByProgramFinder%3BAcademicProgramId%3D{AcademicProgramItemId}
The following properties are defined on the LOV link relation:- Source Attribute: AcademicGroupItemId; Target Attribute: AcademicGroupId
- Display Attribute: CurriculumName
- finder:
- AcademicInstitutionLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: InstitutionId; Target Attribute: InstitutionId
- Display Attribute: InstitutionName
- AcademicLevelLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicLevelId; Target Attribute: AcademicLevelId
- Display Attribute: LevelName
- AdmitStartTypeCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEQ_ADMIT_START_TYPE%2CLookupCode%3D{AdmitStartTypeCode}
The following properties are defined on the LOV link relation:- Source Attribute: AdmitStartTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AdmitTypeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEQ_ADMIT_TYPE%2CLookupCode%3D{AdmitTypeCode}
The following properties are defined on the LOV link relation:- Source Attribute: AdmitTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ApplicationSourceLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEQ_APPLICATION_SOURCE%2CLookupCode%3D{ApplicationSourceCode}
The following properties are defined on the LOV link relation:- Source Attribute: ApplicationSourceCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CampusLOV
-
Parameters:
- finder:
ByInstitutionFinder%3BInstitutionId%3D{InstitutionId}
The following properties are defined on the LOV link relation:- Source Attribute: CampusId; Target Attribute: CampusId
- Display Attribute: CampusName
- finder:
- EvaluationStatusCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEQ_EVALUATION_STATUS%2CLookupCode%3D{EvaluationStatusCode}
The following properties are defined on the LOV link relation:- Source Attribute: EvaluationStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PaymentStatusCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEQ_PAYMENT_STATUS%2CLookupCode%3D{PaymentStatusCode}
The following properties are defined on the LOV link relation:- Source Attribute: PaymentStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ProgramLOV
-
Operation: /fscmRestApi/resources/11.13.18.05/programsThe following properties are defined on the LOV link relation:
- Source Attribute: AcademicProgramItemId; Target Attribute: CurriculumId
- Display Attribute: CurriculumName
- StatusCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEQ_APPLICATION_STATUS%2CLookupCode%3D{AcademicGroupStatusCode}
The following properties are defined on the LOV link relation:- Source Attribute: AcademicGroupStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- academicHistories
-
Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/academicHistoriesParameters:
- ApplicationId:
$request.path.ApplicationId
The academic history section is a child resource of an admissions application and provides information about an applicant's academic history. - ApplicationId:
- addresses
-
Parameters:
- ApplicationId:
$request.path.ApplicationId
The addresses resource contains information about the various addresses provided on the application. - ApplicationId:
- applicationAttachments
-
Parameters:
- ApplicationId:
$request.path.ApplicationId
The application attachments are a child resource of an admissions application and provide information about the documents attached to an application. - ApplicationId:
- applicationLongTextItems
-
Parameters:
- ApplicationId:
$request.path.ApplicationId
The application long text items resource captures application-specific long text data. - ApplicationId:
- applicationPrograms
-
Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationProgramsParameters:
- ApplicationId:
$request.path.ApplicationId
The application programs resource captures the programs for an application. - ApplicationId:
- courseSelections
-
Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/courseSelectionsParameters:
- ApplicationId:
$request.path.ApplicationId
The course selections resource captures course preference selections for an admissions application. - ApplicationId:
- emails
-
Parameters:
- ApplicationId:
$request.path.ApplicationId
The emails resource contains information about the various email addresses provided on the application. - ApplicationId:
- emergencyContacts
-
Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/emergencyContactsParameters:
- ApplicationId:
$request.path.ApplicationId
The emergency contacts resource contains information about the various emergency contacts provided on the application. - ApplicationId:
- extracurricularActivities
-
Parameters:
- ApplicationId:
$request.path.ApplicationId
The extracurricular activities section is a child resource of an admissions application and provides information about an applicant's extracurricular activities. - ApplicationId:
- names
-
Parameters:
- ApplicationId:
$request.path.ApplicationId
The names resource contains information about the various names provided on the application. - ApplicationId:
- personDetails
-
Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/personDetailsParameters:
- ApplicationId:
$request.path.ApplicationId
The person details resource provides information about the applicant's person profile. - ApplicationId:
- phones
-
Parameters:
- ApplicationId:
$request.path.ApplicationId
The phones resource contains information about the various phone numbers provided on the application. - ApplicationId:
- races
-
Parameters:
- ApplicationId:
$request.path.ApplicationId
The races resource contains information about the various races provided on the application. - ApplicationId:
- recommendations
-
Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/recommendationsParameters:
- ApplicationId:
$request.path.ApplicationId
The recommendation section is a child resource of an admissions application and provides information about an applicant's recommenders. - ApplicationId:
- relationships
-
Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/relationshipsParameters:
- ApplicationId:
$request.path.ApplicationId
The relationships section is a child resource of an admissions application and provides information about an applicant's relationships. - ApplicationId: