regis

<back to all web services

StudentTransferCredentialPackageCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentTransferCredentials/{uuid}/Create
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class StudentAcademicCredentialCreateRequest
            Public Overridable Property uuid As String
            Public Overridable Property section_id As Nullable(Of Integer)
            Public Overridable Property course_name As String
            Public Overridable Property section_code As String
            Public Overridable Property subject As String
            Public Overridable Property course_level As Nullable(Of Integer)
            Public Overridable Property title As String
            Public Overridable Property location As String
            Public Overridable Property is_audio As Boolean
            Public Overridable Property is_oncampus As Boolean
            Public Overridable Property credit_value As Nullable(Of Decimal)
            Public Overridable Property audit_value As Nullable(Of Decimal)
            Public Overridable Property is_audit As Boolean
            Public Overridable Property is_pass_fail As Boolean
            Public Overridable Property grade As String
            Public Overridable Property is_grade_final As Boolean
            Public Overridable Property gpa_credits As Nullable(Of Decimal)
            Public Overridable Property grade_points As Nullable(Of Decimal)
            Public Overridable Property academic_level As String
            Public Overridable Property printed_comments As String
            Public Overridable Property term As String
            Public Overridable Property reporting_term As String
            Public Overridable Property reporting_year As Nullable(Of Integer)
            Public Overridable Property current_status As String
            Public Overridable Property authorizing_uuid As String
        End Class

        Public Partial Class StudentTransferCredentialCreateRequest
            Public Overridable Property uuid As String
            Public Overridable Property course_name As String
            Public Overridable Property title As String
            Public Overridable Property credit_value As Decimal
            Public Overridable Property authorizing_uuid As String
        End Class

        Public Partial Class StudentTransferCredentialPackageCreateRequest
            Public Sub New()
                studentTransferCredentialCreateRequest = New List(Of StudentTransferCredentialCreateRequest)
                studentAcademicCredentialCreateRequest = New List(Of StudentAcademicCredentialCreateRequest)
            End Sub

            Public Overridable Property uuid As String
            Public Overridable Property institution_id As Integer
            Public Overridable Property authorizing_uuid As String
            Public Overridable Property is_advanced_standing As Boolean
            Public Overridable Property studentTransferCredentialCreateRequest As List(Of StudentTransferCredentialCreateRequest)
            Public Overridable Property studentAcademicCredentialCreateRequest As List(Of StudentAcademicCredentialCreateRequest)
        End Class
    End Namespace
End Namespace

VB.NET StudentTransferCredentialPackageCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /StudentTransferCredentials/{uuid}/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	institution_id: 0,
	authorizing_uuid: String,
	is_advanced_standing: False,
	studentTransferCredentialCreateRequest: 
	[
		{
			uuid: String,
			course_name: String,
			title: String,
			credit_value: 0,
			authorizing_uuid: String
		}
	],
	studentAcademicCredentialCreateRequest: 
	[
		{
			uuid: String,
			section_id: 0,
			course_name: String,
			section_code: String,
			subject: String,
			course_level: 0,
			title: String,
			location: String,
			is_audio: False,
			is_oncampus: False,
			credit_value: 0,
			audit_value: 0,
			is_audit: False,
			is_pass_fail: False,
			grade: String,
			is_grade_final: False,
			gpa_credits: 0,
			grade_points: 0,
			academic_level: String,
			printed_comments: String,
			term: String,
			reporting_term: String,
			reporting_year: 0,
			current_status: String,
			authorizing_uuid: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}