Get all extracurricular activities
get
/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/extracurricularActivities
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 -
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 extracurricular activity instances that match the primary key criteria specified.
Finder Variables- ExtracurricularTransactionId; integer; Unique identifier for extracurricular activities.
- PrimaryKey Finds all extracurricular activity instances 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:- AcademicLevelCode; string; Academic level code when the activity occurred.
- AcademicLevelCodeMeaning; string; Meaning of academic level code.
- ActivityDescription; string; Description of the extracurricular activity.
- ActivityTypeCode; string; Activity type code of the extracurricular activity.
- ActivityTypeCodeMeaning; string; Meaning of activity type code.
- ContactAddress; string; Location address of the external contact associated with an extracurricular activity.
- ContactEmailAddress; string; Email address of the external contact associated with an extracurricular activity.
- ContactFirstName; string; First name of the external contact associated with an extracurricular activity.
- ContactLastName; string; Last name of the external contact associated with an extracurricular activity.
- ContactNameTitle; string; Title of external contact, such as counselor.
- EndDate; string; Date when the extracurricular activity ended.
- ExtracurricularTransactionId; integer; Extracurricular activity transaction unique identifier.
- HoursPERWeek; integer; Number of hours per week that student participates in the activity.
- InterestedInPursuingCode; string; Indicates if student is interested in pursuing the activity at the institution.
- InterestedInPursuingCodeMeaning; string; Meaning of pursuing code.
- OrganizationName; string; 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; 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; Indicates whether an external organization name has been entered by the student.
- OrganizationPartyId; integer; Trading community party identifier for the external organization where the activity occurred.
- PhoneAreaCode; string; Phone area code of the external contact associated with an extracurricular activity.
- PhoneCountryCode; string; Phone country code of the external contact associated with an extracurricular activity.
- PhoneNumber; string; Phone contact number of the external contact associated with an extracurricular activity.
- PositionHeld; string; Position held for the extracurricular activity, such as captain or treasurer.
- StartDate; string; Date when the extracurricular activity started.
- WeeksPERYear; integer; Number of weeks per year that student participates in the activity.
-
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 : admissionApplications-extracurricularActivities
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 : admissionApplications-extracurricularActivities-item-response
Type:
Show Source
object
-
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. -
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.
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.