regis

<back to all web services

TermStatementRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/TermStatements/{uuid}/{reporting_term}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class TermStatementRequest
    {
        public virtual string uuid { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual string authorizing_uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class TermStatementChargesResponse
    {
        public virtual DateTime date { get; set; }
        public virtual string code { get; set; }
        public virtual string description { get; set; }
        public virtual bool is_financial_aid { get; set; }
        public virtual decimal charge { get; set; }
    }

    public partial class TermStatementRegistrationResponse
    {
        public virtual string course_name { get; set; }
        public virtual string title { get; set; }
        public virtual string section_code { get; set; }
        public virtual decimal amount { get; set; }
        public virtual bool is_audit { get; set; }
        public virtual string meeting_days { get; set; }
        public virtual string times { get; set; }
        public virtual string room { get; set; }
        public virtual string instructor { get; set; }
        public virtual string status { get; set; }
        public virtual decimal cost { get; set; }
        public virtual DateTime? start_date { get; set; }
        public virtual DateTime? end_date { get; set; }
    }

    public partial class TermStatementResponse
    {
        public TermStatementResponse()
        {
            registrations = new List<TermStatementRegistrationResponse>{};
            charges = new List<TermStatementChargesResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string uuid { get; set; }
        public virtual string name { get; set; }
        public virtual string addr1 { get; set; }
        public virtual string addr2 { get; set; }
        public virtual string city { get; set; }
        public virtual string state { get; set; }
        public virtual string country { get; set; }
        public virtual string code { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual DateTime reporting_term_start_date { get; set; }
        public virtual DateTime reporting_term_end_date { get; set; }
        public virtual string academic_program { get; set; }
        public virtual decimal total_term_payments { get; set; }
        public virtual decimal total_term_charges { get; set; }
        public virtual decimal total_term_taxes { get; set; }
        public virtual List<TermStatementRegistrationResponse> registrations { get; set; }
        public virtual List<TermStatementChargesResponse> charges { get; set; }
    }

}

C# TermStatementRequest DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String","reporting_term":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","name":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","reporting_term":"String","reporting_term_start_date":"0001-01-01T00:00:00.0000000","reporting_term_end_date":"0001-01-01T00:00:00.0000000","academic_program":"String","total_term_payments":0,"total_term_charges":0,"total_term_taxes":0,"registrations":[{"course_name":"String","title":"String","section_code":"String","amount":0,"is_audit":false,"meeting_days":"String","times":"String","room":"String","instructor":"String","status":"String","cost":0,"start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000"}],"charges":[{"date":"0001-01-01T00:00:00.0000000","code":"String","description":"String","is_financial_aid":false,"charge":0}]}