1. REST API for Oracle Fusion Cloud Student Management
  2. Tasks
  3. Admission Applications

Create an admissions application

post

/fscmRestApi/resources/11.13.18.05/admissionApplications

Request

Header Parameters
  • 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".
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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 : admissionApplications-academicHistories-item-post-request
Type: object
Show Source
  • 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.
  • Title: Class Rank Position
    Rank position of the student in the class.
  • Title: Class Rank Size
    Size of the class in which the student had a rank.
  • Title: Contact Address
    Maximum Length: 1000
    Location address of the external contact associated with an academic history.
  • Title: Contact Email Address
    Maximum Length: 1000
    Email address of the external contact associated with an academic history.
  • Title: Contact First Name
    Maximum Length: 150
    First name of the external contact associated with an academic history.
  • Title: Contact Last Name
    Maximum Length: 150
    Last name of the external contact associated with an academic history.
  • Title: Contact Title
    Maximum Length: 100
    Title of external contact, such as counselor.
  • Title: Contact Party ID
    Trading community party identifier for the contact.
  • Title: Degree Code
    Maximum Length: 30
    Code of the degree or qualification which the student earned.
  • Title: Degree Earned
    Maximum Length: 200
    Degree or qualification which the student earned.
  • Title: Entry Date
    Date the student was admitted to the external organization.
  • Title: GPA
    School grade point average of the student.
  • Title: GPA Weighting
    Maximum Length: 30
    Code for the weighting used to calculate the school grade point average of the student.
  • Title: Graduation Date
    The date the student graduated from the external organization.
  • Title: Graduation Indicator
    Maximum Length: 1
    Indicates whether the student graduated from the external organization.
  • Title: Home School Indicator
    Maximum Length: 1
    Indicates whether the student has been home schooled.
  • Title: Major Program Code
    Maximum Length: 30
    Major or program which the student earned a degree from.
  • Title: Other External Organization Name
    Maximum Length: 200
    Trading community party name of the external organization name entered by the student.
  • 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.
  • Title: External Organization Party ID
    Trading community party identifier for the external organization associated with an academic history.
  • Title: External Organization Type Code
    Maximum Length: 30
    External organization type, for example secondary school.
  • Title: Contact Phone Area Code
    Maximum Length: 10
    Phone area code of the external contact associated with an academic history.
  • Title: Contact Phone Country Code
    Maximum Length: 10
    Phone country code of the external contact associated with an academic history.
  • Title: Contact Phone Number
    Maximum Length: 40
    Phone contact number of the external contact associated with an academic history.
  • Title: Free or Reduced Price Meal Indicator
    Maximum Length: 1
    Indicates whether the student qualified for free or reduced price meals at school.
  • Title: Student ID
    Maximum Length: 50
    Identifier assigned to the student by the organization.
Nested Schema : admissionApplications-addresses-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : admissionApplications-applicationPrograms-item-post-request
Type: object
Show Source
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-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : admissionApplications-emails-item-post-request
Type: object
Show Source
Nested Schema : admissionApplications-emergencyContacts-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Academic Level Code
    Maximum Length: 30
    Academic level code when the activity occurred.
  • Title: Activity Description
    Maximum Length: 1000
    Description of the extracurricular activity.
  • Title: Activity Type Code
    Maximum Length: 30
    Activity type code of the extracurricular activity.
  • Title: Contact Address
    Maximum Length: 1000
    Location address of the external contact associated with an extracurricular activity.
  • Title: Contact Email Address
    Maximum Length: 1000
    Email address of the external contact associated with an extracurricular activity.
  • Title: Contact First Name
    Maximum Length: 150
    First name of the external contact associated with an extracurricular activity.
  • Title: Contact Last Name
    Maximum Length: 150
    Last name of the external contact associated with an extracurricular activity.
  • Title: Contact Title
    Maximum Length: 100
    Title of external contact, such as counselor.
  • Title: End Date
    Date when the extracurricular activity ended.
  • Title: Hours per Week
    Number of hours per week that student participates in the activity.
  • Title: Interested in Pursuing Code
    Maximum Length: 30
    Indicates if student is interested in pursuing the activity at the institution.
  • 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.
  • Title: Other External Organization Name Indicator
    Maximum Length: 1
    Indicates whether an external organization name has been entered by the student.
  • Title: External Organization Party ID
    Trading community party identifier for the external organization where the activity occurred.
  • Title: Contact Phone Area Code
    Maximum Length: 10
    Phone area code of the external contact associated with an extracurricular activity.
  • Title: Contact Phone Country Code
    Maximum Length: 10
    Phone country code of the external contact associated with an extracurricular activity.
  • Title: Contact Phone Number
    Maximum Length: 40
    Phone contact number of the external contact associated with an extracurricular activity.
  • Title: Position Held
    Maximum Length: 100
    Position held for the extracurricular activity, such as captain or treasurer.
  • Title: Start Date
    Date when the extracurricular activity started.
  • Title: Weeks per Year
    Number of weeks per year that student participates in the activity.
