regis

<back to all web services

InstitutionUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/Institution/{institution_id}/Update
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class InstitutionUpdateRequest
    {
        public Integer institution_id = null;
        public String institution_name = null;
        public String institution_other_names = null;
        public String institution_previous_names = null;
        public String institution_type = null;
        public String accreditation_status = null;
        public String accreditation_status_notes = null;
        public Date accreditation_status_changed_date = null;
        public String gpa_conversion = null;
        public String credit_hour_conversion = null;
        public String authorizing_uuid = null;
        
        public Integer getInstitutionId() { return institution_id; }
        public InstitutionUpdateRequest setInstitutionId(Integer value) { this.institution_id = value; return this; }
        public String getInstitutionName() { return institution_name; }
        public InstitutionUpdateRequest setInstitutionName(String value) { this.institution_name = value; return this; }
        public String getInstitutionOtherNames() { return institution_other_names; }
        public InstitutionUpdateRequest setInstitutionOtherNames(String value) { this.institution_other_names = value; return this; }
        public String getInstitutionPreviousNames() { return institution_previous_names; }
        public InstitutionUpdateRequest setInstitutionPreviousNames(String value) { this.institution_previous_names = value; return this; }
        public String getInstitutionType() { return institution_type; }
        public InstitutionUpdateRequest setInstitutionType(String value) { this.institution_type = value; return this; }
        public String getAccreditationStatus() { return accreditation_status; }
        public InstitutionUpdateRequest setAccreditationStatus(String value) { this.accreditation_status = value; return this; }
        public String getAccreditationStatusNotes() { return accreditation_status_notes; }
        public InstitutionUpdateRequest setAccreditationStatusNotes(String value) { this.accreditation_status_notes = value; return this; }
        public Date getAccreditationStatusChangedDate() { return accreditation_status_changed_date; }
        public InstitutionUpdateRequest setAccreditationStatusChangedDate(Date value) { this.accreditation_status_changed_date = value; return this; }
        public String getGpaConversion() { return gpa_conversion; }
        public InstitutionUpdateRequest setGpaConversion(String value) { this.gpa_conversion = value; return this; }
        public String getCreditHourConversion() { return credit_hour_conversion; }
        public InstitutionUpdateRequest setCreditHourConversion(String value) { this.credit_hour_conversion = value; return this; }
        public String getAuthorizingUuid() { return authorizing_uuid; }
        public InstitutionUpdateRequest setAuthorizingUuid(String value) { this.authorizing_uuid = 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 InstitutionUpdateRequest 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 /Academic/Institution/{institution_id}/Update HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InstitutionUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <accreditation_status>String</accreditation_status>
  <accreditation_status_changed_date>0001-01-01T00:00:00</accreditation_status_changed_date>
  <accreditation_status_notes>String</accreditation_status_notes>
  <authorizing_uuid>String</authorizing_uuid>
  <credit_hour_conversion>String</credit_hour_conversion>
  <gpa_conversion>String</gpa_conversion>
  <institution_id>0</institution_id>
  <institution_name>String</institution_name>
  <institution_other_names>String</institution_other_names>
  <institution_previous_names>String</institution_previous_names>
  <institution_type>String</institution_type>
</InstitutionUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InstitutionResponse 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>
  <accreditation_status>String</accreditation_status>
  <accreditation_status_changed_date>0001-01-01T00:00:00</accreditation_status_changed_date>
  <accreditation_status_notes>String</accreditation_status_notes>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <city>String</city>
  <country>String</country>
  <credit_hour_conversion>String</credit_hour_conversion>
  <gpa_conversion>String</gpa_conversion>
  <institution_id>0</institution_id>
  <institution_name>String</institution_name>
  <institution_other_names>String</institution_other_names>
  <institution_previous_names>String</institution_previous_names>
  <institution_type>String</institution_type>
  <related_institutions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </related_institutions>
  <state>String</state>
  <zip>String</zip>
</InstitutionResponse>