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

HTTP + OTHER

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

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