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
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type InstitutionRelationshipRequest() = 
        member val related_institution_id:Int32 = new Int32() with get,set
        member val relationship_type:String = null with get,set
        member val notes:String = null with get,set

    [<AllowNullLiteral>]
    type InstitutionRelationshipsUpdateRequest() = 
        member val institution_id:Int32 = new Int32() with get,set
        member val related_institutions:ResizeArray<InstitutionRelationshipRequest> = new ResizeArray<InstitutionRelationshipRequest>() with get,set
        member val authorizing_uuid:String = null with get,set

F# 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"}}