regis

<back to all web services

CanIRegisterRequest

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

public class dtos
{

    public static class CanIRegisterRequest
    {
        public String uuid = null;
        public String term = null;
        public String reporting_term = null;
        
        public String getUuid() { return uuid; }
        public CanIRegisterRequest setUuid(String value) { this.uuid = value; return this; }
        public String getTerm() { return term; }
        public CanIRegisterRequest setTerm(String value) { this.term = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public CanIRegisterRequest setReportingTerm(String value) { this.reporting_term = value; return this; }
    }

    public static class CanIRegisterResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public String uuid = null;
        public String reporting_term = null;
        public BigDecimal maxCredits = null;
        public BigDecimal maxAudits = null;
        public ArrayList<String> messages = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CanIRegisterResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public CanIRegisterResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public CanIRegisterResponse setUuid(String value) { this.uuid = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public CanIRegisterResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
        public BigDecimal getMaxCredits() { return maxCredits; }
        public CanIRegisterResponse setMaxCredits(BigDecimal value) { this.maxCredits = value; return this; }
        public BigDecimal getMaxAudits() { return maxAudits; }
        public CanIRegisterResponse setMaxAudits(BigDecimal value) { this.maxAudits = value; return this; }
        public ArrayList<String> getMessages() { return messages; }
        public CanIRegisterResponse setMessages(ArrayList<String> value) { this.messages = value; return this; }
    }

}

Java CanIRegisterRequest 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/CanIRegister/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CanIRegisterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <reporting_term>String</reporting_term>
  <term>String</term>
  <uuid>String</uuid>
</CanIRegisterRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CanIRegisterResponse 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>
  <maxAudits>0</maxAudits>
  <maxCredits>0</maxCredits>
  <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </messages>
  <regent_id>0</regent_id>
  <reporting_term>String</reporting_term>
  <uuid>String</uuid>
</CanIRegisterResponse>