Update a transcript type
patch
/fscmRestApi/resources/11.13.18.05/transcriptTypes/{transcriptTypesUniqID}
Request
Path Parameters
-
transcriptTypesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Transcript Types resource and used to uniquely identify an instance of Transcript Types. The client should not generate the hash key value. Instead, the client should query on the Transcript Types collection resource in order to navigate to a specific instance of Transcript Types to get the hash key.
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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-
Description: string
Title:
DescriptionThe description of the transcript type, such as online transcript. -
EnabledFlag: boolean
Title:
EnableMaximum Length:1Indicates whether the transcript type is enabled. The default value is true. -
InstitutionId: integer
(int64)
Title:
Institution IDThe unique identifier for an institution that's associated with a transcript. -
InstitutionName: string
Title:
InstitutionMaximum Length:50The name for an institution that's associated with a transcript. -
OfficialTranscriptFlag: boolean
Title:
Official transcriptMaximum Length:1Indicates that the transcript is an official transcript type. The default value is false. -
OnlinePrintEnableFlag: boolean
Title:
Online transcriptMaximum Length:1Indicates that the transcript is an online transcript type. The default value is false. -
templateAssignments: array
Template Assignments
Title:
Template AssignmentsThe template assignment resource provides a list of assigned transcript templates that can be used with this transcript type. -
transcriptTypeAcademicLevels: array
Transcript Type Levels
Title:
Transcript Type LevelsThe transcript type academic levels resource provides a list of academic levels related to the transcript type. -
TranscriptTypeCode: string
Title:
CodeMaximum Length:30The code for the transcript type. -
TranscriptTypeName: string
Title:
NameMaximum Length:50The name of the transcript type such as online or official.
Nested Schema : Template Assignments
Type:
arrayTitle:
Template AssignmentsThe template assignment resource provides a list of assigned transcript templates that can be used with this transcript type.
Show Source
Nested Schema : Transcript Type Levels
Type:
arrayTitle:
Transcript Type LevelsThe transcript type academic levels resource provides a list of academic levels related to the transcript type.
Show Source
Nested Schema : schema
Type:
Show Source
object-
AssignmentSequence: integer
(int32)
The sequence number assigned to the templates for a transcript type.
-
TemplateCode: string
Maximum Length:
50The user defined unique identifier for a transcript template. -
TranscriptTemplateId: integer
(int64)
The generated unique identifier for a transcript template.
Nested Schema : schema
Type:
Show Source
object-
AcademicLevelId: integer
(int64)
Title:
Academic Level IDThe unique identifier for an academic level that's associated with a transcript. -
AcademicLevelName: string
Title:
Academic Level NameMaximum Length:100The name for an academic level that's associated with a transcript.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : transcriptTypes-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date the row was created. -
Description: string
Title:
DescriptionThe description of the transcript type, such as online transcript. -
EnabledFlag: boolean
Title:
EnableMaximum Length:1Indicates whether the transcript type is enabled. The default value is true. -
InstitutionId: integer
(int64)
Title:
Institution IDThe unique identifier for an institution that's associated with a transcript. -
InstitutionName: string
Title:
InstitutionMaximum Length:50The name for an institution that's associated with a transcript. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OfficialTranscriptFlag: boolean
Title:
Official transcriptMaximum Length:1Indicates that the transcript is an official transcript type. The default value is false. -
OnlinePrintEnableFlag: boolean
Title:
Online transcriptMaximum Length:1Indicates that the transcript is an online transcript type. The default value is false. -
templateAssignments: array
Template Assignments
Title:
Template AssignmentsThe template assignment resource provides a list of assigned transcript templates that can be used with this transcript type. -
transcriptTypeAcademicLevels: array
Transcript Type Levels
Title:
Transcript Type LevelsThe transcript type academic levels resource provides a list of academic levels related to the transcript type. -
TranscriptTypeCode: string
Title:
CodeMaximum Length:30The code for the transcript type. -
TranscriptTypeId: integer
(int64)
Title:
Transcript Type IDRead Only:trueThe unique identifier for a transcript type. -
TranscriptTypeName: string
Title:
NameMaximum Length:50The name of the transcript type such as online or official.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Template Assignments
Type:
arrayTitle:
Template AssignmentsThe template assignment resource provides a list of assigned transcript templates that can be used with this transcript type.
Show Source
Nested Schema : Transcript Type Levels
Type:
arrayTitle:
Transcript Type LevelsThe transcript type academic levels resource provides a list of academic levels related to the transcript type.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : transcriptTypes-templateAssignments-item-response
Type:
Show Source
object-
AssignmentSequence: integer
(int32)
The sequence number assigned to the templates for a transcript type.
-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the row. -
CreationDate: string
(date-time)
Read Only:
trueThe date the row was created. -
EnabledFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether a template is active and available for use. The default value is true. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date the row was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TemplateCode: string
Maximum Length:
50The user defined unique identifier for a transcript template. -
TemplateContent: string
Read Only:
trueThe content of a transcript template. This includes document text and formatting as well as the data tokens used to represent student transcript data. -
TemplateDescription: string
Read Only:
trueMaximum Length:1000The description for a transcript template. -
TemplateName: string
Read Only:
trueMaximum Length:50The name for a transcript template. -
TranscriptAssignmentId: integer
(int64)
Read Only:
trueThe generated unique identifier for the linkage between a transcript template and a transcript type or types. -
TranscriptTemplateId: integer
(int64)
The generated unique identifier for a transcript template.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : transcriptTypes-transcriptTypeAcademicLevels-item-response
Type:
Show Source
object-
AcademicLevelId: integer
(int64)
Title:
Academic Level IDThe unique identifier for an academic level that's associated with a transcript. -
AcademicLevelName: string
Title:
Academic Level NameMaximum Length:100The name for an academic level that's associated with a transcript. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TranscriptTypeLevelId: integer
(int64)
The unique identifier for a transcript type academic level.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- academicInstitutionsLOV
-
The list of values for the academic institution of the transcript.
- templateAssignments
-
Operation: /fscmRestApi/resources/11.13.18.05/transcriptTypes/{transcriptTypesUniqID}/child/templateAssignmentsParameters:
- transcriptTypesUniqID:
$request.path.transcriptTypesUniqID
The template assignment resource provides a list of assigned transcript templates that can be used with this transcript type. - transcriptTypesUniqID:
- transcriptTypeAcademicLevels
-
Parameters:
- transcriptTypesUniqID:
$request.path.transcriptTypesUniqID
The transcript type academic levels resource provides a list of academic levels related to the transcript type. - transcriptTypesUniqID: