Required role: | REGISUserRole |
POST | /correspondence |
---|
<?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 CorrespondenceRequestedResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var int */
public int $regent_id=0,
/** @var string|null */
public ?string $request_code=null,
/** @var string|null */
public ?string $request_description=null,
/** @var string|null */
public ?string $request_instance=null,
/** @var string|null */
public ?string $request_status=null,
/** @var DateTime|null */
public ?DateTime $request_date=null,
/** @var DateTime|null */
public ?DateTime $request_assigned_date=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['request_code'])) $this->request_code = $o['request_code'];
if (isset($o['request_description'])) $this->request_description = $o['request_description'];
if (isset($o['request_instance'])) $this->request_instance = $o['request_instance'];
if (isset($o['request_status'])) $this->request_status = $o['request_status'];
if (isset($o['request_date'])) $this->request_date = JsonConverters::from('DateTime', $o['request_date']);
if (isset($o['request_assigned_date'])) $this->request_assigned_date = JsonConverters::from('DateTime', $o['request_assigned_date']);
}
/** @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->request_code)) $o['request_code'] = $this->request_code;
if (isset($this->request_description)) $o['request_description'] = $this->request_description;
if (isset($this->request_instance)) $o['request_instance'] = $this->request_instance;
if (isset($this->request_status)) $o['request_status'] = $this->request_status;
if (isset($this->request_date)) $o['request_date'] = JsonConverters::to('DateTime', $this->request_date);
if (isset($this->request_assigned_date)) $o['request_assigned_date'] = JsonConverters::to('DateTime', $this->request_assigned_date);
return empty($o) ? new class(){} : $o;
}
}
class CorrespondenceRequestedRequest implements JsonSerializable
{
public function __construct(
/** @var int */
public int $pid=0,
/** @var string|null */
public ?string $token=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['pid'])) $this->pid = $o['pid'];
if (isset($o['token'])) $this->token = $o['token'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->pid)) $o['pid'] = $this->pid;
if (isset($this->token)) $o['token'] = $this->token;
return empty($o) ? new class(){} : $o;
}
}
PHP CorrespondenceRequestedRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /correspondence HTTP/1.1
Host: data.regent-college.edu
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"pid":0,"token":"String"}
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"}},"regent_id":0,"request_code":"String","request_description":"String","request_instance":"String","request_status":"String","request_date":"0001-01-01T00:00:00.0000000","request_assigned_date":"0001-01-01T00:00:00.0000000"}