regis

PersonKeyRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/person/keys

<?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 PersonKeyResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var int */
        public int $regent_id=0,
        /** @var int */
        public int $re_id=0,
        /** @var string|null */
        public ?string $sugar_id=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var int|null */
        public ?int $student_id=null,
        /** @var string|null */
        public ?string $regent_login=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['re_id'])) $this->re_id = $o['re_id'];
        if (isset($o['sugar_id'])) $this->sugar_id = $o['sugar_id'];
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['student_id'])) $this->student_id = $o['student_id'];
        if (isset($o['regent_login'])) $this->regent_login = $o['regent_login'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->re_id)) $o['re_id'] = $this->re_id;
        if (isset($this->sugar_id)) $o['sugar_id'] = $this->sugar_id;
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->student_id)) $o['student_id'] = $this->student_id;
        if (isset($this->regent_login)) $o['regent_login'] = $this->regent_login;
        return empty($o) ? new class(){} : $o;
    }
}

class PersonKeyRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $regent_login=null,
        /** @var string|null */
        public ?string $regent_network_login=null
    ) {
    }

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

PHP PersonKeyRequest 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 /person/keys HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PersonKeyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <regent_id>0</regent_id>
  <regent_login>String</regent_login>
  <regent_network_login>String</regent_network_login>
  <uuid>String</uuid>
</PersonKeyRequest>

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

<PersonKeyResponse 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>
  <re_id>0</re_id>
  <regent_id>0</regent_id>
  <regent_login>String</regent_login>
  <student_id>0</student_id>
  <sugar_id>String</sugar_id>
  <uuid>String</uuid>
</PersonKeyResponse>