Create an application form
post
/fscmRestApi/resources/11.13.18.05/applicationFormDefinitions
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AcademicLevelId(required): integer
(int64)
Title:
Academic Level ID
Admissions application academic level identifier. -
AcademicProgramGroupId: integer
(int64)
Title:
Academic Group ID
Academic group identifier for the program. -
AcademicProgramTypeCode(required): string
Title:
Academic Program Type
Maximum Length:30
Type of program, such as a program with specialization. -
AdmitEndDate: string
(date)
Title:
Admit End Date
Admit academic period ending date. -
AdmitStartDate: string
(date)
Title:
Admit Start Date
Admit academic period starting date. -
AdmitStartTypeCode(required): string
Title:
Admit Start Type
Maximum Length:30
Admit start type, for example starting academic period or start date. -
AdmitTypeCode: string
Title:
Admit Type
Maximum Length:30
Type of applicant before entry to the academic institution, for example a transfer applicant. -
applicationAdmitPeriods: array
Application Admit Periods
Title:
Application Admit Periods
The application admit period is child to application form definition and provides information about the admit periods form metadata. -
applicationPrograms: array
Form Fragments
Title:
Form Fragments
The application program is child to application form definition and provides information about various parts of the form. -
CampusId: integer
(int64)
Title:
Campus ID
Unique identifier for the campus associated with the form. -
Description: string
Title:
Description
Maximum Length:240
The description of an application form. -
DisplayName(required): string
Title:
Display Name
Maximum Length:100
Form name that's displayed to the user. -
FormCode(required): string
Title:
Form Code
Maximum Length:50
The unique code of a form. -
formFragments: array
Application Programs
Title:
Application Programs
The application program is child to application form definition and provides information about the programs form metadata. -
FormId: integer
(int64)
Title:
Form ID
The generated unique identifier for form. -
FormTypeCode(required): string
Title:
Form Type
Maximum Length:30
Code for form type, for example admissions application or residency appeal. -
InstitutionId(required): integer
(int64)
Title:
Institution ID
Unique identifier for the institution associated with the form. -
Name(required): string
Title:
Form Name
Maximum Length:100
Form name, such as arts admissions application form. -
StatusCode(required): string
Title:
Status
Maximum Length:30
Form status code, for example unpublished, published, or archived. -
VersionDescription: string
Title:
Version Description
Maximum Length:240
The description of a published, unpublished, or draft form version. -
VersionName(required): string
Title:
Version Name
Maximum Length:50
The name of a published, unpublished, or draft form version.
Nested Schema : Application Admit Periods
Type:
array
Title:
Application Admit Periods
The application admit period is child to application form definition and provides information about the admit periods form metadata.
Show Source
Nested Schema : Form Fragments
Type:
array
Title:
Form Fragments
The application program is child to application form definition and provides information about various parts of the form.
Show Source
Nested Schema : Application Programs
Type:
array
Title:
Application Programs
The application program is child to application form definition and provides information about the programs form metadata.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AdmitAcademicPeriodId: integer
(int64)
Title:
Admit Academic Period ID
Admit academic period identifier. -
FormAdmitPeriodId: integer
(int64)
Title:
Admit Period
Form admit period identifier.
Nested Schema : schema
Type:
Show Source
object
-
CourseSelectorFlag: boolean
Title:
Course Selector
Maximum Length:1
Default Value:false
Indicates if the course selector is used for this program. -
FormApplicationProgId: integer
(int64)
Title:
Form Application Program ID
Form admissions application program identifier. -
ProgramItemCurriculumId: integer
(int64)
Title:
Program Item Curriculum ID
Curriculum item identifier for the program.
Nested Schema : schema
Type:
Show Source
object
-
FormFragmentId: integer
(int64)
Title:
Form Fragment ID
Form builder form fragment identifier. -
FragmentContent: string
(byte)
Title:
Fragment Content
Form fragment content, for example, the XML content of the section. -
FragmentTypeCode: string
Title:
Fragment Type Code
Maximum Length:30
Form fragment type code, for example form and section.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : applicationFormDefinitions-item-response
Type:
Show Source
object
-
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. -
AcademicProgramGroupId: integer
(int64)
Title:
Academic Group ID
Academic group identifier for the program. -
AcademicProgramGroupName: string
Title:
Academic Group
Read Only:true
Maximum Length:50
Name of academic program group. -
AcademicProgramTypeCode: string
Title:
Academic Program Type
Maximum Length:30
Type of program, such as a program with specialization. -
AcademicProgramTypeMeaning: string
Title:
Academic Program Type
Read Only:true
Maximum Length:80
Meaning of type of program. -
AdmitEndDate: string
(date)
Title:
Admit End Date
Admit academic period ending date. -
AdmitStartDate: string
(date)
Title:
Admit Start Date
Admit academic period starting date. -
AdmitStartTypeCode: string
Title:
Admit Start Type
Maximum Length:30
Admit start type, for example starting academic period or start date. -
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. -
applicationAdmitPeriods: array
Application Admit Periods
Title:
Application Admit Periods
The application admit period is child to application form definition and provides information about the admit periods form metadata. -
applicationPrograms: array
Form Fragments
Title:
Form Fragments
The application program is child to application form definition and provides information about various parts of the form. -
CampusId: integer
(int64)
Title:
Campus ID
Unique identifier for the campus associated with the form. -
CampusName: string
Title:
Campus
Read Only:true
Maximum Length:50
Name of the campus. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Indicates who created a record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
Description: string
Title:
Description
Maximum Length:240
The description of an application form. -
DisplayName: string
Title:
Display Name
Maximum Length:100
Form name that's displayed to the user. -
FormCode: string
Title:
Form Code
Maximum Length:50
The unique code of a form. -
formFragments: array
Application Programs
Title:
Application Programs
The application program is child to application form definition and provides information about the programs form metadata. -
FormId: integer
(int64)
Title:
Form ID
The generated unique identifier for form. -
FormTypeCode: string
Title:
Form Type
Maximum Length:30
Code for form type, for example admissions application or residency appeal. -
FormTypeMeaning: string
Title:
Form Type
Read Only:true
Maximum Length:80
Meaning of form type code. -
InstitutionId: integer
(int64)
Title:
Institution ID
Unique identifier for the institution associated with the form. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
Name of the institution. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Indicates who last updated a record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Form Name
Maximum Length:100
Form name, such as arts admissions application form. -
StatusCode: string
Title:
Status
Maximum Length:30
Form status code, for example unpublished, published, or archived. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
Meaning of status code. -
VersionDescription: string
Title:
Version Description
Maximum Length:240
The description of a published, unpublished, or draft form version. -
VersionName: string
Title:
Version Name
Maximum Length:50
The name of a published, unpublished, or draft form version. -
VersionNumber: integer
(int32)
Title:
Version Number
Read Only:true
The version number of a published, unpublished, or draft form version.
Nested Schema : Application Admit Periods
Type:
array
Title:
Application Admit Periods
The application admit period is child to application form definition and provides information about the admit periods form metadata.
Show Source
Nested Schema : Form Fragments
Type:
array
Title:
Form Fragments
The application program is child to application form definition and provides information about various parts of the form.
Show Source
Nested Schema : Application Programs
Type:
array
Title:
Application Programs
The application program is child to application form definition and provides information about the programs form metadata.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : applicationFormDefinitions-applicationAdmitPeriods-item-response
Type:
Show Source
object
-
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 identifier. -
FormAdmitPeriodId: integer
(int64)
Title:
Admit Period
Form admit period identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : applicationFormDefinitions-applicationPrograms-item-response
Type:
Show Source
object
-
CourseSelectorFlag: boolean
Title:
Course Selector
Maximum Length:1
Default Value:false
Indicates if the course selector is used for this program. -
FormApplicationProgId: integer
(int64)
Title:
Form Application Program ID
Form admissions application program identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramItemCurriculumId: integer
(int64)
Title:
Program Item Curriculum ID
Curriculum item identifier for the program. -
ProgramName: string
Title:
Program
Read Only:true
Name of the curriculum program.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : applicationFormDefinitions-formFragments-item-response
Type:
Show Source
object
-
FormFragmentId: integer
(int64)
Title:
Form Fragment ID
Form builder form fragment identifier. -
FragmentContent: string
(byte)
Title:
Fragment Content
Form fragment content, for example, the XML content of the section. -
FragmentTypeCode: string
Title:
Fragment Type Code
Maximum Length:30
Form fragment type code, for example form and section. -
FragmentTypeMeaning: string
Title:
Fragment Type
Read Only:true
Maximum Length:80
Meaning of form type code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AcademicGroupItemLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicProgramGroupId; Target Attribute: AcademicGroupId
- Display Attribute: CurriculumName
- AcademicLevelLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicLevelId; Target Attribute: AcademicLevelId
- Display Attribute: LevelName
- AcademicProgramTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEQ_RELEVANT_PROGRAMS
The following properties are defined on the LOV link relation:- Source Attribute: AcademicProgramTypeCode; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
- AdmitStartTypeCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEQ_ADMIT_START_TYPE%2CLookupCode%3D{AdmitStartTypeCode}
The following properties are defined on the LOV link relation:- Source Attribute: AdmitStartTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AdmitTypeCodeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEQ_ADMIT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: AdmitTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CampusLOV
-
Operation: /fscmRestApi/resources/11.13.18.05/campusesThe following properties are defined on the LOV link relation:
- Source Attribute: CampusId; Target Attribute: CampusId
- Display Attribute: CampusName
- FormStatusCodeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_VERSION_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- FormTypeCodeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_FORM_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: FormTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- InstitutionLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: InstitutionId; Target Attribute: InstitutionId
- Display Attribute: InstitutionName
- applicationAdmitPeriods
-
Operation: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationAdmitPeriodsParameters:
- FormId:
$request.path.FormId
The application admit period is child to application form definition and provides information about the admit periods form metadata. - FormId:
- applicationPrograms
-
Operation: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/applicationProgramsParameters:
- FormId:
$request.path.FormId
The application program is child to application form definition and provides information about various parts of the form. - FormId:
- formFragments
-
Operation: /fscmRestApi/resources/11.13.18.05/applicationFormDefinitions/{FormId}/child/formFragmentsParameters:
- FormId:
$request.path.FormId
The application program is child to application form definition and provides information about the programs form metadata. - FormId: