Create a transcript type
post
/fscmRestApi/resources/11.13.18.05/transcriptTypes
Request
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.
-
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
-
Description: string
Title:
Description
The description of the transcript type, such as online transcript. -
EnabledFlag(required): boolean
Title:
Enable
Maximum Length:1
Indicates whether the transcript type is enabled. The default value is true. -
InstitutionId(required): integer
(int64)
Title:
Institution ID
The unique identifier for an institution that's associated with a transcript. -
InstitutionName: string
Title:
Institution
Maximum Length:50
The name for an institution that's associated with a transcript. -
OfficialTranscriptFlag(required): boolean
Title:
Official transcript
Maximum Length:1
Indicates that the transcript is an official transcript type. The default value is false. -
OnlinePrintEnableFlag(required): boolean
Title:
Online transcript
Maximum Length:1
Indicates that the transcript is an online transcript type. The default value is false. -
templateAssignments: array
Template Assignments
Title:
Template Assignments
The 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 Levels
The transcript type academic levels resource provides a list of academic levels related to the transcript type. -
TranscriptTypeCode(required): string
Title:
Code
Maximum Length:30
The code for the transcript type. -
TranscriptTypeName(required): string
Title:
Name
Maximum Length:50
The name of the transcript type such as online or official.
Nested Schema : Template Assignments
Type:
array
Title:
Template Assignments
The 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:
array
Title:
Transcript Type Levels
The 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:
50
The 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 ID
The unique identifier for an academic level that's associated with a transcript. -
AcademicLevelName: string
Title:
Academic Level Name
Maximum Length:100
The name for an academic level that's associated with a transcript. -
TranscriptTypeLevelId: integer
(int64)
The unique identifier for a transcript type academic level.
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 : transcriptTypes-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the row was created. -
Description: string
Title:
Description
The description of the transcript type, such as online transcript. -
EnabledFlag: boolean
Title:
Enable
Maximum Length:1
Indicates whether the transcript type is enabled. The default value is true. -
InstitutionId: integer
(int64)
Title:
Institution ID
The unique identifier for an institution that's associated with a transcript. -
InstitutionName: string
Title:
Institution
Maximum Length:50
The name for an institution that's associated with a transcript. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfficialTranscriptFlag: boolean
Title:
Official transcript
Maximum Length:1
Indicates that the transcript is an official transcript type. The default value is false. -
OnlinePrintEnableFlag: boolean
Title:
Online transcript
Maximum Length:1
Indicates that the transcript is an online transcript type. The default value is false. -
templateAssignments: array
Template Assignments
Title:
Template Assignments
The 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 Levels
The transcript type academic levels resource provides a list of academic levels related to the transcript type. -
TranscriptTypeCode: string
Title:
Code
Maximum Length:30
The code for the transcript type. -
TranscriptTypeId: integer
(int64)
Title:
Transcript Type ID
Read Only:true
The unique identifier for a transcript type. -
TranscriptTypeName: string
Title:
Name
Maximum Length:50
The name of the transcript type such as online or official.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Template Assignments
Type:
array
Title:
Template Assignments
The 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:
array
Title:
Transcript Type Levels
The 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 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.
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:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
EnabledFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether a template is active and available for use. The default value is true. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TemplateCode: string
Maximum Length:
50
The user defined unique identifier for a transcript template. -
TemplateContent: string
Read Only:
true
The 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:
true
Maximum Length:1000
The description for a transcript template. -
TemplateName: string
Read Only:
true
Maximum Length:50
The name for a transcript template. -
TranscriptAssignmentId: integer
(int64)
Read Only:
true
The 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:
array
Title:
Links
The 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 ID
The unique identifier for an academic level that's associated with a transcript. -
AcademicLevelName: string
Title:
Academic Level Name
Maximum Length:100
The name for an academic level that's associated with a transcript. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TranscriptTypeLevelId: integer
(int64)
The unique identifier for a transcript type academic level.
Nested Schema : Links
Type:
array
Title:
Links
The 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: