Create a valid academic level
post
/fscmRestApi/resources/11.13.18.05/transcriptNotes/{TranscriptNoteId}/child/validAcademicLevels
Request
Path Parameters
-
TranscriptNoteId(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=
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AcademicLevelCode: string
Title:
Academic Level Code
Maximum Length:100
The code of an academic level. -
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
The unique identifier for an academic level which is associated with transcript note, such as graduate. -
NoteAssignmentId: integer
(int64)
Title:
Note Assignment ID
The unique identifier for a child valid academic level of a transcript note.
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 : transcriptNotes-validAcademicLevels-item-response
Type:
Show Source
object
-
AcademicLevelCode: string
Title:
Academic Level Code
Maximum Length:100
The code of an academic level. -
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
The unique identifier for an academic level which is associated with transcript note, such as graduate. -
AcademicLevelName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of an academic level. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the academic level. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the academic level was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The user who last updated the academic level. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The date and time when the academic level was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteAssignmentId: integer
(int64)
Title:
Note Assignment ID
The unique identifier for a child valid academic level of a transcript note.
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
- academicLevelCodesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: AcademicLevelCode; Target Attribute: LevelCode
- Display Attribute: LevelName