regis

<back to all web services

AcademicSummaryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/{uuid}/Summary
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class AcademicSummaryRequest
    {
        public String uuid = null;
        
        public String getUuid() { return uuid; }
        public AcademicSummaryRequest setUuid(String value) { this.uuid = value; return this; }
    }

    public static class AcademicSummaryResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public String uuid = null;
        public BigDecimal gpa = null;
        public ArrayList<StudentProgramSimpleResponse> student_programs = null;
        public String unofficial_undergraduate_degree_description = null;
        public ArrayList<String> messages = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public AcademicSummaryResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public AcademicSummaryResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public AcademicSummaryResponse setUuid(String value) { this.uuid = value; return this; }
        public BigDecimal getGpa() { return gpa; }
        public AcademicSummaryResponse setGpa(BigDecimal value) { this.gpa = value; return this; }
        public ArrayList<StudentProgramSimpleResponse> getStudentPrograms() { return student_programs; }
        public AcademicSummaryResponse setStudentPrograms(ArrayList<StudentProgramSimpleResponse> value) { this.student_programs = value; return this; }
        public String getUnofficialUndergraduateDegreeDescription() { return unofficial_undergraduate_degree_description; }
        public AcademicSummaryResponse setUnofficialUndergraduateDegreeDescription(String value) { this.unofficial_undergraduate_degree_description = value; return this; }
        public ArrayList<String> getMessages() { return messages; }
        public AcademicSummaryResponse setMessages(ArrayList<String> value) { this.messages = value; return this; }
    }

    public static class StudentProgramSimpleResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public String uuid = null;
        public Integer program_id = null;
        public String program_code = null;
        public String program_name = null;
        public String concentration_code = null;
        public String concentration_name = null;
        public Date start_date = null;
        public Date end_date = null;
        public String catalog = null;
        public Boolean is_active = null;
        public Boolean is_graduated = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public StudentProgramSimpleResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public StudentProgramSimpleResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public StudentProgramSimpleResponse setUuid(String value) { this.uuid = value; return this; }
        public Integer getProgramId() { return program_id; }
        public StudentProgramSimpleResponse setProgramId(Integer value) { this.program_id = value; return this; }
        public String getProgramCode() { return program_code; }
        public StudentProgramSimpleResponse setProgramCode(String value) { this.program_code = value; return this; }
        public String getProgramName() { return program_name; }
        public StudentProgramSimpleResponse setProgramName(String value) { this.program_name = value; return this; }
        public String getConcentrationCode() { return concentration_code; }
        public StudentProgramSimpleResponse setConcentrationCode(String value) { this.concentration_code = value; return this; }
        public String getConcentrationName() { return concentration_name; }
        public StudentProgramSimpleResponse setConcentrationName(String value) { this.concentration_name = value; return this; }
        public Date getStartDate() { return start_date; }
        public StudentProgramSimpleResponse setStartDate(Date value) { this.start_date = value; return this; }
        public Date getEndDate() { return end_date; }
        public StudentProgramSimpleResponse setEndDate(Date value) { this.end_date = value; return this; }
        public String getCatalog() { return catalog; }
        public StudentProgramSimpleResponse setCatalog(String value) { this.catalog = value; return this; }
        public Boolean getIsActive() { return is_active; }
        public StudentProgramSimpleResponse setIsActive(Boolean value) { this.is_active = value; return this; }
        public Boolean getIsGraduated() { return is_graduated; }
        public StudentProgramSimpleResponse setIsGraduated(Boolean value) { this.is_graduated = value; return this; }
    }

}

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

{
	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,
	gpa: 0,
	student_programs: 
	[
		{
			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,
			program_id: 0,
			program_code: String,
			program_name: String,
			concentration_code: String,
			concentration_name: String,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			catalog: String,
			is_active: False,
			is_graduated: False
		}
	],
	unofficial_undergraduate_degree_description: String,
	messages: 
	[
		String
	]
}