regis

<back to all web services

CourseRequirementsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Course/{id}/Requirements
import Foundation
import ServiceStack

public class CourseRequirementsRequest : Codable
{
    public var id:Int

    required public init(){}
}

public class CourseRequirementsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var course_id:Int
    public var requirements:[CourseRequirementResponse] = []
    public var courses:[CourseResponse] = []

    required public init(){}
}

public class CourseRequirementResponse : Codable
{
    public var course_id:Int
    public var required_course_id:Int
    public var requirement_group:Int
    public var is_prerequisite:Bool
    public var is_corequisite:Bool
    public var timestamp:Date

    required public init(){}
}

public class CourseResponse : Codable
{
    public var id:Int?
    public var course_name:String
    public var title:String
    public var pretty_title:String
    public var course_description:String
    public var is_active:Bool
    public var added_date:Date?
    public var added_by:String
    public var changed_date:Date?
    public var changed_by:String
    public var timestamp:Date

    required public init(){}
}


Swift 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
		}
	]
}