regis

<back to all web services

CourseRequirementsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Course/{id}/Requirements
namespace regis.ClassLibrary.Requests

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

    [<AllowNullLiteral>]
    type CourseRequirementResponse() = 
        member val course_id:Int32 = new Int32() with get,set
        member val required_course_id:Int32 = new Int32() with get,set
        member val requirement_group:Int32 = new Int32() with get,set
        member val is_prerequisite:Boolean = new Boolean() with get,set
        member val is_corequisite:Boolean = new Boolean() with get,set
        member val timestamp:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type CourseResponse() = 
        member val id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val course_name:String = null with get,set
        member val title:String = null with get,set
        member val pretty_title:String = null with get,set
        member val course_description:String = null with get,set
        member val is_active:Boolean = new Boolean() with get,set
        member val added_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val added_by:String = null with get,set
        member val changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val changed_by:String = null with get,set
        member val timestamp:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type CourseRequirementsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val course_id:Int32 = new Int32() with get,set
        member val requirements:ResizeArray<CourseRequirementResponse> = new ResizeArray<CourseRequirementResponse>() with get,set
        member val courses:ResizeArray<CourseResponse> = new ResizeArray<CourseResponse>() with get,set

    [<AllowNullLiteral>]
    type CourseRequirementsRequest() = 
        member val id:Int32 = new Int32() with get,set

F# CourseRequirementsRequest 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 /Course/{id}/Requirements HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0
}
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
		}
	},
	course_id: 0,
	requirements: 
	[
		{
			course_id: 0,
			required_course_id: 0,
			requirement_group: 0,
			is_prerequisite: False,
			is_corequisite: False,
			timestamp: 0001-01-01
		}
	],
	courses: 
	[
		{
			id: 0,
			course_name: String,
			title: String,
			pretty_title: String,
			course_description: String,
			is_active: False,
			added_date: 0001-01-01,
			added_by: String,
			changed_date: 0001-01-01,
			changed_by: String,
			timestamp: 0001-01-01
		}
	]
}