regis

TermStatementRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/TermStatements/{uuid}/{reporting_term}

"use strict";
export class TermStatementRegistrationResponse {
    /** @param {{course_name?:string,title?:string,section_code?:string,amount?:number,is_audit?:boolean,meeting_days?:string,times?:string,room?:string,instructor?:string,status?:string,cost?:number,start_date?:string,end_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    course_name;
    /** @type {string} */
    title;
    /** @type {string} */
    section_code;
    /** @type {number} */
    amount;
    /** @type {boolean} */
    is_audit;
    /** @type {string} */
    meeting_days;
    /** @type {string} */
    times;
    /** @type {string} */
    room;
    /** @type {string} */
    instructor;
    /** @type {string} */
    status;
    /** @type {number} */
    cost;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
}
export class TermStatementChargesResponse {
    /** @param {{date?:string,code?:string,description?:string,is_financial_aid?:boolean,charge?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    date;
    /** @type {string} */
    code;
    /** @type {string} */
    description;
    /** @type {boolean} */
    is_financial_aid;
    /** @type {number} */
    charge;
}
export class TermStatementResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,name?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,reporting_term?:string,reporting_term_start_date?:string,reporting_term_end_date?:string,academic_program?:string,total_term_payments?:number,total_term_charges?:number,total_term_taxes?:number,registrations?:TermStatementRegistrationResponse[],charges?:TermStatementChargesResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    name;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    reporting_term_start_date;
    /** @type {string} */
    reporting_term_end_date;
    /** @type {string} */
    academic_program;
    /** @type {number} */
    total_term_payments;
    /** @type {number} */
    total_term_charges;
    /** @type {number} */
    total_term_taxes;
    /** @type {TermStatementRegistrationResponse[]} */
    registrations;
    /** @type {TermStatementChargesResponse[]} */
    charges;
}
export class TermStatementRequest {
    /** @param {{uuid?:string,reporting_term?:string,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript TermStatementRequest 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 /TermStatements/{uuid}/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<TermStatementResponse 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>
  <academic_program>String</academic_program>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <charges>
    <TermStatementChargesResponse>
      <charge>0</charge>
      <code>String</code>
      <date>0001-01-01T00:00:00</date>
      <description>String</description>
      <is_financial_aid>false</is_financial_aid>
    </TermStatementChargesResponse>
  </charges>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <name>String</name>
  <regent_id>0</regent_id>
  <registrations>
    <TermStatementRegistrationResponse>
      <amount>0</amount>
      <cost>0</cost>
      <course_name>String</course_name>
      <end_date>0001-01-01T00:00:00</end_date>
      <instructor>String</instructor>
      <is_audit>false</is_audit>
      <meeting_days>String</meeting_days>
      <room>String</room>
      <section_code>String</section_code>
      <start_date>0001-01-01T00:00:00</start_date>
      <status>String</status>
      <times>String</times>
      <title>String</title>
    </TermStatementRegistrationResponse>
  </registrations>
  <reporting_term>String</reporting_term>
  <reporting_term_end_date>0001-01-01T00:00:00</reporting_term_end_date>
  <reporting_term_start_date>0001-01-01T00:00:00</reporting_term_start_date>
  <state>String</state>
  <total_term_charges>0</total_term_charges>
  <total_term_payments>0</total_term_payments>
  <total_term_taxes>0</total_term_taxes>
  <uuid>String</uuid>
</TermStatementResponse>