regis

<back to all web services

GradesRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Grades
"use strict";
export class GradeResponse {
    /** @param {{responseStatus?:ResponseStatus,id?:number,grade_code?:string,grade_name?:string,grade_points?:number,gpa_credit?:boolean,completed_credit?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    id;
    /** @type {string} */
    grade_code;
    /** @type {string} */
    grade_name;
    /** @type {number} */
    grade_points;
    /** @type {boolean} */
    gpa_credit;
    /** @type {boolean} */
    completed_credit;
}
export class GradesResponse {
    /** @param {{responseStatus?:ResponseStatus,grades?:GradeResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {GradeResponse[]} */
    grades;
}
export class GradesRequest {
    constructor(init) { Object.assign(this, init) }
}

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

{
	
}
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
		}
	},
	grades: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			id: 0,
			grade_code: String,
			grade_name: String,
			grade_points: 0,
			gpa_credit: False,
			completed_credit: False
		}
	]
}