regis

<back to all web services

CoursesAdminRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Courses/Admin/{level}
CoursesAdminRequest Parameters:
NameParameterData TypeRequiredDescription
levelpathstringNo
CoursesAdminResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
coursesformList<CourseResponse>No
CourseResponse Parameters:
NameParameterData TypeRequiredDescription
idformint?No
course_nameformstringNo
titleformstringNo
pretty_titleformstringNo
course_descriptionformstringNo
is_activeformboolNo
added_dateformDateTime?No
added_byformstringNo
changed_dateformDateTime?No
changed_byformstringNo
timestampformDateTimeNo

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/{level} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	level: String
}
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
		}
	},
	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
		}
	]
}