regis

<back to all web services

TermRequest

Requires Authentication
Required permission:ReadTerm
The following routes are available for this service:
POST/Terms/{term}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class TermRequest
    {
        public String term = null;
        
        public String getTerm() { return term; }
        public TermRequest setTerm(String value) { this.term = value; return this; }
    }

    public static class TermResponse
    {
        public ResponseStatus responseStatus = null;
        public String term = null;
        public String reporting_term = null;
        public Integer reporting_year = null;
        public String description = null;
        public Date start_date = null;
        public Date end_date = null;
        public Date registration_start_date = null;
        public Date registration_end_date = null;
        public Date drop_start_date = null;
        public Date drop_end_date = null;
        public Date add_start_date = null;
        public Date add_end_date = null;
        public Date grading_end_date = null;
        public Integer number_of_sections = null;
        public Integer number_of_rates = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public TermResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getTerm() { return term; }
        public TermResponse setTerm(String value) { this.term = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public TermResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
        public Integer getReportingYear() { return reporting_year; }
        public TermResponse setReportingYear(Integer value) { this.reporting_year = value; return this; }
        public String getDescription() { return description; }
        public TermResponse setDescription(String value) { this.description = value; return this; }
        public Date getStartDate() { return start_date; }
        public TermResponse setStartDate(Date value) { this.start_date = value; return this; }
        public Date getEndDate() { return end_date; }
        public TermResponse setEndDate(Date value) { this.end_date = value; return this; }
        public Date getRegistrationStartDate() { return registration_start_date; }
        public TermResponse setRegistrationStartDate(Date value) { this.registration_start_date = value; return this; }
        public Date getRegistrationEndDate() { return registration_end_date; }
        public TermResponse setRegistrationEndDate(Date value) { this.registration_end_date = value; return this; }
        public Date getDropStartDate() { return drop_start_date; }
        public TermResponse setDropStartDate(Date value) { this.drop_start_date = value; return this; }
        public Date getDropEndDate() { return drop_end_date; }
        public TermResponse setDropEndDate(Date value) { this.drop_end_date = value; return this; }
        public Date getAddStartDate() { return add_start_date; }
        public TermResponse setAddStartDate(Date value) { this.add_start_date = value; return this; }
        public Date getAddEndDate() { return add_end_date; }
        public TermResponse setAddEndDate(Date value) { this.add_end_date = value; return this; }
        public Date getGradingEndDate() { return grading_end_date; }
        public TermResponse setGradingEndDate(Date value) { this.grading_end_date = value; return this; }
        public Integer getNumberOfSections() { return number_of_sections; }
        public TermResponse setNumberOfSections(Integer value) { this.number_of_sections = value; return this; }
        public Integer getNumberOfRates() { return number_of_rates; }
        public TermResponse setNumberOfRates(Integer value) { this.number_of_rates = value; return this; }
    }

}

Java TermRequest 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 /Terms/{term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	term: 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
		}
	},
	term: String,
	reporting_term: String,
	reporting_year: 0,
	description: String,
	start_date: 0001-01-01,
	end_date: 0001-01-01,
	registration_start_date: 0001-01-01,
	registration_end_date: 0001-01-01,
	drop_start_date: 0001-01-01,
	drop_end_date: 0001-01-01,
	add_start_date: 0001-01-01,
	add_end_date: 0001-01-01,
	grading_end_date: 0001-01-01,
	number_of_sections: 0,
	number_of_rates: 0
}