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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	institution_id: 0,
	related_institutions: 
	[
		{
			related_institution_id: 0,
			relationship_type: String,
			notes: String
		}
	],
	authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}