regis

<back to all web services

InstitutionCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/Institution/Create
namespace regis.ClassLibrary.Requests

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

    [<AllowNullLiteral>]
    type InstitutionResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val institution_id:Int32 = new Int32() with get,set
        member val institution_name:String = null with get,set
        member val institution_previous_names:String = null with get,set
        member val institution_other_names:String = null with get,set
        member val institution_type:String = null with get,set
        member val accreditation_status:String = null with get,set
        member val accreditation_status_notes:String = null with get,set
        member val related_institutions:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val accreditation_status_changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val gpa_conversion:String = null with get,set
        member val credit_hour_conversion:String = null with get,set
        member val addr1:String = null with get,set
        member val addr2:String = null with get,set
        member val city:String = null with get,set
        member val state:String = null with get,set
        member val country:String = null with get,set
        member val zip:String = null with get,set

    [<AllowNullLiteral>]
    type InstitutionCreateRequest() = 
        member val institution_name:String = null with get,set
        member val institution_other_names:String = null with get,set
        member val institution_previous_names:String = null with get,set
        member val institution_type:String = null with get,set
        member val accreditation_status:String = null with get,set
        member val accreditation_status_notes:String = null with get,set
        member val accreditation_status_changed_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val gpa_conversion:String = null with get,set
        member val credit_hour_conversion:String = null with get,set
        member val authorizing_uuid:String = null with get,set

F# InstitutionCreateRequest 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/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"institution_name":"String","institution_other_names":"String","institution_previous_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"institution_id":0,"institution_name":"String","institution_previous_names":"String","institution_other_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","related_institutions":["String"],"accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","zip":"String"}