regis

<back to all web services

TermUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Terms/{term}/Update
"use strict";
export class TermUpdateRequest {
    /** @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}} [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;
}

JavaScript TermUpdateRequest DTOs

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

HTTP + CSV

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

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

{"authorizing_uuid":"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"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}