regis

<back to all web services

InstitutionRelationshipsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/Institution/{institution_id}
"use strict";
export class InstitutionRelationshipsRequest {
    /** @param {{institution_id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    institution_id;
}

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

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

<ArrayOfInstitutionRelationshipResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <InstitutionRelationshipResponse>
    <notes>String</notes>
    <related_institution_id>0</related_institution_id>
    <related_institution_name>String</related_institution_name>
    <relationship_type>String</relationship_type>
  </InstitutionRelationshipResponse>
</ArrayOfInstitutionRelationshipResponse>