regis

PersonKeysRequest

**Requires Authentication**
Required role:	REGISUserRole

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

<?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 PersonKeysResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var array<PersonKeyResponse>|null */
        public ?array $personKeyResponses=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['personKeyResponses'])) $this->personKeyResponses = JsonConverters::fromArray('PersonKeyResponse', $o['personKeyResponses']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->personKeyResponses)) $o['personKeyResponses'] = JsonConverters::toArray('PersonKeyResponse', $this->personKeyResponses);
        return empty($o) ? new class(){} : $o;
    }
}

class PersonKeysRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP PersonKeysRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /person/keys/all HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"personKeyResponses":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"re_id":0,"sugar_id":"String","uuid":"String","student_id":0,"regent_login":"String"}]}