Get an academic history
get
/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/academicHistories/{academicHistoriesUniqID}
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=
-
academicHistoriesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Academic Histories resource and used to uniquely identify an instance of Academic Histories. The client should not generate the hash key value. Instead, the client should query on the Academic Histories collection resource in order to navigate to a specific instance of Academic Histories 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 -
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 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-academicHistories-item-response
Type:
Show Source
object
-
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. -
StudentIdentifier: string
Title:
Student ID
Maximum Length:50
Identifier assigned to the student by the organization.
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.
Links
- GPAWeightingCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_ACADHIST_GPA_WEIGHTING%2CLookupCode%3D{GPAWeightingCode}
The following properties are defined on the LOV link relation:- Source Attribute: GPAWeightingCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- academicLevelCodesLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_ACADHIST_ACAD_LEVEL%2CLookupCode%3D{AcademicLevelCode}
The following properties are defined on the LOV link relation:- Source Attribute: AcademicLevelCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- degreeCodesLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_ACADHIST_DEGREE%2CLookupCode%3D{DegreeCode}
The following properties are defined on the LOV link relation:- Source Attribute: DegreeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- majorProgramCodesLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_ACADHIST_MAJOR_PROG%2CLookupCode%3D{MajorProgramCode}
The following properties are defined on the LOV link relation:- Source Attribute: MajorProgramCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- organizationTypeCodesLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_ACADHIST_ORG_TYPE%2CLookupCode%3D{OrganizationTypeCode}
The following properties are defined on the LOV link relation:- Source Attribute: OrganizationTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- organizationsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: OrganizationPartyId; Target Attribute: PartyId
- Display Attribute: OrganizationName
- phoneCountryCodesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
- Display Attribute: PhoneCountryCode, TerritoryShortName