regis

<back to all web services

InstitutionRequest

Requires Authentication
Required permission:ReadInstitutions
The following routes are available for this service:
POST/institutions
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class InstitutionRequest
    {
        public Integer institution_id = null;
        
        public Integer getInstitutionId() { return institution_id; }
        public InstitutionRequest setInstitutionId(Integer value) { this.institution_id = value; return this; }
    }

    public static class InstitutionResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer institution_id = null;
        public String institution_name = null;
        public String institution_previous_names = null;
        public String institution_other_names = null;
        public String institution_type = null;
        public String accreditation_status = null;
        public String accreditation_status_notes = null;
        public ArrayList<String> related_institutions = null;
        public Date accreditation_status_changed_date = null;
        public String gpa_conversion = null;
        public String credit_hour_conversion = null;
        public String addr1 = null;
        public String addr2 = null;
        public String city = null;
        public String state = null;
        public String country = null;
        public String zip = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public InstitutionResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getInstitutionId() { return institution_id; }
        public InstitutionResponse setInstitutionId(Integer value) { this.institution_id = value; return this; }
        public String getInstitutionName() { return institution_name; }
        public InstitutionResponse setInstitutionName(String value) { this.institution_name = value; return this; }
        public String getInstitutionPreviousNames() { return institution_previous_names; }
        public InstitutionResponse setInstitutionPreviousNames(String value) { this.institution_previous_names = value; return this; }
        public String getInstitutionOtherNames() { return institution_other_names; }
        public InstitutionResponse setInstitutionOtherNames(String value) { this.institution_other_names = value; return this; }
        public String getInstitutionType() { return institution_type; }
        public InstitutionResponse setInstitutionType(String value) { this.institution_type = value; return this; }
        public String getAccreditationStatus() { return accreditation_status; }
        public InstitutionResponse setAccreditationStatus(String value) { this.accreditation_status = value; return this; }
        public String getAccreditationStatusNotes() { return accreditation_status_notes; }
        public InstitutionResponse setAccreditationStatusNotes(String value) { this.accreditation_status_notes = value; return this; }
        public ArrayList<String> getRelatedInstitutions() { return related_institutions; }
        public InstitutionResponse setRelatedInstitutions(ArrayList<String> value) { this.related_institutions = value; return this; }
        public Date getAccreditationStatusChangedDate() { return accreditation_status_changed_date; }
        public InstitutionResponse setAccreditationStatusChangedDate(Date value) { this.accreditation_status_changed_date = value; return this; }
        public String getGpaConversion() { return gpa_conversion; }
        public InstitutionResponse setGpaConversion(String value) { this.gpa_conversion = value; return this; }
        public String getCreditHourConversion() { return credit_hour_conversion; }
        public InstitutionResponse setCreditHourConversion(String value) { this.credit_hour_conversion = value; return this; }
        public String getAddr1() { return addr1; }
        public InstitutionResponse setAddr1(String value) { this.addr1 = value; return this; }
        public String getAddr2() { return addr2; }
        public InstitutionResponse setAddr2(String value) { this.addr2 = value; return this; }
        public String getCity() { return city; }
        public InstitutionResponse setCity(String value) { this.city = value; return this; }
        public String getState() { return state; }
        public InstitutionResponse setState(String value) { this.state = value; return this; }
        public String getCountry() { return country; }
        public InstitutionResponse setCountry(String value) { this.country = value; return this; }
        public String getZip() { return zip; }
        public InstitutionResponse setZip(String value) { this.zip = value; return this; }
    }

}

Java InstitutionRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /institutions HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"institution_id":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"institution_id":0,"institution_name":"String","institution_previous_names":"String","institution_other_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","related_institutions":["String"],"accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","zip":"String"}