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
import Foundation
import ServiceStack

public class InstitutionRelationshipsUpdateRequest : Codable
{
    public var institution_id:Int
    public var related_institutions:[InstitutionRelationshipRequest] = []
    public var authorizing_uuid:String

    required public init(){}
}

public class InstitutionRelationshipRequest : Codable
{
    public var related_institution_id:Int
    public var relationship_type:String
    public var notes:String

    required public init(){}
}


Swift 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"}}