Get all admission applications
get
/fscmRestApi/resources/11.13.18.05/transactionReferenceContexts/{transactionReferenceContextsUniqID}/child/admissionApplications
Request
Path Parameters
-
transactionReferenceContextsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Transaction Reference Contexts resource and used to uniquely identify an instance of Transaction Reference Contexts. The client should not generate the hash key value. Instead, the client should query on the Transaction Reference Contexts collection resource in order to navigate to a specific instance of Transaction Reference Contexts to get the hash key.
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 -
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:- PrimaryKey: Finds all admission applications that match the primary key criteria specified.
Finder Variables:- ObjectId; integer; Unique identifier for the admission application.
- ObjectType; string.
- PrimaryKey: Finds all admission applications that match the primary key criteria 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:- ApplicationURL; string; The URL that displays the application.
- DiscountAmount; number; The amount deducted from the total amount charged for the application.
- ObjectId; integer; Identifies the object that initiates the application.
- ObjectType; string; Indicates the type of application.
- ProgramCurriculumId; integer; The curriculum identifier for the program of the selected course.
- ProgramName; string; The name for the academic program of the selected course.
- ProgramTitle; string; The title for the academic program of the selected course.
- TotalAmount; number; The total amount charged for the application.
-
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 : transactionReferenceContexts-admissionApplications
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 : transactionReferenceContexts-admissionApplications-item-response
Type:
Show Source
object
-
ApplicationURL: string
Title:
Application URL
Read Only:true
The URL that displays the application. -
courseSelections: array
Course Selections
Title:
Course Selections
The course selections resource captures course preference selections for an admissions application. -
DiscountAmount: number
Read Only:
true
The amount deducted from the total amount charged for the application. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectFees: array
Object Fees
Title:
Object Fees
The object fees resource lists all the different fees on the student application. -
ObjectId: integer
Read Only:
true
Identifies the object that initiates the application. -
ObjectType: string
Read Only:
true
Indicates the type of application. -
ProgramCurriculumId: integer
Title:
Program Curriculum ID
Read Only:true
The curriculum identifier for the program of the selected course. -
ProgramName: string
Title:
Program Name
Read Only:true
The name for the academic program of the selected course. -
ProgramTitle: string
Title:
Program Title
Read Only:true
The title for the academic program of the selected course. -
TotalAmount: number
Read Only:
true
The total amount charged for the application.
Nested Schema : Course Selections
Type:
array
Title:
Course Selections
The course selections resource captures course preference selections for an admissions application.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Object Fees
Type:
array
Title:
Object Fees
The object fees resource lists all the different fees on the student application.
Show Source
Nested Schema : transactionReferenceContexts-admissionApplications-courseSelections-item-response
Type:
Show Source
object
-
CatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
The catalog number of the course selection. -
CourseCurriculumId: integer
(int64)
Read Only:
true
The curriculum identifier for the selected course. -
CourseDescription: string
The description of the selected course.
-
CourseListCurriculumId: integer
(int64)
Read Only:
true
The curriculum identifier for the course list of the selected course. -
CourseListName: string
Title:
Name
Read Only:true
Maximum Length:50
The name for the course list of the selected course. -
CourseListSequence: integer
(int32)
Read Only:
true
The sequence of the course list for the associated course selection. -
CourseListTitle: string
Title:
Title
Read Only:true
Maximum Length:100
The title for the course list of the selected course. -
CourseName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the selected course. -
CoursePreference: integer
(int32)
Read Only:
true
Course selection preference sequence number. -
CourseSelectionId: integer
(int64)
Read Only:
true
Unique identifier for the course selection. -
CourseTitle: string
Title:
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. -
SelectionDateTime: string
(date-time)
Read Only:
true
The date of the course selection. -
Subject: string
Title:
Name
Read Only:true
Maximum Length:50
The subject of the course selection. -
SubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
The subject code of the course selection.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : 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 : transactionReferenceContexts-admissionApplications-ObjectFees-item-response
Type:
Show Source
object
-
Amount: number
Read Only:
true
The amount charged as part of the student???s application fee. -
CurrencyCode: string
Read Only:
true
Currency code associated with the application. -
CurrencySymbol: string
Read Only:
true
The currency symbol associated with the application. -
DiscountAmount: number
Read Only:
true
The amount deducted from the amount that???s charged as part of the student???s application fee. -
DiscountDescription: string
Read Only:
true
The description of the discount associated with the application. -
DiscountErrorFlag: boolean
Read Only:
true
Indicates whether an error occurred during discount calculation. Default value is 'False'. -
DiscountId: integer
Read Only:
true
Identifies the discount on the application. -
DiscountTitle: string
Read Only:
true
The title of the discount associated with the application. -
FeeAttributeId: integer
Read Only:
true
Identifies the application fee attribute. -
FeeId: integer
Read Only:
true
Identifies the application fee. -
FeeName: string
Read Only:
true
The name of the fee. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
Read Only:
true
Identifies the object that initiates the application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source