regis

<back to all web services

CourseRequirementsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Course/{id}/Requirements
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 CourseRequirementsRequest
    {
        public virtual int id { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class CourseRequirementResponse
    {
        public virtual int course_id { get; set; }
        public virtual int required_course_id { get; set; }
        public virtual int requirement_group { get; set; }
        public virtual bool is_prerequisite { get; set; }
        public virtual bool is_corequisite { get; set; }
        public virtual DateTime timestamp { get; set; }
    }

    public partial class CourseRequirementsResponse
    {
        public CourseRequirementsResponse()
        {
            requirements = new List<CourseRequirementResponse>{};
            courses = new List<CourseResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int course_id { get; set; }
        public virtual List<CourseRequirementResponse> requirements { get; set; }
        public virtual List<CourseResponse> courses { get; set; }
    }

    public partial class CourseResponse
    {
        public virtual int? id { get; set; }
        public virtual string course_name { get; set; }
        public virtual string title { get; set; }
        public virtual string pretty_title { get; set; }
        public virtual string course_description { get; set; }
        public virtual bool is_active { 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; }
    }

}

C# 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
		}
	]
}