regis

InstitutionsRequest

**Requires Authentication**
Required permission:	ReadInstitutions

The following routes are available for this service:
POST	/institutions/{institution_name}

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class InstitutionsRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $institution_name=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['institution_name'])) $this->institution_name = $o['institution_name'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->institution_name)) $o['institution_name'] = $this->institution_name;
        return empty($o) ? new class(){} : $o;
    }
}

PHP InstitutionsRequest 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 /institutions/{institution_name} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InstitutionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <institution_name>String</institution_name>
</InstitutionsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfInstitutionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <InstitutionResponse>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1: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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </related_institutions>
    <state>String</state>
    <zip>String</zip>
  </InstitutionResponse>
</ArrayOfInstitutionResponse>