regis

<back to all web services

RegistrationAvailableRequest

Requires Authentication
Required permission:ReadRegistrationAvailability
The following routes are available for this service:
POST/Registration/{reporting_term}/Available
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class RegistrationAvailableRequest
    {
        public String reporting_term = null;
        public String first_name = null;
        public String last_name = null;
        public String email = null;
        public Date dob = null;
        public Integer regent_id = null;
        
        public String getReportingTerm() { return reporting_term; }
        public RegistrationAvailableRequest setReportingTerm(String value) { this.reporting_term = value; return this; }
        public String getFirstName() { return first_name; }
        public RegistrationAvailableRequest setFirstName(String value) { this.first_name = value; return this; }
        public String getLastName() { return last_name; }
        public RegistrationAvailableRequest setLastName(String value) { this.last_name = value; return this; }
        public String getEmail() { return email; }
        public RegistrationAvailableRequest setEmail(String value) { this.email = value; return this; }
        public Date getDob() { return dob; }
        public RegistrationAvailableRequest setDob(Date value) { this.dob = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public RegistrationAvailableRequest setRegentId(Integer value) { this.regent_id = value; return this; }
    }

    public static class RegistrationAvailableResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public Boolean birthdate_exists = null;
        public Boolean birthdate_matches = null;
        public Boolean has_regent_login = null;
        public Boolean is_a_regis_person = null;
        public Boolean is_a_sugar_person = null;
        public Boolean term_is_available = null;
        public Boolean blocked_in_regis = null;
        public Boolean email_matches = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public RegistrationAvailableResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public RegistrationAvailableResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public Boolean isBirthdateExists() { return birthdate_exists; }
        public RegistrationAvailableResponse setBirthdateExists(Boolean value) { this.birthdate_exists = value; return this; }
        public Boolean isBirthdateMatches() { return birthdate_matches; }
        public RegistrationAvailableResponse setBirthdateMatches(Boolean value) { this.birthdate_matches = value; return this; }
        public Boolean isHasRegentLogin() { return has_regent_login; }
        public RegistrationAvailableResponse setHasRegentLogin(Boolean value) { this.has_regent_login = value; return this; }
        public Boolean getIsARegisPerson() { return is_a_regis_person; }
        public RegistrationAvailableResponse setIsARegisPerson(Boolean value) { this.is_a_regis_person = value; return this; }
        public Boolean getIsASugarPerson() { return is_a_sugar_person; }
        public RegistrationAvailableResponse setIsASugarPerson(Boolean value) { this.is_a_sugar_person = value; return this; }
        public Boolean isTermIsAvailable() { return term_is_available; }
        public RegistrationAvailableResponse setTermIsAvailable(Boolean value) { this.term_is_available = value; return this; }
        public Boolean isBlockedInRegis() { return blocked_in_regis; }
        public RegistrationAvailableResponse setBlockedInRegis(Boolean value) { this.blocked_in_regis = value; return this; }
        public Boolean isEmailMatches() { return email_matches; }
        public RegistrationAvailableResponse setEmailMatches(Boolean value) { this.email_matches = value; return this; }
    }

}

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

{
	reporting_term: String,
	first_name: String,
	last_name: String,
	email: String,
	dob: 0001-01-01,
	regent_id: 0
}
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,
	birthdate_exists: False,
	birthdate_matches: False,
	has_regent_login: False,
	is_a_regis_person: False,
	is_a_sugar_person: False,
	term_is_available: False,
	blocked_in_regis: False,
	email_matches: False
}