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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<RegistrationAvailableRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <dob>0001-01-01T00:00:00</dob>
  <email>String</email>
  <first_name>String</first_name>
  <last_name>String</last_name>
  <regent_id>0</regent_id>
  <reporting_term>String</reporting_term>
</RegistrationAvailableRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegistrationAvailableResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <birthdate_exists>false</birthdate_exists>
  <birthdate_matches>false</birthdate_matches>
  <blocked_in_regis>false</blocked_in_regis>
  <email_matches>false</email_matches>
  <has_regent_login>false</has_regent_login>
  <is_a_regis_person>false</is_a_regis_person>
  <is_a_sugar_person>false</is_a_sugar_person>
  <regent_id>0</regent_id>
  <term_is_available>false</term_is_available>
</RegistrationAvailableResponse>