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}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class TermStatementRequest
    {
        public String uuid = null;
        public String reporting_term = null;
        public String authorizing_uuid = null;
        
        public String getUuid() { return uuid; }
        public TermStatementRequest setUuid(String value) { this.uuid = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public TermStatementRequest setReportingTerm(String value) { this.reporting_term = value; return this; }
        public String getAuthorizingUuid() { return authorizing_uuid; }
        public TermStatementRequest setAuthorizingUuid(String value) { this.authorizing_uuid = value; return this; }
    }

    public static class TermStatementResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public String uuid = null;
        public String name = null;
        public String addr1 = null;
        public String addr2 = null;
        public String city = null;
        public String state = null;
        public String country = null;
        public String code = null;
        public String reporting_term = null;
        public Date reporting_term_start_date = null;
        public Date reporting_term_end_date = null;
        public String academic_program = null;
        public BigDecimal total_term_payments = null;
        public BigDecimal total_term_charges = null;
        public BigDecimal total_term_taxes = null;
        public ArrayList<TermStatementRegistrationResponse> registrations = null;
        public ArrayList<TermStatementChargesResponse> charges = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public TermStatementResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public TermStatementResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public TermStatementResponse setUuid(String value) { this.uuid = value; return this; }
        public String getName() { return name; }
        public TermStatementResponse setName(String value) { this.name = value; return this; }
        public String getAddr1() { return addr1; }
        public TermStatementResponse setAddr1(String value) { this.addr1 = value; return this; }
        public String getAddr2() { return addr2; }
        public TermStatementResponse setAddr2(String value) { this.addr2 = value; return this; }
        public String getCity() { return city; }
        public TermStatementResponse setCity(String value) { this.city = value; return this; }
        public String getState() { return state; }
        public TermStatementResponse setState(String value) { this.state = value; return this; }
        public String getCountry() { return country; }
        public TermStatementResponse setCountry(String value) { this.country = value; return this; }
        public String getCode() { return code; }
        public TermStatementResponse setCode(String value) { this.code = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public TermStatementResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
        public Date getReportingTermStartDate() { return reporting_term_start_date; }
        public TermStatementResponse setReportingTermStartDate(Date value) { this.reporting_term_start_date = value; return this; }
        public Date getReportingTermEndDate() { return reporting_term_end_date; }
        public TermStatementResponse setReportingTermEndDate(Date value) { this.reporting_term_end_date = value; return this; }
        public String getAcademicProgram() { return academic_program; }
        public TermStatementResponse setAcademicProgram(String value) { this.academic_program = value; return this; }
        public BigDecimal getTotalTermPayments() { return total_term_payments; }
        public TermStatementResponse setTotalTermPayments(BigDecimal value) { this.total_term_payments = value; return this; }
        public BigDecimal getTotalTermCharges() { return total_term_charges; }
        public TermStatementResponse setTotalTermCharges(BigDecimal value) { this.total_term_charges = value; return this; }
        public BigDecimal getTotalTermTaxes() { return total_term_taxes; }
        public TermStatementResponse setTotalTermTaxes(BigDecimal value) { this.total_term_taxes = value; return this; }
        public ArrayList<TermStatementRegistrationResponse> getRegistrations() { return registrations; }
        public TermStatementResponse setRegistrations(ArrayList<TermStatementRegistrationResponse> value) { this.registrations = value; return this; }
        public ArrayList<TermStatementChargesResponse> getCharges() { return charges; }
        public TermStatementResponse setCharges(ArrayList<TermStatementChargesResponse> value) { this.charges = value; return this; }
    }

    public static class TermStatementRegistrationResponse
    {
        public String course_name = null;
        public String title = null;
        public String section_code = null;
        public BigDecimal amount = null;
        public Boolean is_audit = null;
        public String meeting_days = null;
        public String times = null;
        public String room = null;
        public String instructor = null;
        public String status = null;
        public BigDecimal cost = null;
        public Date start_date = null;
        public Date end_date = null;
        
        public String getCourseName() { return course_name; }
        public TermStatementRegistrationResponse setCourseName(String value) { this.course_name = value; return this; }
        public String getTitle() { return title; }
        public TermStatementRegistrationResponse setTitle(String value) { this.title = value; return this; }
        public String getSectionCode() { return section_code; }
        public TermStatementRegistrationResponse setSectionCode(String value) { this.section_code = value; return this; }
        public BigDecimal getAmount() { return amount; }
        public TermStatementRegistrationResponse setAmount(BigDecimal value) { this.amount = value; return this; }
        public Boolean getIsAudit() { return is_audit; }
        public TermStatementRegistrationResponse setIsAudit(Boolean value) { this.is_audit = value; return this; }
        public String getMeetingDays() { return meeting_days; }
        public TermStatementRegistrationResponse setMeetingDays(String value) { this.meeting_days = value; return this; }
        public String getTimes() { return times; }
        public TermStatementRegistrationResponse setTimes(String value) { this.times = value; return this; }
        public String getRoom() { return room; }
        public TermStatementRegistrationResponse setRoom(String value) { this.room = value; return this; }
        public String getInstructor() { return instructor; }
        public TermStatementRegistrationResponse setInstructor(String value) { this.instructor = value; return this; }
        public String getStatus() { return status; }
        public TermStatementRegistrationResponse setStatus(String value) { this.status = value; return this; }
        public BigDecimal getCost() { return cost; }
        public TermStatementRegistrationResponse setCost(BigDecimal value) { this.cost = value; return this; }
        public Date getStartDate() { return start_date; }
        public TermStatementRegistrationResponse setStartDate(Date value) { this.start_date = value; return this; }
        public Date getEndDate() { return end_date; }
        public TermStatementRegistrationResponse setEndDate(Date value) { this.end_date = value; return this; }
    }

    public static class TermStatementChargesResponse
    {
        public Date date = null;
        public String code = null;
        public String description = null;
        public Boolean is_financial_aid = null;
        public BigDecimal charge = null;
        
        public Date getDate() { return date; }
        public TermStatementChargesResponse setDate(Date value) { this.date = value; return this; }
        public String getCode() { return code; }
        public TermStatementChargesResponse setCode(String value) { this.code = value; return this; }
        public String getDescription() { return description; }
        public TermStatementChargesResponse setDescription(String value) { this.description = value; return this; }
        public Boolean getIsFinancialAid() { return is_financial_aid; }
        public TermStatementChargesResponse setIsFinancialAid(Boolean value) { this.is_financial_aid = value; return this; }
        public BigDecimal getCharge() { return charge; }
        public TermStatementChargesResponse setCharge(BigDecimal value) { this.charge = value; return this; }
    }

}

Java TermStatementRequest DTOs

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

HTTP + JSV

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

{
	uuid: String,
	reporting_term: String,
	authorizing_uuid: 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
		}
	},
	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-01,
	reporting_term_end_date: 0001-01-01,
	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-01,
			end_date: 0001-01-01
		}
	],
	charges: 
	[
		{
			date: 0001-01-01,
			code: String,
			description: String,
			is_financial_aid: False,
			charge: 0
		}
	]
}