regis

InstitutionRelationshipsUpdateRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Academic/Institution/{institution_id}/UpdateRelationships

"use strict";
export class InstitutionRelationshipRequest {
    /** @param {{related_institution_id?:number,relationship_type?:string,notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    related_institution_id;
    /** @type {string} */
    relationship_type;
    /** @type {string} */
    notes;
}
export class InstitutionRelationshipsUpdateRequest {
    /** @param {{institution_id?:number,related_institutions?:InstitutionRelationshipRequest[],authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    institution_id;
    /** @type {InstitutionRelationshipRequest[]} */
    related_institutions;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript 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>