regis

<back to all web services

CourseCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Courses/Admin/Create
import Foundation
import ServiceStack

public class CourseCreateRequest : Codable
{
    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 course_requirements:[CourseRequirementResponse] = []
    public var authorizing_uuid:String

    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(){}
}


Swift CourseCreateRequest 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 /Courses/Admin/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	course_name: String,
	title: String,
	pretty_title: String,
	course_description: String,
	is_active: False,
	course_requirements: 
	[
		{
			course_id: 0,
			required_course_id: 0,
			requirement_group: 0,
			is_prerequisite: False,
			is_corequisite: False,
			timestamp: 0001-01-01
		}
	],
	authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}