Required role: | REGISUserRole |
POST | /Terms/Create |
---|
"use strict";
export class TermCreateRequest {
/** @param {{authorizing_uuid?:string,term?:string,reporting_term?:string,reporting_year?:number,description?:string,start_date?:string,end_date?:string,registration_start_date?:string,registration_end_date?:string,drop_start_date?:string,drop_end_date?:string,add_start_date?:string,add_end_date?:string,grading_end_date?:string,duplicate_rates_from_previous_reporting_term?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
authorizing_uuid;
/** @type {string} */
term;
/** @type {string} */
reporting_term;
/** @type {number} */
reporting_year;
/** @type {string} */
description;
/** @type {?string} */
start_date;
/** @type {?string} */
end_date;
/** @type {?string} */
registration_start_date;
/** @type {?string} */
registration_end_date;
/** @type {?string} */
drop_start_date;
/** @type {?string} */
drop_end_date;
/** @type {?string} */
add_start_date;
/** @type {?string} */
add_end_date;
/** @type {?string} */
grading_end_date;
/** @type {string} */
duplicate_rates_from_previous_reporting_term;
}
JavaScript TermCreateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Terms/Create HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
authorizing_uuid: String,
term: String,
reporting_term: String,
reporting_year: 0,
description: String,
start_date: 0001-01-01,
end_date: 0001-01-01,
registration_start_date: 0001-01-01,
registration_end_date: 0001-01-01,
drop_start_date: 0001-01-01,
drop_end_date: 0001-01-01,
add_start_date: 0001-01-01,
add_end_date: 0001-01-01,
grading_end_date: 0001-01-01,
duplicate_rates_from_previous_reporting_term: 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 } }