regis

<back to all web services

CourseRequirementsReportingTermRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Course/ReportingTerm/{reporting_term}/Requirements
CourseRequirementsReportingTermRequest Parameters:
NameParameterData TypeRequiredDescription
reporting_termpathstringNo

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

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