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

export class InstitutionRelationshipRequest
{
    public related_institution_id: number;
    public relationship_type: string;
    public notes: string;

    public constructor(init?: Partial<InstitutionRelationshipRequest>) { (Object as any).assign(this, init); }
}

export class InstitutionRelationshipsUpdateRequest
{
    public institution_id: number;
    public related_institutions: InstitutionRelationshipRequest[];
    public authorizing_uuid: string;

    public constructor(init?: Partial<InstitutionRelationshipsUpdateRequest>) { (Object as any).assign(this, init); }
}

TypeScript InstitutionRelationshipsUpdateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
Content-Length: length

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