| Required permission: | ReadTerm |
| POST | /Terms/{term} |
|---|
export class TermResponse
{
public responseStatus: ResponseStatus;
public term: string;
public reporting_term: string;
public reporting_year: number;
public description: string;
public start_date?: string;
public end_date?: string;
public registration_start_date?: string;
public registration_end_date?: string;
public drop_start_date?: string;
public drop_end_date?: string;
public add_start_date?: string;
public add_end_date?: string;
public grading_end_date?: string;
public number_of_sections: number;
public number_of_rates: number;
public constructor(init?: Partial<TermResponse>) { (Object as any).assign(this, init); }
}
export class TermRequest
{
public term: string;
public constructor(init?: Partial<TermRequest>) { (Object as any).assign(this, init); }
}
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/{term} HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
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
}
},
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,
number_of_sections: 0,
number_of_rates: 0
}