Nested Schema : admissionApplications-names-item-post-request
Type: object
Show Source
Nested Schema : admissionApplications-personDetails-item-post-request
Type: object
Show Source
Nested Schema : admissionApplications-phones-item-post-request
Type: object
Show Source
Nested Schema : admissionApplications-races-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : admissionApplications-item-response
Type: object
Show Source
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 : admissionApplications-academicHistories-item-response
Type: object
Show Source
Nested Schema : admissionApplications-addresses-item-response
Type: object
Show Source
  • Title: Additional Address Element 5
    Read Only: true
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Read Only: true
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 1
    Read Only: true
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Read Only: true
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Read Only: true
    Maximum Length: 150
    The additional address element to support flexible address format.
  • Title: Address Line 4
    Read Only: true
    Maximum Length: 240
    The fourth line for address.
  • Title: Address ID
    Read Only: true
    Unique identifier for an address associated with an application.
  • Title: Address Lines Phonetic
    Read Only: true
    Maximum Length: 560
    The phonetic or Kana representation of the Kanji address line. Used in Japan.
  • Title: Address Line 1
    Read Only: true
    Maximum Length: 240
    The first line for address.
  • Title: Address Line 3
    Read Only: true
    Maximum Length: 240
    The third line for address.
  • Title: Address Line 2
    Read Only: true
    Maximum Length: 240
    The second line for address.
  • 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.
  • 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.
  • Title: Building
    Read Only: true
    Maximum Length: 240
    The building name or number at a given address.
  • Title: City
    Read Only: true
    Maximum Length: 60
    The city for the address.
  • Title: Country Code
    Read Only: true
    Maximum Length: 2
    The 2-letter country code. For example, FR for France.
  • Title: County
    Read Only: true
    Maximum Length: 60
    The county for the address.
  • Title: End Date
    Read Only: true
    The end date for the address row.
  • 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.
  • Title: Future Address Indicator
    Read Only: true
    Indicates that the address is future dated.
  • 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.
  • 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
  • Title: Location Directions
    Read Only: true
    Maximum Length: 640
    The directions to the location.
  • Title: Position
    Read Only: true
    Maximum Length: 50
    The primary direction such as North or East that's used to access the location.
  • Title: Postal Code
    Read Only: true
    Maximum Length: 60
    The postal code for the address.
  • Title: Postal Code Extension
    Read Only: true
    Maximum Length: 20
    The four digit extension to the United States postal code.
  • Title: Preferred
    Read Only: true
    Maximum Length: 1
    Indicates the preferred address. The default value is: false.
  • Title: Province Code
    Read Only: true
    Maximum Length: 60
    The province for the address.
  • Title: Start Date
    Read Only: true
    The start date for the address row.
  • Title: State Code
    Read Only: true
    Maximum Length: 60
    The state for the address.
Nested Schema : admissionApplications-applicationAttachments-item-response
Type: object
Show Source
Nested Schema : admissionApplications-applicationLongTextItems-item-response
Type: object
Show Source
Nested Schema : admissionApplications-applicationPrograms-item-response
Type: object
Show Source
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-response
Type: object
Show Source
  • Title: Action Code
    Read Only: true
    Maximum Length: 30
    Action code associated with the admissions application or program item.
  • Title: Action Date
    Read Only: true
    Date when the admissions application or program item action was applied.
  • Title: Action
    Read Only: true
    Maximum Length: 80
    Action meaning associated with the admissions application or program item.
  • Title: Action Reason Code
    Read Only: true
    Maximum Length: 30
    Action reason code associated with the admissions application or program action.
  • Title: Action Reason ID
    Read Only: true
    Action reason identifier associated with the admissions application or program action.
  • Title: Action Reason
    Read Only: true
    Maximum Length: 50
    Action reason name associated with the admissions application or program action.
  • Title: Application Program Item Status ID
    Read Only: true
    Admissions application program item status identifier.
  • Links
  • Title: Status Code
    Read Only: true
    Maximum Length: 30
    Status code associated with the program item or admissions application.
  • Title: Status Date
    Read Only: true
    Date when the admissions application or program item status was applied.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Status code meaning associated with the program item or admissions application.
