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

public class dtos
{

    public static class CourseCreateRequest
    {
        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 ArrayList<CourseRequirementResponse> course_requirements = null;
        public String authorizing_uuid = null;
        
        public String getCourseName() { return course_name; }
        public CourseCreateRequest setCourseName(String value) { this.course_name = value; return this; }
        public String getTitle() { return title; }
        public CourseCreateRequest setTitle(String value) { this.title = value; return this; }
        public String getPrettyTitle() { return pretty_title; }
        public CourseCreateRequest setPrettyTitle(String value) { this.pretty_title = value; return this; }
        public String getCourseDescription() { return course_description; }
        public CourseCreateRequest setCourseDescription(String value) { this.course_description = value; return this; }
        public Boolean getIsActive() { return is_active; }
        public CourseCreateRequest setIsActive(Boolean value) { this.is_active = value; return this; }
        public ArrayList<CourseRequirementResponse> getCourseRequirements() { return course_requirements; }
        public CourseCreateRequest setCourseRequirements(ArrayList<CourseRequirementResponse> value) { this.course_requirements = value; return this; }
        public String getAuthorizingUuid() { return authorizing_uuid; }
        public CourseCreateRequest setAuthorizingUuid(String value) { this.authorizing_uuid = 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; }
    }

}

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