regis

<back to all web services

TermRequest

Requires Authentication
Required permission:ReadTerm
The following routes are available for this service:
POST/Terms/{term}
"use strict";
export class TermResponse {
    /** @param {{responseStatus?:ResponseStatus,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,number_of_sections?:number,number_of_rates?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @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 {number} */
    number_of_sections;
    /** @type {number} */
    number_of_rates;
}
export class TermRequest {
    /** @param {{term?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    term;
}

JavaScript TermRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Terms/{term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"term":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"term":"String","reporting_term":"String","reporting_year":0,"description":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","registration_start_date":"0001-01-01T00:00:00.0000000","registration_end_date":"0001-01-01T00:00:00.0000000","drop_start_date":"0001-01-01T00:00:00.0000000","drop_end_date":"0001-01-01T00:00:00.0000000","add_start_date":"0001-01-01T00:00:00.0000000","add_end_date":"0001-01-01T00:00:00.0000000","grading_end_date":"0001-01-01T00:00:00.0000000","number_of_sections":0,"number_of_rates":0}