regis

<back to all web services

RegistrationInProgressSummaryRequest

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

public class dtos
{

    public static class RegistrationInProgressSummaryRequest
    {
        public String uuid = null;
        public String transaction_uuid = null;
        public String reporting_term = null;
        public Boolean online_only = null;
        
        public String getUuid() { return uuid; }
        public RegistrationInProgressSummaryRequest setUuid(String value) { this.uuid = value; return this; }
        public String getTransactionUuid() { return transaction_uuid; }
        public RegistrationInProgressSummaryRequest setTransactionUuid(String value) { this.transaction_uuid = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public RegistrationInProgressSummaryRequest setReportingTerm(String value) { this.reporting_term = value; return this; }
        public Boolean isOnlineOnly() { return online_only; }
        public RegistrationInProgressSummaryRequest setOnlineOnly(Boolean value) { this.online_only = value; return this; }
    }

    public static class RegistrationInProgressSummaryResponse
    {
        public ResponseStatus responseStatus = null;
        public String transaction_uuid = null;
        public Integer regent_id = null;
        public String uuid = null;
        public String reporting_term = null;
        public Integer numberOfStudentSections = null;
        public BigDecimal amountOwing = null;
        public Boolean mustPayBeforeRegistering = null;
        public ArrayList<RegistrationDocumentResponse> requiredDocuments = null;
        public ArrayList<RegistrationDocumentResponse> completedDocuments = null;
        public Boolean isLate = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public RegistrationInProgressSummaryResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getTransactionUuid() { return transaction_uuid; }
        public RegistrationInProgressSummaryResponse setTransactionUuid(String value) { this.transaction_uuid = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public RegistrationInProgressSummaryResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public RegistrationInProgressSummaryResponse setUuid(String value) { this.uuid = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public RegistrationInProgressSummaryResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
        public Integer getNumberOfStudentSections() { return numberOfStudentSections; }
        public RegistrationInProgressSummaryResponse setNumberOfStudentSections(Integer value) { this.numberOfStudentSections = value; return this; }
        public BigDecimal getAmountOwing() { return amountOwing; }
        public RegistrationInProgressSummaryResponse setAmountOwing(BigDecimal value) { this.amountOwing = value; return this; }
        public Boolean isMustPayBeforeRegistering() { return mustPayBeforeRegistering; }
        public RegistrationInProgressSummaryResponse setMustPayBeforeRegistering(Boolean value) { this.mustPayBeforeRegistering = value; return this; }
        public ArrayList<RegistrationDocumentResponse> getRequiredDocuments() { return requiredDocuments; }
        public RegistrationInProgressSummaryResponse setRequiredDocuments(ArrayList<RegistrationDocumentResponse> value) { this.requiredDocuments = value; return this; }
        public ArrayList<RegistrationDocumentResponse> getCompletedDocuments() { return completedDocuments; }
        public RegistrationInProgressSummaryResponse setCompletedDocuments(ArrayList<RegistrationDocumentResponse> value) { this.completedDocuments = value; return this; }
        public Boolean getIsLate() { return isLate; }
        public RegistrationInProgressSummaryResponse setIsLate(Boolean value) { this.isLate = value; return this; }
    }

    public static class RegistrationDocumentResponse
    {
        public String uuid = null;
        public Integer regent_id = null;
        public String first_name = null;
        public String last_name = null;
        public String gender = null;
        public String email = null;
        public String program = null;
        public String concentration = null;
        public String section_uuid = null;
        public String course_name = null;
        public String course_title = null;
        public String reporting_term = null;
        public String document_code = null;
        public String document_json = null;
        public String document_name = null;
        public String document_description = null;
        public Date added_date = null;
        public Date changed_date = null;
        
        public String getUuid() { return uuid; }
        public RegistrationDocumentResponse setUuid(String value) { this.uuid = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public RegistrationDocumentResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getFirstName() { return first_name; }
        public RegistrationDocumentResponse setFirstName(String value) { this.first_name = value; return this; }
        public String getLastName() { return last_name; }
        public RegistrationDocumentResponse setLastName(String value) { this.last_name = value; return this; }
        public String getGender() { return gender; }
        public RegistrationDocumentResponse setGender(String value) { this.gender = value; return this; }
        public String getEmail() { return email; }
        public RegistrationDocumentResponse setEmail(String value) { this.email = value; return this; }
        public String getProgram() { return program; }
        public RegistrationDocumentResponse setProgram(String value) { this.program = value; return this; }
        public String getConcentration() { return concentration; }
        public RegistrationDocumentResponse setConcentration(String value) { this.concentration = value; return this; }
        public String getSectionUuid() { return section_uuid; }
        public RegistrationDocumentResponse setSectionUuid(String value) { this.section_uuid = value; return this; }
        public String getCourseName() { return course_name; }
        public RegistrationDocumentResponse setCourseName(String value) { this.course_name = value; return this; }
        public String getCourseTitle() { return course_title; }
        public RegistrationDocumentResponse setCourseTitle(String value) { this.course_title = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public RegistrationDocumentResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
        public String getDocumentCode() { return document_code; }
        public RegistrationDocumentResponse setDocumentCode(String value) { this.document_code = value; return this; }
        public String getDocumentJson() { return document_json; }
        public RegistrationDocumentResponse setDocumentJson(String value) { this.document_json = value; return this; }
        public String getDocumentName() { return document_name; }
        public RegistrationDocumentResponse setDocumentName(String value) { this.document_name = value; return this; }
        public String getDocumentDescription() { return document_description; }
        public RegistrationDocumentResponse setDocumentDescription(String value) { this.document_description = value; return this; }
        public Date getAddedDate() { return added_date; }
        public RegistrationDocumentResponse setAddedDate(Date value) { this.added_date = value; return this; }
        public Date getChangedDate() { return changed_date; }
        public RegistrationDocumentResponse setChangedDate(Date value) { this.changed_date = value; return this; }
    }

}

Java RegistrationInProgressSummaryRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Registration/InProgressSummary/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String","transaction_uuid":"String","reporting_term":"String","online_only":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"transaction_uuid":"String","regent_id":0,"uuid":"String","reporting_term":"String","numberOfStudentSections":0,"amountOwing":0,"mustPayBeforeRegistering":false,"requiredDocuments":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"completedDocuments":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"isLate":false}