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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;

namespace regis.ClassLibrary.Requests
{
    public partial class InstitutionRelationshipRequest
    {
        public virtual int related_institution_id { get; set; }
        public virtual string relationship_type { get; set; }
        public virtual string notes { get; set; }
    }

    public partial class InstitutionRelationshipsUpdateRequest
    {
        public InstitutionRelationshipsUpdateRequest()
        {
            related_institutions = new List<InstitutionRelationshipRequest>{};
        }

        public virtual int institution_id { get; set; }
        public virtual List<InstitutionRelationshipRequest> related_institutions { get; set; }
        public virtual string authorizing_uuid { get; set; }
    }

}

C# InstitutionRelationshipsUpdateRequest DTOs

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

HTTP + CSV

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

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