Update an academic history
patch
/fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/academicHistories/{AcademicHistoriesId}
Request
Path Parameters
-
AcademicHistoriesId(required): integer(int64)
The unique identifier for academic history.
-
PartyId(required): integer(int64)
The unique identifier for the party. Party can be a person. For example, a student can be a party.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AcademicHistoriesId: integer
(int64)
Title:
Academic History ID
The unique identifier for academic history. -
DegreeEarned: string
Title:
Degree Earned
Maximum Length:200
The degree or qualification which the student earned. -
EntryDate: string
(date)
Title:
Entry Date
The date when the student was admitted to the external organization. -
GraduationDate: string
(date)
Title:
Graduation Date
The date when the student graduated. -
GraduationFlag: boolean
Title:
Graduation Indicator
Maximum Length:1
Indicates whether the student graduated from the external organization. -
OrganizationPartyId: integer
(int64)
Title:
Organization Party ID
The unique identifier for a trading community party of the external organization. -
OriginSystemCode: string
Title:
Code for Data Source
Maximum Length:30
The code for the third party source where this data row originated. A list of accepted values is defined in the lookup type ORA_HEY_ORIGIN_SYSTEM. -
OriginSystemReference: string
Title:
Data Source Reference
Maximum Length:255
The primary reference key for this data row in the third party source.
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 : personProfiles-academicHistories-item-response
Type:
Show Source
object
-
AcademicHistoriesId: integer
(int64)
Title:
Academic History ID
The unique identifier for academic history. -
DegreeEarned: string
Title:
Degree Earned
Maximum Length:200
The degree or qualification which the student earned. -
EntryDate: string
(date)
Title:
Entry Date
The date when the student was admitted to the external organization. -
GraduationDate: string
(date)
Title:
Graduation Date
The date when the student graduated. -
GraduationFlag: boolean
Title:
Graduation Indicator
Maximum Length:1
Indicates whether the student graduated from the external organization. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationPartyId: integer
(int64)
Title:
Organization Party ID
The unique identifier for a trading community party of the external organization. -
OrganizationPartyName: string
Title:
Organization Party Name
Read Only:true
The name of the external organization. -
OriginSystemCode: string
Title:
Code for Data Source
Maximum Length:30
The code for the third party source where this data row originated. A list of accepted values is defined in the lookup type ORA_HEY_ORIGIN_SYSTEM. -
OriginSystemMeaning: string
Title:
Data Source
Read Only:true
Maximum Length:80
The meaning of the origin system code. A list of accepted values is defined in the lookup type ORA_HEY_ORIGIN_SYSTEM. -
OriginSystemReference: string
Title:
Data Source Reference
Maximum Length:255
The primary reference key for this data row in the third party source.
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
- OriginSystemLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_ORIGIN_SYSTEM%2CLookupCode%3D{OriginSystemCode}
The following properties are defined on the LOV link relation:- Source Attribute: OriginSystemCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: