regis

InstitutionRelationshipsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Academic/Institution/{institution_id}

<?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 InstitutionRelationshipsRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $institution_id=0
    ) {
    }

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

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

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

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

<ArrayOfInstitutionRelationshipResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <InstitutionRelationshipResponse>
    <notes>String</notes>
    <related_institution_id>0</related_institution_id>
    <related_institution_name>String</related_institution_name>
    <relationship_type>String</relationship_type>
  </InstitutionRelationshipResponse>
</ArrayOfInstitutionRelationshipResponse>