regis

<back to all web services

ProgramsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Programs
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 ProgramsRequest
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class ProgramResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property id As Integer
            Public Overridable Property program_code As String
            Public Overridable Property program_pretty_code As String
            Public Overridable Property program_long_name As String
            Public Overridable Property available_concentrations As String
            Public Overridable Property is_active As Boolean
            Public Overridable Property timestamp As Date
        End Class

        Public Partial Class ProgramsResponse
            Public Sub New()
                programs = New List(Of ProgramResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property programs As List(Of ProgramResponse)
        End Class
    End Namespace
End Namespace

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

{
	
}
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
		}
	},
	programs: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			program_code: String,
			program_pretty_code: String,
			program_long_name: String,
			available_concentrations: String,
			is_active: False,
			timestamp: 0001-01-01
		}
	]
}