regis

<back to all web services

InstitutionRelationshipsUpdateRequest

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

public class dtos
{

    public static class InstitutionRelationshipsUpdateRequest
    {
        public Integer institution_id = null;
        public ArrayList<InstitutionRelationshipRequest> related_institutions = null;
        public String authorizing_uuid = null;
        
        public Integer getInstitutionId() { return institution_id; }
        public InstitutionRelationshipsUpdateRequest setInstitutionId(Integer value) { this.institution_id = value; return this; }
        public ArrayList<InstitutionRelationshipRequest> getRelatedInstitutions() { return related_institutions; }
        public InstitutionRelationshipsUpdateRequest setRelatedInstitutions(ArrayList<InstitutionRelationshipRequest> value) { this.related_institutions = value; return this; }
        public String getAuthorizingUuid() { return authorizing_uuid; }
        public InstitutionRelationshipsUpdateRequest setAuthorizingUuid(String value) { this.authorizing_uuid = value; return this; }
    }

    public static class InstitutionRelationshipRequest
    {
        public Integer related_institution_id = null;
        public String relationship_type = null;
        public String notes = null;
        
        public Integer getRelatedInstitutionId() { return related_institution_id; }
        public InstitutionRelationshipRequest setRelatedInstitutionId(Integer value) { this.related_institution_id = value; return this; }
        public String getRelationshipType() { return relationship_type; }
        public InstitutionRelationshipRequest setRelationshipType(String value) { this.relationship_type = value; return this; }
        public String getNotes() { return notes; }
        public InstitutionRelationshipRequest setNotes(String value) { this.notes = value; return this; }
    }

}

Java InstitutionRelationshipsUpdateRequest 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}/UpdateRelationships HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InstitutionRelationshipsUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <institution_id>0</institution_id>
  <related_institutions>
    <InstitutionRelationshipRequest>
      <notes>String</notes>
      <related_institution_id>0</related_institution_id>
      <relationship_type>String</relationship_type>
    </InstitutionRelationshipRequest>
  </related_institutions>
</InstitutionRelationshipsUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>