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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	institution_name: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
		gpa_conversion: String,
		credit_hour_conversion: String,
		addr1: String,
		addr2: String,
		city: String,
		state: String,
		country: String,
		zip: String
	}
]