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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<InstitutionCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <accreditation_status>String</accreditation_status>
  <accreditation_status_changed_date>0001-01-01T00:00:00</accreditation_status_changed_date>
  <accreditation_status_notes>String</accreditation_status_notes>
  <authorizing_uuid>String</authorizing_uuid>
  <credit_hour_conversion>String</credit_hour_conversion>
  <gpa_conversion>String</gpa_conversion>
  <institution_name>String</institution_name>
  <institution_other_names>String</institution_other_names>
  <institution_previous_names>String</institution_previous_names>
  <institution_type>String</institution_type>
</InstitutionCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InstitutionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <accreditation_status>String</accreditation_status>
  <accreditation_status_changed_date>0001-01-01T00:00:00</accreditation_status_changed_date>
  <accreditation_status_notes>String</accreditation_status_notes>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <city>String</city>
  <country>String</country>
  <credit_hour_conversion>String</credit_hour_conversion>
  <gpa_conversion>String</gpa_conversion>
  <institution_id>0</institution_id>
  <institution_name>String</institution_name>
  <institution_other_names>String</institution_other_names>
  <institution_previous_names>String</institution_previous_names>
  <institution_type>String</institution_type>
  <related_institutions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </related_institutions>
  <state>String</state>
  <zip>String</zip>
</InstitutionResponse>