Nested Schema : admissionApplications-courseSelections-item-response
Type: object
Show Source
Nested Schema : admissionApplications-emails-item-response
Type: object
Show Source
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address of the person.
  • Title: Email ID
    Read Only: true
    The unique identifier for an email address.
  • Links
  • Title: Preferred
    Read Only: true
    Maximum Length: 1
    Indicates the preferred email address.
  • 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.
  • 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 : admissionApplications-emergencyContacts-item-response
Type: object
Show Source
  • 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.
  • 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.
  • Title: Email
    Read Only: true
    Maximum Length: 1000
    The email address of the emergency contact.
  • Title: Emergency Contact ID
    Read Only: true
    The unique identifier for emergency contact.
  • Title: First Name
    Read Only: true
    Maximum Length: 150
    The first name by which emergency contact is known.
  • Title: Last Name
    Read Only: true
    Maximum Length: 150
    The last name by which emergency contact is known.
  • Links
  • Title: Area Code
    Read Only: true
    Maximum Length: 10
    The country area code for the emergency contact phone number.
  • Title: Select Country
    Read Only: true
    Maximum Length: 10
    The international country code for the emergency contact phone number.
  • Title: Extension
    Read Only: true
    Maximum Length: 10
    The extension number for the emergency contact phone number.
  • Title: Phone
    Read Only: true
    Maximum Length: 40
    The emergency contact phone number.
  • Title: Preferred
    Read Only: true
    Maximum Length: 1
    Indicates the preferred emergency contact.
  • Title: Only One Name
    Read Only: true
    Maximum Length: 1
    Indicates if the person has single name.
Nested Schema : admissionApplications-extracurricularActivities-item-response
Type: object
Show Source
  • Title: Academic Level Code
    Maximum Length: 30
    Academic level code when the activity occurred.
  • Title: Academic Level
    Read Only: true
    Maximum Length: 80
    Meaning of academic level code.
  • Title: Activity Description
    Maximum Length: 1000
    Description of the extracurricular activity.
  • Title: Activity Type Code
    Maximum Length: 30
    Activity type code of the extracurricular activity.
  • Title: Activity Type
    Read Only: true
    Maximum Length: 80
    Meaning of activity type code.
  • Title: Contact Address
    Maximum Length: 1000
    Location address of the external contact associated with an extracurricular activity.
  • Title: Contact Email Address
    Maximum Length: 1000
    Email address of the external contact associated with an extracurricular activity.
  • Title: Contact First Name
    Maximum Length: 150
    First name of the external contact associated with an extracurricular activity.
  • Title: Contact Last Name
    Maximum Length: 150
    Last name of the external contact associated with an extracurricular activity.
  • Title: Contact Title
    Maximum Length: 100
    Title of external contact, such as counselor.
  • Title: End Date
    Date when the extracurricular activity ended.
  • Title: Extracurricular Transaction ID
    Read Only: true
    Extracurricular activity transaction unique identifier.
  • Title: Hours per Week
    Number of hours per week that student participates in the activity.
  • Title: Interested in Pursuing Code
    Maximum Length: 30
    Indicates if student is interested in pursuing the activity at the institution.
  • Title: Interested in Pursuing
    Read Only: true
    Maximum Length: 80
    Meaning of pursuing code.
  • Links
  • 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.
  • 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.
  • Title: Other External Organization Name Indicator
    Maximum Length: 1
    Indicates whether an external organization name has been entered by the student.
  • Title: External Organization Party ID
    Trading community party identifier for the external organization where the activity occurred.
  • Title: Contact Phone Area Code
    Maximum Length: 10
    Phone area code of the external contact associated with an extracurricular activity.
  • Title: Contact Phone Country Code
    Maximum Length: 10
    Phone country code of the external contact associated with an extracurricular activity.
  • Title: Contact Phone Number
    Maximum Length: 40
    Phone contact number of the external contact associated with an extracurricular activity.
  • Title: Position Held
    Maximum Length: 100
    Position held for the extracurricular activity, such as captain or treasurer.
  • Title: Start Date
    Date when the extracurricular activity started.
  • Title: Weeks per Year
    Number of weeks per year that student participates in the activity.
