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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CourseRequirementsRequest
    {
        public Integer id = null;
        
        public Integer getId() { return id; }
        public CourseRequirementsRequest setId(Integer value) { this.id = value; return this; }
    }

    public static class CourseRequirementsResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer course_id = null;
        public ArrayList<CourseRequirementResponse> requirements = null;
        public ArrayList<CourseResponse> courses = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CourseRequirementsResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getCourseId() { return course_id; }
        public CourseRequirementsResponse setCourseId(Integer value) { this.course_id = value; return this; }
        public ArrayList<CourseRequirementResponse> getRequirements() { return requirements; }
        public CourseRequirementsResponse setRequirements(ArrayList<CourseRequirementResponse> value) { this.requirements = value; return this; }
        public ArrayList<CourseResponse> getCourses() { return courses; }
        public CourseRequirementsResponse setCourses(ArrayList<CourseResponse> value) { this.courses = value; return this; }
    }

    public static class CourseRequirementResponse
    {
        public Integer course_id = null;
        public Integer required_course_id = null;
        public Integer requirement_group = null;
        public Boolean is_prerequisite = null;
        public Boolean is_corequisite = null;
        public Date timestamp = null;
        
        public Integer getCourseId() { return course_id; }
        public CourseRequirementResponse setCourseId(Integer value) { this.course_id = value; return this; }
        public Integer getRequiredCourseId() { return required_course_id; }
        public CourseRequirementResponse setRequiredCourseId(Integer value) { this.required_course_id = value; return this; }
        public Integer getRequirementGroup() { return requirement_group; }
        public CourseRequirementResponse setRequirementGroup(Integer value) { this.requirement_group = value; return this; }
        public Boolean getIsPrerequisite() { return is_prerequisite; }
        public CourseRequirementResponse setIsPrerequisite(Boolean value) { this.is_prerequisite = value; return this; }
        public Boolean getIsCorequisite() { return is_corequisite; }
        public CourseRequirementResponse setIsCorequisite(Boolean value) { this.is_corequisite = value; return this; }
        public Date getTimestamp() { return timestamp; }
        public CourseRequirementResponse setTimestamp(Date value) { this.timestamp = value; return this; }
    }

    public static class CourseResponse
    {
        public Integer id = null;
        public String course_name = null;
        public String title = null;
        public String pretty_title = null;
        public String course_description = null;
        public Boolean is_active = null;
        public Date added_date = null;
        public String added_by = null;
        public Date changed_date = null;
        public String changed_by = null;
        public Date timestamp = null;
        
        public Integer getId() { return id; }
        public CourseResponse setId(Integer value) { this.id = value; return this; }
        public String getCourseName() { return course_name; }
        public CourseResponse setCourseName(String value) { this.course_name = value; return this; }
        public String getTitle() { return title; }
        public CourseResponse setTitle(String value) { this.title = value; return this; }
        public String getPrettyTitle() { return pretty_title; }
        public CourseResponse setPrettyTitle(String value) { this.pretty_title = value; return this; }
        public String getCourseDescription() { return course_description; }
        public CourseResponse setCourseDescription(String value) { this.course_description = value; return this; }
        public Boolean getIsActive() { return is_active; }
        public CourseResponse setIsActive(Boolean value) { this.is_active = value; return this; }
        public Date getAddedDate() { return added_date; }
        public CourseResponse setAddedDate(Date value) { this.added_date = value; return this; }
        public String getAddedBy() { return added_by; }
        public CourseResponse setAddedBy(String value) { this.added_by = value; return this; }
        public Date getChangedDate() { return changed_date; }
        public CourseResponse setChangedDate(Date value) { this.changed_date = value; return this; }
        public String getChangedBy() { return changed_by; }
        public CourseResponse setChangedBy(String value) { this.changed_by = value; return this; }
        public Date getTimestamp() { return timestamp; }
        public CourseResponse setTimestamp(Date value) { this.timestamp = value; return this; }
    }

}

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