| Required permission: | ReadRegistrationAvailability |
| POST | /Registration/{reporting_term}/Available |
|---|
<?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 RegistrationAvailableResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var int|null */
public ?int $regent_id=null,
/** @var bool|null */
public ?bool $birthdate_exists=null,
/** @var bool|null */
public ?bool $birthdate_matches=null,
/** @var bool|null */
public ?bool $has_regent_login=null,
/** @var bool|null */
public ?bool $is_a_regis_person=null,
/** @var bool|null */
public ?bool $is_a_sugar_person=null,
/** @var bool|null */
public ?bool $term_is_available=null,
/** @var bool|null */
public ?bool $blocked_in_regis=null,
/** @var bool|null */
public ?bool $email_matches=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['birthdate_exists'])) $this->birthdate_exists = $o['birthdate_exists'];
if (isset($o['birthdate_matches'])) $this->birthdate_matches = $o['birthdate_matches'];
if (isset($o['has_regent_login'])) $this->has_regent_login = $o['has_regent_login'];
if (isset($o['is_a_regis_person'])) $this->is_a_regis_person = $o['is_a_regis_person'];
if (isset($o['is_a_sugar_person'])) $this->is_a_sugar_person = $o['is_a_sugar_person'];
if (isset($o['term_is_available'])) $this->term_is_available = $o['term_is_available'];
if (isset($o['blocked_in_regis'])) $this->blocked_in_regis = $o['blocked_in_regis'];
if (isset($o['email_matches'])) $this->email_matches = $o['email_matches'];
}
/** @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->birthdate_exists)) $o['birthdate_exists'] = $this->birthdate_exists;
if (isset($this->birthdate_matches)) $o['birthdate_matches'] = $this->birthdate_matches;
if (isset($this->has_regent_login)) $o['has_regent_login'] = $this->has_regent_login;
if (isset($this->is_a_regis_person)) $o['is_a_regis_person'] = $this->is_a_regis_person;
if (isset($this->is_a_sugar_person)) $o['is_a_sugar_person'] = $this->is_a_sugar_person;
if (isset($this->term_is_available)) $o['term_is_available'] = $this->term_is_available;
if (isset($this->blocked_in_regis)) $o['blocked_in_regis'] = $this->blocked_in_regis;
if (isset($this->email_matches)) $o['email_matches'] = $this->email_matches;
return empty($o) ? new class(){} : $o;
}
}
class RegistrationAvailableRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $reporting_term=null,
/** @var string|null */
public ?string $first_name=null,
/** @var string|null */
public ?string $last_name=null,
/** @var string|null */
public ?string $email=null,
/** @var DateTime|null */
public ?DateTime $dob=null,
/** @var int|null */
public ?int $regent_id=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
if (isset($o['first_name'])) $this->first_name = $o['first_name'];
if (isset($o['last_name'])) $this->last_name = $o['last_name'];
if (isset($o['email'])) $this->email = $o['email'];
if (isset($o['dob'])) $this->dob = JsonConverters::from('DateTime', $o['dob']);
if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
if (isset($this->first_name)) $o['first_name'] = $this->first_name;
if (isset($this->last_name)) $o['last_name'] = $this->last_name;
if (isset($this->email)) $o['email'] = $this->email;
if (isset($this->dob)) $o['dob'] = JsonConverters::to('DateTime', $this->dob);
if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
return empty($o) ? new class(){} : $o;
}
}
PHP RegistrationAvailableRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Registration/{reporting_term}/Available HTTP/1.1
Host: data.regent-college.edu
Accept: application/json
Content-Type: application/json
Content-Length: length
{"reporting_term":"String","first_name":"String","last_name":"String","email":"String","dob":"0001-01-01T00:00:00.0000000","regent_id":0}
HTTP/1.1 200 OK
Content-Type: application/json
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,"birthdate_exists":false,"birthdate_matches":false,"has_regent_login":false,"is_a_regis_person":false,"is_a_sugar_person":false,"term_is_available":false,"blocked_in_regis":false,"email_matches":false}