regis

<back to all web services

StudentProgramsRequest

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

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class StudentProgramsRequest
            Public Overridable Property uuid As String
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class StudentProgramSimpleResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property program_id As Integer
            Public Overridable Property program_code As String
            Public Overridable Property program_name As String
            Public Overridable Property concentration_code As String
            Public Overridable Property concentration_name As String
            Public Overridable Property start_date As Nullable(Of Date)
            Public Overridable Property end_date As Nullable(Of Date)
            Public Overridable Property catalog As String
            Public Overridable Property is_active As Boolean
            Public Overridable Property is_graduated As Boolean
        End Class

        Public Partial Class StudentProgramsResponse
            Public Sub New()
                programs = New List(Of StudentProgramSimpleResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property programs As List(Of StudentProgramSimpleResponse)
        End Class
    End Namespace
End Namespace

VB.NET StudentProgramsRequest 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 /StudentPrograms HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	regent_id: 0,
	uuid: String,
	programs: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			regent_id: 0,
			uuid: String,
			program_id: 0,
			program_code: String,
			program_name: String,
			concentration_code: String,
			concentration_name: String,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			catalog: String,
			is_active: False,
			is_graduated: False
		}
	]
}