Get all application forms
get
/fscmRestApi/resources/11.13.18.05/applicationFormDefinitions
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- ByKeywordFinder Find all drafts and versions that match the keyword specified.
Finder Variables- Keyword; string; The keyword for the form.
- FindByAcademicAdmitPeriodIdFinder Find all forms with an admit start type of Period that match the form admit period ID.
Finder Variables- AdmitPeriodId; integer; Unique identifier for application admit period.
- FindByAdmitDateFinder Retrieve forms when the admit date is either after the admit start date or before the admit end date provided by the admit start date range.
Finder Variables- AdmitDate; string; Admit date of the application.
- FindByFormIdFinder Find all forms with published status that match the form ID and have an Admissions Application form type.
Finder Variables- FormId; integer; Unique identifier for form.
- FindByOnlyFormIdFinder Find all forms that match the form ID.
Finder Variables- FormId; integer; Unique identifier for form.
- FindPublishedFormsByInstitutionIdAndAcademicLevelIdAndCampusIdFinder Find all forms with published status that match institution ID, academic level ID, and campus ID. Institution ID is a mandatory attribute.
Finder Variables- AcademicLevelId; integer; Unique identifier for academic level.
- CampusId; integer; Unique identifier for campus.
- InstitutionId; integer; Unique identifier for institution.
- FindPublishedFormsByInstitutionIdAndAcademicLevelIdAndProgramItemCurriculumIdFinder Find all forms with published status that match institution ID, academic level ID, and program item ID. Institution ID is a mandatory attribute.
Finder Variables- AcademicLevelId; integer; Unique identifier for academic level.
- InstitutionId; integer; Unique identifier for institution.
- ProgramItemId; integer; Unique identifier for application programs.
- FindPublishedFormsByInstitutionIdFinder Find all forms with published status that match the institution ID.
Finder Variables- InstitutionId; integer; Unique identifier for institution.
- FindPublishedFormsByProgramItemCurriculumIdFinder Find all forms with published status that have specific programs matching the program item ID.
Finder Variables- ProgramItemId; integer; Unique identifier for application programs.
- PrimaryKey Finds all application forms that match the primary key criteria specified.
Finder Variables- FormId; integer; Unique identifier for the application form.
- UniqueFormCodeFinder Finds the default version of each form that matches the form code specified.
Finder Variables- Keyword; string; The keyword for the form.
- ByKeywordFinder Find all drafts and versions that match the keyword specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AcademicLevelId; integer; Admissions application academic level identifier.
- AcademicLevelName; string; Name of academic level.
- AcademicProgramGroupId; integer; Academic group identifier for the program.
- AcademicProgramGroupName; string; Name of academic program group.
- AcademicProgramTypeCode; string; Type of program, such as a program with specialization.
- AcademicProgramTypeMeaning; string; Meaning of type of program.
- AdmitEndDate; string; Admit academic period ending date.
- AdmitStartDate; string; Admit academic period starting date.
- AdmitStartTypeCode; string; Admit start type, for example starting academic period or start date.
- AdmitStartTypeMeaning; string; Meaning of admit start type code.
- AdmitTypeCode; string; Type of applicant before entry to the academic institution, for example a transfer applicant.
- AdmitTypeMeaning; string; Meaning of admit type code.
- CampusId; integer; Unique identifier for the campus associated with the form.
- CampusName; string; Name of the campus.
- DisplayName; string; Form name that's displayed to the user.
- FormCode; string; The unique code of a form.
- FormId; integer; The generated unique identifier for form.
- FormTypeCode; string; Code for form type, for example admissions application or residency appeal.
- FormTypeMeaning; string; Meaning of form type code.
- InstitutionId; integer; Unique identifier for the institution associated with the form.
- InstitutionName; string; Name of the institution.
- Name; string; Form name, such as arts admissions application form.
- StatusCode; string; Form status code, for example unpublished, published, or archived.
- StatusMeaning; string; Meaning of status code.
- VersionDescription; string; The description of a published, unpublished, or draft form version.
- VersionName; string; The name of a published, unpublished, or draft form version.
- VersionNumber; integer; The version number of a published, unpublished, or draft form version.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : applicationFormDefinitions
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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