regis

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<TermRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <term>String</term>
</TermRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TermResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <add_end_date>0001-01-01T00:00:00</add_end_date>
  <add_start_date>0001-01-01T00:00:00</add_start_date>
  <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>
  <number_of_rates>0</number_of_rates>
  <number_of_sections>0</number_of_sections>
  <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>
</TermResponse>