Jump to

• Request
• Response

Get an admission application

get

/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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : admissionApplications-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AdmitEndDate":{
            "title":"Admit End Date",
            "type":"string",
            "description":"The end date of the date range to which the applicant is applying.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the application row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "addresses":{
            "title":"Addresses",
            "type":"array",
            "description":"The addresses resource contains information about the various addresses provided on the application.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-addresses-item-response"
            }
        },
        "ApplicationSourceMeaning":{
            "title":"Application Source",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of application source code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationExternalIdentifier":{
            "title":"Application External Identifier",
            "maxLength":"30",
            "type":"string",
            "description":"Admissions application external identifier, for example the Common Application identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmissionDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The date the application was submitted.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "recommendations":{
            "title":"Recommendations",
            "type":"array",
            "description":"The recommendation section is a child resource of an admissions application and provides information about an applicant's recommenders.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-recommendations-item-response"
            }
        },
        "personDetails":{
            "title":"Person Details",
            "type":"array",
            "description":"The person details resource provides information about the applicant's person profile.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-personDetails-item-response"
            },
            "x-cardinality":"1"
        },
        "ConstituentId":{
            "title":"Constituent ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a constituent.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationURL":{
            "title":"Application URL",
            "type":"string",
            "description":"The URL that will display the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"The relationships section is a child resource of an admissions application and provides information about an applicant's relationships.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-relationships-item-response"
            }
        },
        "AcademicGroupStatusCode":{
            "title":"Academic Group Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Item status code associated with the program group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "courseSelections":{
            "title":"Course Selections",
            "type":"array",
            "description":"The course selections resource captures course preference selections for an admissions application.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-courseSelections-item-response"
            }
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"Admissions application academic level identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"Admissions application institution identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RowSequence":{
            "title":"Row Sequence",
            "type":"integer",
            "description":"Sequence number of the application row.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "EvaluatorName":{
            "title":"Evaluator Name",
            "maxLength":"360",
            "type":"string",
            "description":"Trading community architecture party name of the person evaluating the admissions application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdmitTypeCode":{
            "title":"Admit Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of applicant before entry to the academic institution, for example a transfer applicant.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "academicHistories":{
            "title":"Academic Histories",
            "type":"array",
            "description":"The academic history section is a child resource of an admissions application and provides information about an applicant's academic history.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-academicHistories-item-response"
            }
        },
        "EvaluationStatusMeaning":{
            "title":"Evaluation Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the evaluation status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "races":{
            "title":"Races",
            "type":"array",
            "description":"The races resource contains information about the various races provided on the application.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-races-item-response"
            }
        },
        "applicationAttachments":{
            "title":"Application Attachments",
            "type":"array",
            "description":"The application attachments are a child resource of an admissions application and provide information about the documents attached to an application.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-applicationAttachments-item-response"
            }
        },
        "applicationLongTextItems":{
            "title":"Application Long Text Items",
            "type":"array",
            "description":"The application long text items resource captures application-specific long text data.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-applicationLongTextItems-item-response"
            }
        },
        "ApplicationId":{
            "title":"Application ID",
            "type":"integer",
            "description":"The generated unique identifier for an application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentStatusCode":{
            "title":"Payment Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the payment status of the application.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReapplicationFlag":{
            "title":"Reapplication",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the applicant has already applied to this program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "applicationPrograms":{
            "title":"Application Programs",
            "type":"array",
            "description":"The application programs resource captures the programs for an application.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-applicationPrograms-item-response"
            }
        },
        "phones":{
            "title":"Phones",
            "type":"array",
            "description":"The phones resource contains information about the various phone numbers provided on the application.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-phones-item-response"
            }
        },
        "RowTypeCode":{
            "title":"Row Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of application row, such as application or application snapshot.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_HEQ_APPLICATION",
            "x-queryable":true
        },
        "emergencyContacts":{
            "title":"Emergency Contacts",
            "type":"array",
            "description":"The emergency contacts resource contains information about the various emergency contacts provided on the application.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-emergencyContacts-item-response"
            }
        },
        "extracurricularActivities":{
            "title":"Extracurricular Activities",
            "type":"array",
            "description":"The extracurricular activities section is a child resource of an admissions application and provides information about an applicant's extracurricular activities.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-extracurricularActivities-item-response"
            }
        },
        "CampusName":{
            "title":"Campus",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the campus the student is attending.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EvaluatorId":{
            "title":"Evaluator ID",
            "type":"integer",
            "description":"Trading community architecture party identifier for the person evaluating the admissions application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicGroupItemId":{
            "title":"Academic Group ID",
            "type":"integer",
            "description":"Curriculum item identifier for the program's academic group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplicationDate":{
            "title":"Date of Application",
            "type":"string",
            "description":"Date when the admissions application was submitted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdmitStartTypeCode":{
            "title":"Admit Start Type",
            "maxLength":"30",
            "type":"string",
            "description":"The admit start type, for example, period or date range.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdmitStartDate":{
            "title":"Admit Start Date",
            "type":"string",
            "description":"The start date of the date range to which the applicant is applying.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "emails":{
            "title":"Emails",
            "type":"array",
            "description":"The emails resource contains information about the various email addresses provided on the application.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-emails-item-response"
            }
        },
        "PaymentStatusMeaning":{
            "title":"Payment Status Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the payment status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RowTypeMeaning":{
            "title":"Row Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the row type code. A list of accepted values is defined in the lookup type ORA_HEQ_APPLICATION_REC_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level",
            "maxLength":"100",
            "type":"string",
            "description":"Name of academic level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdmitStartTypeMeaning":{
            "title":"Admit Start Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of admit start type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredName":{
            "title":"Name",
            "type":"string",
            "description":"The preferred name of the applicant. If the preferred name isn't found, then the party name will be used.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicProgramItemId":{
            "title":"Academic Program ID",
            "type":"integer",
            "description":"Curriculum item identifier for the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicGroupStatusDate":{
            "title":"Academic Group Status Date",
            "type":"string",
            "description":"Date when the program group item status was applied.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AcademicProgramItemName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"Curriculum item name of the program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BaseApplicationId":{
            "title":"Base Application ID",
            "type":"integer",
            "description":"Identifier for the admissions application this row belongs to.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupportedPrivileges":{
            "title":"Supported Privileges",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates the supported privileges for this application row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":"50",
            "type":"string",
            "description":"Name of institution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EvaluatorComment":{
            "title":"Evaluator Comment",
            "maxLength":"1000",
            "type":"string",
            "description":"User entered comment for this evaluation.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryEmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The primary email address of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ProgramSequence":{
            "title":"Program Sequence",
            "type":"integer",
            "description":"Admissions application program sequence, for example application submission order.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "names":{
            "title":"Names",
            "type":"array",
            "description":"The names resource contains information about the various names provided on the application.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-names-item-response"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Person trading community architecture party identifier associated with the admissions application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicGroupStatusCodeMeaning":{
            "title":"Academic Group Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning for item status code associated with the program group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"Unique identifier for the campus the student is attending.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "PercentComplete":{
            "title":"Percent Complete",
            "type":"number",
            "description":"Percent complete for the application form.",
            "nullable":true,
            "x-hints":{
                "precision":"5",
                "scale":"2"
            },
            "x-queryable":true
        },
        "AdmitTypeMeaning":{
            "title":"Admit Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of admit type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdmitAcademicPeriodName":{
            "title":"Admit Academic Period",
            "maxLength":"50",
            "type":"string",
            "description":"Name of admit academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EvaluationStatusCode":{
            "title":"Evaluation Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status code associated with the application evaluation process. It indicates the various stages of evaluation such as in process, assigned, and in review.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ApplicationSourceCode":{
            "title":"Application Source",
            "maxLength":"30",
            "type":"string",
            "description":"Source of the admissions application, for example the Common Application or a paper application.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdmitAcademicPeriodId":{
            "title":"Admit Academic Period ID",
            "type":"integer",
            "description":"Admit academic period identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object admissionApplications-academicHistories-item-response

{
    "title":"Academic Histories",
    "type":"array",
    "description":"The academic history section is a child resource of an admissions application and provides information about an applicant's academic history.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-academicHistories-item-response"
    }
}

Nested Schema : Addresses

Type: array

Title: Addresses

The addresses resource contains information about the various addresses provided on the application.

Show Source

• Array of: object admissionApplications-addresses-item-response

{
    "title":"Addresses",
    "type":"array",
    "description":"The addresses resource contains information about the various addresses provided on the application.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-addresses-item-response"
    }
}

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

• Array of: object admissionApplications-applicationAttachments-item-response

{
    "title":"Application Attachments",
    "type":"array",
    "description":"The application attachments are a child resource of an admissions application and provide information about the documents attached to an application.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-applicationAttachments-item-response"
    }
}

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

• Array of: object admissionApplications-applicationLongTextItems-item-response

{
    "title":"Application Long Text Items",
    "type":"array",
    "description":"The application long text items resource captures application-specific long text data.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-applicationLongTextItems-item-response"
    }
}

Nested Schema : Application Programs

Type: array

Title: Application Programs

The application programs resource captures the programs for an application.

Show Source

• Array of: object admissionApplications-applicationPrograms-item-response

{
    "title":"Application Programs",
    "type":"array",
    "description":"The application programs resource captures the programs for an application.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-applicationPrograms-item-response"
    }
}

Nested Schema : Course Selections

Type: array

Title: Course Selections

The course selections resource captures course preference selections for an admissions application.

Show Source

• Array of: object admissionApplications-courseSelections-item-response

{
    "title":"Course Selections",
    "type":"array",
    "description":"The course selections resource captures course preference selections for an admissions application.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-courseSelections-item-response"
    }
}

Nested Schema : Emails

Type: array

Title: Emails

The emails resource contains information about the various email addresses provided on the application.

Show Source

• Array of: object admissionApplications-emails-item-response

{
    "title":"Emails",
    "type":"array",
    "description":"The emails resource contains information about the various email addresses provided on the application.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-emails-item-response"
    }
}

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

• Array of: object admissionApplications-emergencyContacts-item-response

{
    "title":"Emergency Contacts",
    "type":"array",
    "description":"The emergency contacts resource contains information about the various emergency contacts provided on the application.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-emergencyContacts-item-response"
    }
}

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

• Array of: object admissionApplications-extracurricularActivities-item-response

{
    "title":"Extracurricular Activities",
    "type":"array",
    "description":"The extracurricular activities section is a child resource of an admissions application and provides information about an applicant's extracurricular activities.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-extracurricularActivities-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Names

Type: array

Title: Names

The names resource contains information about the various names provided on the application.

Show Source

• Array of: object admissionApplications-names-item-response

{
    "title":"Names",
    "type":"array",
    "description":"The names resource contains information about the various names provided on the application.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-names-item-response"
    }
}

Nested Schema : Person Details

Type: array

Title: Person Details

The person details resource provides information about the applicant's person profile.

Show Source

• Array of: object admissionApplications-personDetails-item-response

{
    "title":"Person Details",
    "type":"array",
    "description":"The person details resource provides information about the applicant's person profile.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-personDetails-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Phones

Type: array

Title: Phones

The phones resource contains information about the various phone numbers provided on the application.

Show Source

• Array of: object admissionApplications-phones-item-response

{
    "title":"Phones",
    "type":"array",
    "description":"The phones resource contains information about the various phone numbers provided on the application.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-phones-item-response"
    }
}

Nested Schema : Races

Type: array

Title: Races

The races resource contains information about the various races provided on the application.

Show Source

• Array of: object admissionApplications-races-item-response

{
    "title":"Races",
    "type":"array",
    "description":"The races resource contains information about the various races provided on the application.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-races-item-response"
    }
}

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

• Array of: object admissionApplications-recommendations-item-response

{
    "title":"Recommendations",
    "type":"array",
    "description":"The recommendation section is a child resource of an admissions application and provides information about an applicant's recommenders.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-recommendations-item-response"
    }
}

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

• Array of: object admissionApplications-relationships-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships section is a child resource of an admissions application and provides information about an applicant's relationships.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-relationships-item-response"
    }
}

Nested Schema : admissionApplications-academicHistories-item-response

Type: object

Show Source

• 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.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• StudentIdentifier: string
  Title: Student ID

  Maximum Length: 50

  Identifier assigned to the student by the organization.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the external organization associated with the academic history.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationOtherName":{
            "title":"Other External Organization Name",
            "maxLength":"200",
            "type":"string",
            "description":"Trading community party name of the external organization name entered by the student.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationPartyId":{
            "title":"External Organization Party ID",
            "type":"integer",
            "description":"Trading community party identifier for the external organization associated with an academic history.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationTypeCode":{
            "title":"External Organization Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"External organization type, for example secondary school.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicHistoryTransactionId":{
            "title":"Academic History Transaction ID",
            "type":"integer",
            "description":"Academic history transaction unique identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MajorProgramCodeMeaning":{
            "title":"Major Program",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the major program code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GraduationFlag":{
            "title":"Graduation Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the student graduated from the external organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNameTitle":{
            "title":"Contact Title",
            "maxLength":"100",
            "type":"string",
            "description":"Title of external contact, such as counselor.",
            "nullable":true,
            "x-queryable":true
        },
        "GPAWeightingCode":{
            "title":"GPA Weighting",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the weighting used to calculate the school grade point average of the student.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReducedPriceMealFlag":{
            "title":"Free or Reduced Price Meal Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the student qualified for free or reduced price meals at school.",
            "nullable":true,
            "x-queryable":true
        },
        "GPAWeightingMeaning":{
            "title":"GPA Weighting",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the GPA weighting code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Contact Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"Phone country code of the external contact associated with an academic history.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Contact Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"Phone area code of the external contact associated with an academic history.",
            "nullable":true,
            "x-queryable":true
        },
        "GraduationDate":{
            "title":"Graduation Date",
            "type":"string",
            "description":"The date the student graduated from the external organization.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DegreeCode":{
            "title":"Degree Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the degree or qualification which the student earned.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationTypeCodeMeaning":{
            "title":"External Organization Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of organization type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MajorProgramCode":{
            "title":"Major Program Code",
            "maxLength":"30",
            "type":"string",
            "description":"Major or program which the student earned a degree from.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactPartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"Trading community party identifier for the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactFirstName":{
            "title":"Contact First Name",
            "maxLength":"150",
            "type":"string",
            "description":"First name of the external contact associated with an academic history.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactAddress":{
            "title":"Contact Address",
            "maxLength":"1000",
            "type":"string",
            "description":"Location address of the external contact associated with an academic history.",
            "nullable":true,
            "x-queryable":true
        },
        "AcademicLevelCode":{
            "title":"Academic Level Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the academic level in which student studied, such as a code for grade 9 level or grade 10 level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DegreeCodeMeaning":{
            "title":"Degree",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of degree code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelCodeMeaning":{
            "title":"Academic Level",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of academic level code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DegreeEarned":{
            "title":"Degree Earned",
            "maxLength":"200",
            "type":"string",
            "description":"Degree or qualification which the student earned.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":"80",
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationOtherNameFlag":{
            "title":"Other External Organization Name Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassRankPosition":{
            "title":"Class Rank Position",
            "type":"integer",
            "description":"Rank position of the student in the class.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"6"
            },
            "x-queryable":true
        },
        "ContactLastName":{
            "title":"Contact Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Last name of the external contact associated with an academic history.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "title":"Contact Email Address",
            "maxLength":"1000",
            "type":"string",
            "description":"Email address of the external contact associated with an academic history.",
            "nullable":true,
            "x-queryable":true
        },
        "StudentIdentifier":{
            "title":"Student ID",
            "maxLength":"50",
            "type":"string",
            "description":"Identifier assigned to the student by the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "EntryDate":{
            "title":"Entry Date",
            "type":"string",
            "description":"Date the student was admitted to the external organization.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClassRankSize":{
            "title":"Class Rank Size",
            "type":"integer",
            "description":"Size of the class in which the student had a rank.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"6"
            },
            "x-queryable":true
        },
        "GPA":{
            "title":"GPA",
            "type":"number",
            "description":"School grade point average of the student.",
            "nullable":true,
            "x-hints":{
                "precision":"3",
                "scale":"2"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Contact Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"Phone contact number of the external contact associated with an academic history.",
            "nullable":true,
            "x-queryable":true
        },
        "HomeSchoolFlag":{
            "title":"Home School Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the student has been home schooled.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : admissionApplications-addresses-item-response

Type: object

Show Source

• 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 PARTY_SITE_USE_CODE.
• 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 PARTY_SITE_USE_CODE.
• 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.

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":"240",
            "type":"string",
            "description":"The building name or number at a given address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressThree":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line for address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor Number",
            "maxLength":"40",
            "type":"string",
            "description":"The floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code for the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddrElementAttributeFive":{
            "title":"Additional Address Element 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county for the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date for the address row.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressFour":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line for address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddrElementAttributeThree":{
            "title":"Additional Address Element 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressUseTypeCode":{
            "title":"Address Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of address usage, such as home or legal. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of building. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressTwo":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line for address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":"560",
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address line. Used in Japan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddrElementAttributeOne":{
            "title":"Additional Address Element 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":"2",
            "type":"string",
            "description":"The 2-letter country code. For example, FR for France.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressId":{
            "title":"Address ID",
            "type":"integer",
            "description":"Unique identifier for an address associated with an application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AddressUseTypeMeaning":{
            "title":"Address Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the site use type code. A list of accepted values is defined in the lookup type PARTY_SITE_USE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Position":{
            "title":"Position",
            "maxLength":"50",
            "type":"string",
            "description":"The primary direction such as North or East that's used to access the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HouseTypeMeaning":{
            "title":"House Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the house type code. A list of accepted values is defined in the lookup type HZ_HOUSE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StateCode":{
            "title":"State Code",
            "maxLength":"60",
            "type":"string",
            "description":"The state for the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city for the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date for the address row.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province Code",
            "maxLength":"60",
            "type":"string",
            "description":"The province for the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressOne":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line for address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":"640",
            "type":"string",
            "description":"The directions to the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddrElementAttributeTwo":{
            "title":"Additional Address Element 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddrElementAttributeFour":{
            "title":"Additional Address Element 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlusFourCode":{
            "title":"Postal Code Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The four digit extension to the United States postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FutureAddressFlag":{
            "title":"Future Address Indicator",
            "type":"boolean",
            "description":"Indicates that the address is future dated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred address. The default value is: false.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-applicationAttachments-item-response

Type: object

Show Source

• 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.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• 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.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the attached file.",
            "nullable":true,
            "x-queryable":false
        },
        "DatatypeCode":{
            "title":"Data Type Code",
            "type":"string",
            "description":"Unique identifier for the data type code for an attachment.",
            "nullable":false,
            "x-queryable":false
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":"80",
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentMetadata":{
            "title":"Attachment Metadata",
            "maxLength":"4000",
            "type":"string",
            "description":"Additional information about the attachment stored and utilized by the owning functional area.",
            "nullable":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":false,
            "x-queryable":false
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attached file.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceObjectMeaning":{
            "title":"Source Object Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of source object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HeyAttachmentId":{
            "title":"HEY Attachment ID",
            "type":"integer",
            "description":"Unique identifier for higher education attachment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FileURL":{
            "title":"File URL",
            "type":"string",
            "description":"The URL for the attached file.",
            "nullable":true,
            "x-queryable":false
        },
        "LockedFlag":{
            "title":"Locked Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the attachment can't be modified or deleted.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "HeyCategoryMeaning":{
            "title":"HEY Category",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of category code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attached file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Person trading community architecture party identifier associated with the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Type of content for the attached file, for example text or plain.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the business object the attachment is associated with.",
            "nullable":false,
            "x-hints":{
                "LabelFromField":"SourceObjectMeaning"
            },
            "x-queryable":true
        },
        "HeyCategoryCode":{
            "title":"HEY Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"User-defined code that indicates the higher education attachment type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"HeyCategoryMeaning"
            },
            "x-queryable":true
        },
        "ActivatedFlag":{
            "title":"Activated Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the attachment is activated or pending activation.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PkOneValue":{
            "title":"Primary Key Value 1",
            "maxLength":"150",
            "type":"string",
            "description":"First primary key of the business object the attachment is associated with.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-applicationLongTextItems-item-response

Type: object

Show Source

• 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.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the category of the long text data.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":"80",
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "ClobMetadata":{
            "title":"Long Text Metadata",
            "type":"string",
            "description":"Additional information about the long text data stored and utilized by the owning functional area.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "ClobData":{
            "title":"Long Text",
            "type":"string",
            "description":"The long text data associated with the application.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategoryCodeMeaning":{
            "title":"Category",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the long text category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationClobDataId":{
            "title":"Long Text Item ID",
            "type":"integer",
            "description":"Unique identifier for a long text data item associated with an application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-applicationPrograms-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AcademicProgramItemName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"Curriculum item name of the program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicGroupActionMeaning":{
            "title":"Academic Group Action",
            "maxLength":"80",
            "type":"string",
            "description":"Item action meaning associated with the program group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicGroupActionDate":{
            "title":"Academic Group Action Date",
            "type":"string",
            "description":"Date when the program group item action was applied.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":"50",
            "type":"string",
            "description":"Admissions application institution name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"Admissions application institution identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicGroupActionCode":{
            "title":"Academic Group Action Code",
            "maxLength":"30",
            "type":"string",
            "description":"Item action code associated with the program group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicGroupItemName":{
            "title":"Academic Group",
            "maxLength":"150",
            "type":"string",
            "description":"Curriculum item name of the program's academic group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "applicationProgramItemStatuses":{
            "title":"Application Program Item Statuses",
            "type":"array",
            "description":"The application program item statuses resource captures the status history of an application program.",
            "items":{
                "$ref":"#/components/schemas/admissionApplications-applicationPrograms-applicationProgramItemStatuses-item-response"
            }
        },
        "CampusName":{
            "title":"Campus",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the campus of the program to which the applicant is applying.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicGroupItemId":{
            "title":"Academic Group ID",
            "type":"integer",
            "description":"Curriculum item identifier for the program's academic group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplicationProgramId":{
            "title":"Application Program ID",
            "type":"integer",
            "description":"Admissions application program identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramSequence":{
            "title":"Program Sequence",
            "type":"integer",
            "description":"Admissions application program sequence, for example, application submission order.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "AcademicGroupStatusCode":{
            "title":"Academic Group Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Item status code associated with the program group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"Academic level identifier for the program.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicGroupStatusCodeMeaning":{
            "title":"Academic Group Status",
            "maxLength":"80",
            "type":"string",
            "description":"Item status meaning associated with the program group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"Unique identifier for the campus of the program to which the applicant is applying.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "InstitutionId"
                ]
            },
            "x-queryable":true
        },
        "AcademicGroupActionReasonName":{
            "title":"Academic Group Action Reason",
            "maxLength":"50",
            "type":"string",
            "description":"Action reason name associated with the program group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level",
            "maxLength":"100",
            "type":"string",
            "description":"Academic level name of the program.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicGroupActionReasonCode":{
            "title":"Academic Group Action Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"Action reason code associated with the program group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AcademicProgramItemId":{
            "title":"Academic Program ID",
            "type":"integer",
            "description":"Curriculum item identifier for the program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AcademicGroupStatusDate":{
            "title":"Academic Group Status Date",
            "type":"string",
            "description":"Date when the program group item status was applied.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicGroupActionReasonId":{
            "title":"Academic Group Action Reason ID",
            "type":"integer",
            "description":"Action reason identifier associated with the program group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "AcadGroupActionReasonId"
                ]
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object admissionApplications-applicationPrograms-applicationProgramItemStatuses-item-response

{
    "title":"Application Program Item Statuses",
    "type":"array",
    "description":"The application program item statuses resource captures the status history of an application program.",
    "items":{
        "$ref":"#/components/schemas/admissionApplications-applicationPrograms-applicationProgramItemStatuses-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-applicationPrograms-applicationProgramItemStatuses-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "StatusMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status code meaning associated with the program item or admissions application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusDate":{
            "title":"Status Date",
            "type":"string",
            "description":"Date when the admissions application or program item status was applied.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionCode":{
            "title":"Action Code",
            "maxLength":"30",
            "type":"string",
            "description":"Action code associated with the admissions application or program item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionReasonName":{
            "title":"Action Reason",
            "maxLength":"50",
            "type":"string",
            "description":"Action reason name associated with the admissions application or program action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionReasonId":{
            "title":"Action Reason ID",
            "type":"integer",
            "description":"Action reason identifier associated with the admissions application or program action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ApplicationProgramItemStatusId":{
            "title":"Application Program Item Status ID",
            "type":"integer",
            "description":"Admissions application program item status identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status code associated with the program item or admissions application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionMeaning":{
            "title":"Action",
            "maxLength":"80",
            "type":"string",
            "description":"Action meaning associated with the admissions application or program item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionDate":{
            "title":"Action Date",
            "type":"string",
            "description":"Date when the admissions application or program item action was applied.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionReasonCode":{
            "title":"Action Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"Action reason code associated with the admissions application or program action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-courseSelections-item-response

Type: object

Show Source

• 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.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• 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.

{
    "type":"object",
    "properties":{
        "CourseName":{
            "title":"Course Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the selected course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramCurriculumId":{
            "title":"Program Curriculum ID",
            "type":"integer",
            "description":"The curriculum identifier for the program of the selected course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":"80",
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "CourseListSequence":{
            "title":"Course List Sequence",
            "type":"integer",
            "description":"The sequence of the course list for the associated course selection.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CourseListCurriculumId":{
            "title":"Course List Curriculum ID",
            "type":"integer",
            "description":"The curriculum identifier for the course list of the selected course.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CourseListName":{
            "title":"Course List Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name for the course list of the selected course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoursePreference":{
            "title":"Course Preference",
            "type":"integer",
            "description":"Course selection preference sequence number.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CourseTitle":{
            "title":"Course Title",
            "maxLength":"100",
            "type":"string",
            "description":"The title of the selected course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name for the academic program of the selected course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Subject":{
            "title":"Subject",
            "maxLength":"50",
            "type":"string",
            "description":"The subject of the course selection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseSelectionId":{
            "title":"Course Selection ID",
            "type":"integer",
            "description":"Unique identifier for the course selection.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CourseDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the selected course.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CatalogNumber":{
            "title":"Catalog Number",
            "maxLength":"10",
            "type":"string",
            "description":"The catalog number of the course selection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectCode":{
            "title":"Subject Code",
            "maxLength":"30",
            "type":"string",
            "description":"The subject code of the course selection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseListTitle":{
            "title":"Course List Title",
            "maxLength":"100",
            "type":"string",
            "description":"The title for the course list of the selected course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SelectionDateTime":{
            "title":"Selection Date",
            "type":"string",
            "description":"The date of the course selection.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramTitle":{
            "title":"Program Title",
            "maxLength":"100",
            "type":"string",
            "description":"The title for the academic program of the selected course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CourseCurriculumId":{
            "title":"Course Curriculum ID",
            "type":"integer",
            "description":"The curriculum identifier for the selected course.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-emails-item-response

Type: object

Show Source

• 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 CONTACT_POINT_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.

{
    "type":"object",
    "properties":{
        "EmailId":{
            "title":"Email ID",
            "type":"integer",
            "description":"The unique identifier for an email address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PurposeMeaning":{
            "title":"Purpose",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the purpose code. A list of accepted values is defined in the lookup type ORA_HEY_EMAIL_CONTACT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PurposeCode":{
            "title":"Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The type of purpose for email contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-emergencyContacts-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Email":{
            "title":"Email",
            "maxLength":"1000",
            "type":"string",
            "description":"The email address of the emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name by which emergency contact is known.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmergencyContactId":{
            "title":"Emergency Contact ID",
            "type":"integer",
            "description":"The unique identifier for emergency contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ContactTypeMeaning":{
            "title":"Relationship Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of emergency contact type. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Extension",
            "maxLength":"10",
            "type":"string",
            "description":"The extension number for the emergency contact phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Select Country",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for the emergency contact phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country area code for the emergency contact phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactTypeCode":{
            "title":"Contact Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The emergency contact type of the person. A list of accepted values is defined in the lookup type ORA_HEY_EMERGENCY_CONTACT_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The emergency contact phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name by which emergency contact is known.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SingleNameFlag":{
            "title":"Only One Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the person has single name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred emergency contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-extracurricularActivities-item-response

Type: object

Show Source

• 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.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• 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.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"100",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationOtherName":{
            "title":"Other External Organization Name",
            "maxLength":"200",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityDescription":{
            "title":"Activity Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the extracurricular activity.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationPartyId":{
            "title":"External Organization Party ID",
            "type":"integer",
            "description":"Trading community party identifier for the external organization where the activity occurred.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactNameTitle":{
            "title":"Contact Title",
            "maxLength":"100",
            "type":"string",
            "description":"Title of external contact, such as counselor.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the extracurricular activity started.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Contact Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"Phone country code of the external contact associated with an extracurricular activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Contact Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"Phone area code of the external contact associated with an extracurricular activity.",
            "nullable":true,
            "x-queryable":true
        },
        "PositionHeld":{
            "title":"Position Held",
            "maxLength":"100",
            "type":"string",
            "description":"Position held for the extracurricular activity, such as captain or treasurer.",
            "nullable":true,
            "x-queryable":true
        },
        "InterestedInPursuingCodeMeaning":{
            "title":"Interested in Pursuing",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of pursuing code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactFirstName":{
            "title":"Contact First Name",
            "maxLength":"150",
            "type":"string",
            "description":"First name of the external contact associated with an extracurricular activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactAddress":{
            "title":"Contact Address",
            "maxLength":"1000",
            "type":"string",
            "description":"Location address of the external contact associated with an extracurricular activity.",
            "nullable":true,
            "x-queryable":true
        },
        "AcademicLevelCode":{
            "title":"Academic Level Code",
            "maxLength":"30",
            "type":"string",
            "description":"Academic level code when the activity occurred.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicLevelCodeMeaning":{
            "title":"Academic Level",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of academic level code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityTypeCode":{
            "title":"Activity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Activity type code of the extracurricular activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":"80",
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationOtherNameFlag":{
            "title":"Other External Organization Name Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an external organization name has been entered by the student.",
            "nullable":true,
            "x-queryable":true
        },
        "WeeksPERYear":{
            "title":"Weeks per Year",
            "type":"integer",
            "description":"Number of weeks per year that student participates in the activity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "ActivityTypeCodeMeaning":{
            "title":"Activity Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of activity type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoursPERWeek":{
            "title":"Hours per Week",
            "type":"integer",
            "description":"Number of hours per week that student participates in the activity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the extracurricular activity ended.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExtracurricularTransactionId":{
            "title":"Extracurricular Transaction ID",
            "type":"integer",
            "description":"Extracurricular activity transaction unique identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactLastName":{
            "title":"Contact Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Last name of the external contact associated with an extracurricular activity.",
            "nullable":true,
            "x-queryable":true
        },
        "InterestedInPursuingCode":{
            "title":"Interested in Pursuing Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if student is interested in pursuing the activity at the institution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "title":"Contact Email Address",
            "maxLength":"1000",
            "type":"string",
            "description":"Email address of the external contact associated with an extracurricular activity.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Contact Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"Phone contact number of the external contact associated with an extracurricular activity.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-names-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "NameId":{
            "title":"Name ID",
            "type":"integer",
            "description":"The unique identifier for a name.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NameTypeMeaning":{
            "title":"Name Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the name type code. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FullName":{
            "title":"Full Name",
            "maxLength":"360",
            "type":"string",
            "description":"The full name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the person, such as Mr or Mrs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "title":"Name Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The suffix can be junior or senior.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SingleNameFlag":{
            "title":"Only One Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the person has single name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NameTypeCode":{
            "title":"Name Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the name as preferred name for this party within this name type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-personDetails-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "PrimaryLanguageCode":{
            "title":"Primary Language",
            "maxLength":"30",
            "type":"string",
            "description":"The primary language of the person. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLanguageMeaning":{
            "title":"Primary Language",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of primary language. A list of accepted values is defined in the lookup type ORA_HEY_PRIMARY_LANGUAGE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BirthCountryCode":{
            "title":"Country of Birth",
            "maxLength":"30",
            "type":"string",
            "description":"The country where this person was born.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaritalStatusEffectiveDate":{
            "title":"Marital Status as Of",
            "type":"string",
            "description":"The date when the person's marital status changed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VisaTypeMeaning":{
            "title":"Visa Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of visa type. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderIdentityValue":{
            "title":"Gender Identity Value",
            "maxLength":"100",
            "type":"string",
            "description":"The gender identity value of the person, to capture the free text value when the GENDER_IDENTITY_CODE is Not Listed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderIdentityCode":{
            "title":"Gender Identity",
            "maxLength":"30",
            "type":"string",
            "description":"The gender identity of the person. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredPronounsValue":{
            "title":"Preferred Pronouns Value",
            "maxLength":"100",
            "type":"string",
            "description":"The preferred pronouns value of the person, to capture the free text value when the PREFERRED_PRONOUNS_CODE is Not Listed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlaceOfBirth":{
            "title":"Place of Birth",
            "maxLength":"60",
            "type":"string",
            "description":"The place of birth of the student.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaritalStatusMeaning":{
            "title":"Marital Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the marital status code. A list of accepted values is defined in the lookup type MARITAL_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenshipCountryCode":{
            "title":"Country of Citizenship",
            "maxLength":"2",
            "type":"string",
            "description":"The code for the country from which a person claims citizenship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderMeaning":{
            "title":"Gender",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the gender code. A list of accepted values is defined in the lookup type HZ_GENDER.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLanguageValue":{
            "title":"Primary Language Value",
            "maxLength":"100",
            "type":"string",
            "description":"The primary language value of the person, to capture the free text value when the PRIMARY_LANGUAGE_CODE is Not Listed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HispanicOrLatinoCode":{
            "title":"Hispanic or Latino",
            "maxLength":"60",
            "type":"string",
            "description":"The hispanic or latino code of the student, if any. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"The date when the person was born.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResidenceCountryCode":{
            "title":"Country of Residence",
            "maxLength":"30",
            "type":"string",
            "description":"The country this person normally resides in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderCode":{
            "title":"Gender",
            "maxLength":"30",
            "type":"string",
            "description":"The gender of the person, such as male, female, or unknown. A list of accepted values is defined in the lookup type HZ_GENDER.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VisaTypeCode":{
            "title":"Visa Type",
            "maxLength":"30",
            "type":"string",
            "description":"The visa type of the person. A list of accepted values is defined in the lookup type ORA_HEY_VISA_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenshipStatusMeaning":{
            "title":"Citizenship Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the citizenship status. A list of accepted values is defined in the lookup type ORA_HEY_CITIZENSHIP_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BirthCountryName":{
            "title":"Country of Birth",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the birth country code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HispanicOrLatinoMeaning":{
            "title":"Hispanic or Latino",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the hispanic or latino code. A list of accepted values is defined in the lookup type ORA_HEY_ETHNICITY.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenshipCountryName":{
            "title":"Country of Citizenship",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the citizenship country code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredPronounsMeaning":{
            "title":"Preferred Pronouns",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of preferred pronouns. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredPronounsCode":{
            "title":"Preferred Pronouns",
            "maxLength":"30",
            "type":"string",
            "description":"The preferred pronouns of the person. A list of accepted values is defined in the lookup type ORA_HEY_PREFERRED_PRONOUN.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonalDetailId":{
            "title":"Personal Detail ID",
            "type":"integer",
            "description":"Unique identifier for personal data information associated with an application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MaritalStatusCode":{
            "title":"Marital Status",
            "maxLength":"30",
            "type":"string",
            "description":"The marital status of the person. A list of accepted values is defined in the lookup type MARITAL_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenshipStatusCode":{
            "title":"Citizenship Status",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResidenceCountryName":{
            "title":"Country of Residence",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the residency country code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GenderIdentityMeaning":{
            "title":"Gender Identity",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of gender identity. A list of accepted values is defined in the lookup type ORA_HEY_GENDER_IDENTITY.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-phones-item-response

Type: object

Show Source

• 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 CONTACT_POINT_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 CONTACT_POINT_PURPOSE.

{
    "type":"object",
    "properties":{
        "PhoneCountryCode":{
            "title":"Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The international country code for a phone number. For example, 33 for France.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"20",
            "type":"string",
            "description":"The area code within a country code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneId":{
            "title":"Phone ID",
            "type":"integer",
            "description":"The unique identifier for the phone number.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PurposeMeaning":{
            "title":"Purpose",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the purpose code. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number formatted in the local format. The number should not include area code, country code, or extension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PurposeCode":{
            "title":"Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The type of purpose for phone contact, such as work, emergency, and home. A list of accepted values is defined in the lookup type CONTACT_POINT_PURPOSE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The extension number for a phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-races-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RaceCode":{
            "title":"Race",
            "maxLength":"30",
            "type":"string",
            "description":"The race of the person. A list of accepted values is defined in the lookup type ORA_HEY_RACE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RaceCodeMeaning":{
            "title":"Race",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of race. A list of accepted values is defined in the lookup type ORA_HEY_RACE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RaceId":{
            "title":"Race ID",
            "type":"integer",
            "description":"The unique identifier of person's race.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-recommendations-item-response

Type: object

Show Source

• 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.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• SendInviteFlag: boolean
  Title: Send Invite Indicator

  Indicates if invite has been sent.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"100",
            "type":"string",
            "description":"Indicates whether an external organization name has been entered by the student.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecommendationTypeCode":{
            "title":"Recommendation Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Type code for the individual, group, or organization offering the recommendation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecommenderNameTitle":{
            "title":"Recommender Title",
            "maxLength":"100",
            "type":"string",
            "description":"Title of the recommender, such as counselor.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationOtherName":{
            "title":"Other External Organization Name",
            "maxLength":"200",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SendInviteFlag":{
            "title":"Send Invite Indicator",
            "type":"boolean",
            "description":"Indicates if invite has been sent.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationPartyId":{
            "title":"External Organization Party ID",
            "type":"integer",
            "description":"Trading community party identifier for the external organization associated with the recommender.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":"80",
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "RecommendationTypeCodeMeaning":{
            "title":"Recommendation Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of recommendation type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationAddress":{
            "title":"External Organization Address",
            "maxLength":"500",
            "type":"string",
            "description":"Location address of the external organization associated with the recommender.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationOtherNameFlag":{
            "title":"Other External Organization Name Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an external organization name has been entered by the student.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipToStudent":{
            "title":"Relationship to Student",
            "maxLength":"200",
            "type":"string",
            "description":"Indicates how the student knows the recommender.",
            "nullable":true,
            "x-queryable":true
        },
        "RecommendationTransactionId":{
            "title":"Recommendation Transaction ID",
            "type":"integer",
            "description":"Recommendation transaction unique identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LengthOfRelationship":{
            "title":"Length of Relationship",
            "type":"number",
            "description":"Indicates how long the student has known the recommender, in years.",
            "nullable":true,
            "x-hints":{
                "precision":"3",
                "scale":"1"
            },
            "x-queryable":true
        },
        "LastInviteSentDate":{
            "title":"Last Invite Sent Date",
            "type":"string",
            "description":"The last date and time a recommendation invite was sent for the row.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecommenderDescription":{
            "title":"Recommender Description",
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the recommender.",
            "nullable":true,
            "x-queryable":true
        },
        "RecommenderAddress":{
            "title":"Recommender Address",
            "maxLength":"1000",
            "type":"string",
            "description":"Address of the recommender.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Recommender Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"Phone country code of the recommender.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Recommender Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"Phone area code of the recommender.",
            "nullable":true,
            "x-queryable":true
        },
        "RecommenderFirstName":{
            "title":"Recommender First Name",
            "maxLength":"150",
            "type":"string",
            "description":"First name of the recommender.",
            "nullable":true,
            "x-queryable":true
        },
        "RecommenderEmailAddress":{
            "title":"Recommender Email Address",
            "maxLength":"1000",
            "type":"string",
            "description":"Email address of the recommender.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Recommender Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"Phone Number of the recommender.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecommenderLastName":{
            "title":"Recommender Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Last name of the recommender.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : admissionApplications-relationships-item-response

Type: object

Show Source

• 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.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• 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.

{
    "type":"object",
    "properties":{
        "RelativesBirthCountryCode":{
            "title":"Relationship Birth Country Code",
            "maxLength":"30",
            "type":"string",
            "description":"Country where the relationship specified was born.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipTypeMeaning":{
            "title":"Relationship Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the relationship code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UndergradOrgOtherName":{
            "title":"Other External Organization Name",
            "maxLength":"200",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UndergradDegreeDate":{
            "title":"Undergrad Degree Earned Date",
            "type":"string",
            "description":"Date the undergrad degree was earned for the relationship specified.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttendedInstitutionDate":{
            "title":"Institution Degree Date",
            "type":"string",
            "description":"Date the degree was received at this institution for the relationship specified.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipPrefix":{
            "title":"Relationship Prefix",
            "maxLength":"100",
            "type":"string",
            "description":"Name prefix for the relationship specified.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipEmployedIn":{
            "title":"Relationship Place of Employment",
            "maxLength":"60",
            "type":"string",
            "description":"Place where the relationship specified is employed.",
            "nullable":true,
            "x-queryable":true
        },
        "AttendedInstitutionFlag":{
            "title":"Attended Institution",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the relationship specified has attended this institution.",
            "nullable":true,
            "x-queryable":true
        },
        "UndergradOrgPartyId":{
            "title":"Undergrad Institution ID",
            "type":"integer",
            "description":"Trading community party identifier for the external organization associated with the relationship specified.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "HighestOrgOtherName":{
            "title":"Other External Organization Name",
            "maxLength":"200",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UndergradOrgPartyName":{
            "title":"Undergrad Institution",
            "maxLength":"100",
            "type":"string",
            "description":"Trading community party name of the external organization associated with the relationship specified.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"Phone country code of the relationship specified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "title":"Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"Phone area code of the relationship specified.",
            "nullable":true,
            "x-queryable":true
        },
        "HighestDegreeOrgPartyName":{
            "title":"Highest Degree Institution",
            "maxLength":"100",
            "type":"string",
            "description":"Trading community party name of the external organization where the relative has earned the highest degree.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttendedInstDegreeRecCode":{
            "title":"Institution Degree Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the highest degree earned by the relationship specified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipGenderMeaning":{
            "title":"Relationship Gender",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of relationship specified gender.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HighestDegreeOrgPartyId":{
            "title":"Highest Degree Institution ID",
            "type":"integer",
            "description":"Trading community party identifier for the external organization where the relative has earned the highest degree.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RelationshipPersonalEmail":{
            "title":"Relationship Personal Email",
            "maxLength":"1000",
            "type":"string",
            "description":"Email of the relationship specified.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipMiddleName":{
            "title":"Relationship Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"Middle name of the relationship specified.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipSuffix":{
            "title":"Relationship Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"Name suffix for the relationship specified.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipLastName":{
            "title":"Relationship Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Last name of the relationship specified.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipLivingFlag":{
            "title":"Relationship Living",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the relationship specified is alive or deceased.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipGenderCode":{
            "title":"Relationship Gender Code",
            "maxLength":"30",
            "type":"string",
            "description":"Gender of the relationship specified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HighestDegreeEarnedMeaning":{
            "title":"Highest Degree Earned",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the degree earned for the relationship specified.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":"80",
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "RelationshipFirstName":{
            "title":"Relationship First Name",
            "maxLength":"150",
            "type":"string",
            "description":"First name of the relationship specified.",
            "nullable":true,
            "x-queryable":true
        },
        "AttendedInstDegreeRecMeaning":{
            "title":"Institution Degree",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the highest degree earned by the relationship specified.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipOccupation":{
            "title":"Relationship Occupation",
            "maxLength":"60",
            "type":"string",
            "description":"Occupation or professional title of the relationship specified.",
            "nullable":true,
            "x-queryable":true
        },
        "HighestOrgOtherNameFlag":{
            "title":"Other External Organization Name Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an external organization name has been entered by the student.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "title":"Relationship Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Type code of the relationship.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UndergradOrgOtherNameFlag":{
            "title":"Other External Organization Name Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an external organization name has been entered by the student.",
            "nullable":true,
            "x-queryable":true
        },
        "UndergradDegreeEarnFlag":{
            "title":"Undergrad Degree Earned",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the relationship specified holds an undergrad degree.",
            "nullable":true,
            "x-queryable":true
        },
        "HighestDegreeEarnedDate":{
            "title":"Highest Degree Earned Date",
            "type":"string",
            "description":"Date on which the highest degree was earned for the relationship specified.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RelativesBirthCountryName":{
            "title":"Relationship Country of Birth",
            "maxLength":"80",
            "type":"string",
            "description":"Name of country where the relationship specified was born.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"Phone contact number of the relationship specified.",
            "nullable":true,
            "x-queryable":true
        },
        "HighestDegreeEarnedCode":{
            "title":"Highest Degree Earned Code",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the degree earned at this institution for the relationship specified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelationshipTransactionId":{
            "title":"Relationship Transaction ID",
            "type":"integer",
            "description":"Relationship transaction unique identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RelationshipMailingAddr":{
            "title":"Relationship Mailing Address",
            "maxLength":"1000",
            "type":"string",
            "description":"Mailing address of the relationship specified.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

AcademicGroupLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicGroupsLOV

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

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions

The following properties are defined on the LOV link relation:

• Source Attribute: InstitutionId; Target Attribute: InstitutionId
• Display Attribute: InstitutionName

AcademicLevelLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicLevels

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicLevelId; Target Attribute: AcademicLevelId
• Display Attribute: LevelName

AdmitStartTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heqLookups

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

Operation: /fscmRestApi/resources/11.13.18.05/heqLookups

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

Operation: /fscmRestApi/resources/11.13.18.05/heqLookups

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

Operation: /fscmRestApi/resources/11.13.18.05/campusesLOV

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

Operation: /fscmRestApi/resources/11.13.18.05/heqLookups

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

Operation: /fscmRestApi/resources/11.13.18.05/heqLookups

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

Operation: /fscmRestApi/resources/11.13.18.05/programs

The following properties are defined on the LOV link relation:

• Source Attribute: AcademicProgramItemId; Target Attribute: CurriculumId
• Display Attribute: CurriculumName

StatusCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heqLookups

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

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/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

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/addresses

Parameters:

• ApplicationId: $request.path.ApplicationId

The addresses resource contains information about the various addresses provided on the application.

applicationAttachments

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/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

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems

Parameters:

• ApplicationId: $request.path.ApplicationId

The application long text items resource captures application-specific long text data.

applicationPrograms

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationPrograms

Parameters:

• ApplicationId: $request.path.ApplicationId

The application programs resource captures the programs for an application.

courseSelections

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/courseSelections

Parameters:

• ApplicationId: $request.path.ApplicationId

The course selections resource captures course preference selections for an admissions application.

emails

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/emails

Parameters:

• ApplicationId: $request.path.ApplicationId

The emails resource contains information about the various email addresses provided on the application.

emergencyContacts

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/emergencyContacts

Parameters:

• ApplicationId: $request.path.ApplicationId

The emergency contacts resource contains information about the various emergency contacts provided on the application.

extracurricularActivities

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/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

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/names

Parameters:

• ApplicationId: $request.path.ApplicationId

The names resource contains information about the various names provided on the application.

personDetails

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/personDetails

Parameters:

• ApplicationId: $request.path.ApplicationId

The person details resource provides information about the applicant's person profile.

phones

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/phones

Parameters:

• ApplicationId: $request.path.ApplicationId

The phones resource contains information about the various phone numbers provided on the application.

races

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/races

Parameters:

• ApplicationId: $request.path.ApplicationId

The races resource contains information about the various races provided on the application.

recommendations

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/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

Operation: /fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/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