regis

<back to all web services

InstitutionCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/Institution/Create
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class InstitutionCreateRequest
    {
        public virtual string institution_name { get; set; }
        public virtual string institution_other_names { get; set; }
        public virtual string institution_previous_names { get; set; }
        public virtual string institution_type { get; set; }
        public virtual string accreditation_status { get; set; }
        public virtual string accreditation_status_notes { get; set; }
        public virtual DateTime? accreditation_status_changed_date { get; set; }
        public virtual string gpa_conversion { get; set; }
        public virtual string credit_hour_conversion { get; set; }
        public virtual string authorizing_uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class InstitutionResponse
    {
        public InstitutionResponse()
        {
            related_institutions = new List<string>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int institution_id { get; set; }
        public virtual string institution_name { get; set; }
        public virtual string institution_previous_names { get; set; }
        public virtual string institution_other_names { get; set; }
        public virtual string institution_type { get; set; }
        public virtual string accreditation_status { get; set; }
        public virtual string accreditation_status_notes { get; set; }
        public virtual List<string> related_institutions { get; set; }
        public virtual DateTime? accreditation_status_changed_date { get; set; }
        public virtual string gpa_conversion { get; set; }
        public virtual string credit_hour_conversion { get; set; }
        public virtual string addr1 { get; set; }
        public virtual string addr2 { get; set; }
        public virtual string city { get; set; }
        public virtual string state { get; set; }
        public virtual string country { get; set; }
        public virtual string zip { get; set; }
    }

}

C# InstitutionCreateRequest 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/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
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: application/json
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"}