regis

<back to all web services

RegentDegreesRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/{uuid}/RegentDegrees
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class RegentDegreesRequest
    {
        public virtual string uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class CatalogResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int id { get; set; }
        public virtual string catalog_code { get; set; }
    }

    public partial class ConcentrationResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int id { get; set; }
        public virtual string concentration_code { get; set; }
        public virtual string concentration_name { get; set; }
        public virtual bool is_active { get; set; }
    }

    public partial class ProgramResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int id { get; set; }
        public virtual string program_code { get; set; }
        public virtual string program_pretty_code { get; set; }
        public virtual string program_long_name { get; set; }
        public virtual string available_concentrations { get; set; }
        public virtual bool is_active { get; set; }
        public virtual DateTime timestamp { get; set; }
    }

    public partial class RegentDegreeResponse
    {
        public virtual int id { get; set; }
        public virtual string program_code { get; set; }
        public virtual string program_name { get; set; }
        public virtual string concentration_code { get; set; }
        public virtual string concentration_name { get; set; }
        public virtual DateTime? graduation_month { get; set; }
        public virtual DateTime? start_date { get; set; }
        public virtual DateTime? end_date { get; set; }
        public virtual decimal? gpa { get; set; }
        public virtual string academic_level { get; set; }
        public virtual DateTime? commencement_date { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
        public virtual string changed_by { get; set; }
        public virtual DateTime timestamp { get; set; }
    }

    public partial class RegentDegreesResponse
    {
        public RegentDegreesResponse()
        {
            regent_degrees = new List<RegentDegreeResponse>{};
            valid_programs = new List<ProgramResponse>{};
            valid_concentrations = new List<ConcentrationResponse>{};
            valid_catalogs = new List<CatalogResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual List<RegentDegreeResponse> regent_degrees { get; set; }
        public virtual List<ProgramResponse> valid_programs { get; set; }
        public virtual List<ConcentrationResponse> valid_concentrations { get; set; }
        public virtual List<CatalogResponse> valid_catalogs { get; set; }
    }

}

C# RegentDegreesRequest 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}/RegentDegrees 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,
	regent_degrees: 
	[
		{
			id: 0,
			program_code: String,
			program_name: String,
			concentration_code: String,
			concentration_name: String,
			graduation_month: 0001-01-01,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			gpa: 0,
			academic_level: String,
			commencement_date: 0001-01-01,
			added_date: 0001-01-01,
			added_by: String,
			changed_date: 0001-01-01,
			changed_by: String,
			timestamp: 0001-01-01
		}
	],
	valid_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
		}
	],
	valid_concentrations: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			concentration_code: String,
			concentration_name: String,
			is_active: False
		}
	],
	valid_catalogs: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			catalog_code: String
		}
	]
}