regis

<back to all web services

AcademicSummaryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/{uuid}/Summary
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type StudentProgramSimpleResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val program_id:Int32 = new Int32() with get,set
        member val program_code:String = null with get,set
        member val program_name:String = null with get,set
        member val concentration_code:String = null with get,set
        member val concentration_name:String = null with get,set
        member val start_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val end_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val catalog:String = null with get,set
        member val is_active:Boolean = new Boolean() with get,set
        member val is_graduated:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type AcademicSummaryResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val gpa:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val student_programs:ResizeArray<StudentProgramSimpleResponse> = new ResizeArray<StudentProgramSimpleResponse>() with get,set
        member val unofficial_undergraduate_degree_description:String = null with get,set
        member val messages:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type AcademicSummaryRequest() = 
        member val uuid:String = null with get,set

F# AcademicSummaryRequest 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 /Academic/{uuid}/Summary 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,
	gpa: 0,
	student_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
		}
	],
	unofficial_undergraduate_degree_description: String,
	messages: 
	[
		String
	]
}