Required role: | REGISUserRole |
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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<TermUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<add_end_date>0001-01-01T00:00:00</add_end_date>
<add_start_date>0001-01-01T00:00:00</add_start_date>
<authorizing_uuid>String</authorizing_uuid>
<description>String</description>
<drop_end_date>0001-01-01T00:00:00</drop_end_date>
<drop_start_date>0001-01-01T00:00:00</drop_start_date>
<end_date>0001-01-01T00:00:00</end_date>
<grading_end_date>0001-01-01T00:00:00</grading_end_date>
<registration_end_date>0001-01-01T00:00:00</registration_end_date>
<registration_start_date>0001-01-01T00:00:00</registration_start_date>
<reporting_term>String</reporting_term>
<reporting_year>0</reporting_year>
<start_date>0001-01-01T00:00:00</start_date>
<term>String</term>
</TermUpdateRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>String</d4p1:Key> <d4p1:Value>String</d4p1:Value> </d4p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> </ResponseStatus>