Nested Schema : admissionApplications-names-item-response
Type: object
Show Source
  • Title: First Name
    Read Only: true
    Maximum Length: 150
    The first name of a person.
  • Title: Full Name
    Read Only: true
    Maximum Length: 360
    The full name of the person.
  • Title: Last Name
    Read Only: true
    Maximum Length: 150
    The last name of a person.
  • Links
  • Title: Middle Name
    Read Only: true
    Maximum Length: 60
    The middle name of a person.
  • Title: Name ID
    Read Only: true
    The unique identifier for a name.
  • Title: Name Suffix
    Read Only: true
    Maximum Length: 30
    The suffix can be junior or senior.
  • 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.
  • 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.
  • Title: Preferred
    Read Only: true
    Maximum Length: 1
    Indicates the name as preferred name for this party within this name type.
  • Title: Only One Name
    Read Only: true
    Maximum Length: 1
    Indicates if the person has single name.
  • Title: Title
    Read Only: true
    Maximum Length: 60
    The title of the person, such as Mr or Mrs.
Nested Schema : admissionApplications-personDetails-item-response
Type: object
Show Source
  • Title: Country of Birth
    Read Only: true
    Maximum Length: 30
    The country where this person was born.
  • Title: Country of Birth
    Read Only: true
    Maximum Length: 80
    The name of the birth country code.
  • Title: Country of Citizenship
    Read Only: true
    Maximum Length: 2
    The code for the country from which a person claims citizenship.
  • Title: Country of Citizenship
    Read Only: true
    Maximum Length: 80
    The name of the citizenship country code.
  • 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.
  • 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.
  • Title: Date of Birth
    Read Only: true
    The date when the person was born.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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
  • 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.
  • Title: Marital Status as Of
    Read Only: true
    The date when the person's marital status changed.
  • 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.
  • Title: Personal Detail ID
    Read Only: true
    Unique identifier for personal data information associated with an application.
  • Title: Place of Birth
    Read Only: true
    Maximum Length: 60
    The place of birth of the student.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Country of Residence
    Read Only: true
    Maximum Length: 30
    The country this person normally resides in.
  • Title: Country of Residence
    Read Only: true
    Maximum Length: 80
    The name of the residency country code.
  • 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.
  • 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 : admissionApplications-phones-item-response
Type: object
Show Source
  • Links
  • Title: Area Code
    Read Only: true
    Maximum Length: 20
    The area code within a country code.
  • Title: Country Code
    Read Only: true
    Maximum Length: 10
    The international country code for a phone number. For example, 33 for France.
  • Title: Phone Extension
    Read Only: true
    Maximum Length: 20
    The extension number for a phone number.
  • Title: Phone ID
    Read Only: true
    The unique identifier for the phone number.
  • 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.
  • Title: Preferred
    Read Only: true
    Maximum Length: 1
    Indicates the preferred phone number.
  • 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.
  • 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 : admissionApplications-races-item-response
Type: object
Show Source
  • Links
  • 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.
  • 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.
  • Title: Race ID
    Read Only: true
    The unique identifier of person's race.
Nested Schema : admissionApplications-recommendations-item-response
Type: object
Show Source
Nested Schema : admissionApplications-relationships-item-response
Type: object
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
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
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
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
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
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
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
ProgramLOV
The 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
academicHistories
Parameters:
  • 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.
addresses
Parameters:
  • ApplicationId: $request.path.ApplicationId
The addresses resource contains information about the various addresses provided on the application.
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.
applicationLongTextItems
Parameters:
  • ApplicationId: $request.path.ApplicationId
The application long text items resource captures application-specific long text data.
applicationPrograms
Parameters:
  • ApplicationId: $request.path.ApplicationId
The application programs resource captures the programs for an application.
courseSelections
Parameters:
  • ApplicationId: $request.path.ApplicationId
The course selections resource captures course preference selections for an admissions application.
emails
Parameters:
  • ApplicationId: $request.path.ApplicationId
The emails resource contains information about the various email addresses provided on the application.
emergencyContacts
Parameters:
  • ApplicationId: $request.path.ApplicationId
The emergency contacts resource contains information about the various emergency contacts provided on the application.
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.
names
Parameters:
  • ApplicationId: $request.path.ApplicationId
The names resource contains information about the various names provided on the application.
personDetails
Parameters:
  • ApplicationId: $request.path.ApplicationId
The person details resource provides information about the applicant's person profile.
phones
Parameters:
  • ApplicationId: $request.path.ApplicationId
The phones resource contains information about the various phone numbers provided on the application.
races
Parameters:
  • ApplicationId: $request.path.ApplicationId
The races resource contains information about the various races provided on the application.
recommendations
Parameters:
  • ApplicationId: $request.path.ApplicationId
The recommendation section is a child resource of an admissions application and provides information about an applicant's recommenders.
relationships
Parameters:
  • ApplicationId: $request.path.ApplicationId
The relationships section is a child resource of an admissions application and provides information about an applicant's relationships.
Back to Top