| Required role: | REGISUserRole |
| POST | /Course/{id}/Requirements |
|---|
<?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 CourseRequirementResponse implements JsonSerializable
{
public function __construct(
/** @var int */
public int $course_id=0,
/** @var int */
public int $required_course_id=0,
/** @var int */
public int $requirement_group=0,
/** @var bool|null */
public ?bool $is_prerequisite=null,
/** @var bool|null */
public ?bool $is_corequisite=null,
/** @var DateTime */
public DateTime $timestamp=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['course_id'])) $this->course_id = $o['course_id'];
if (isset($o['required_course_id'])) $this->required_course_id = $o['required_course_id'];
if (isset($o['requirement_group'])) $this->requirement_group = $o['requirement_group'];
if (isset($o['is_prerequisite'])) $this->is_prerequisite = $o['is_prerequisite'];
if (isset($o['is_corequisite'])) $this->is_corequisite = $o['is_corequisite'];
if (isset($o['timestamp'])) $this->timestamp = JsonConverters::from('DateTime', $o['timestamp']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->course_id)) $o['course_id'] = $this->course_id;
if (isset($this->required_course_id)) $o['required_course_id'] = $this->required_course_id;
if (isset($this->requirement_group)) $o['requirement_group'] = $this->requirement_group;
if (isset($this->is_prerequisite)) $o['is_prerequisite'] = $this->is_prerequisite;
if (isset($this->is_corequisite)) $o['is_corequisite'] = $this->is_corequisite;
if (isset($this->timestamp)) $o['timestamp'] = JsonConverters::to('DateTime', $this->timestamp);
return empty($o) ? new class(){} : $o;
}
}
class CourseResponse implements JsonSerializable
{
public function __construct(
/** @var int|null */
public ?int $id=null,
/** @var string|null */
public ?string $course_name=null,
/** @var string|null */
public ?string $title=null,
/** @var string|null */
public ?string $pretty_title=null,
/** @var string|null */
public ?string $course_description=null,
/** @var bool|null */
public ?bool $is_active=null,
/** @var DateTime|null */
public ?DateTime $added_date=null,
/** @var string|null */
public ?string $added_by=null,
/** @var DateTime|null */
public ?DateTime $changed_date=null,
/** @var string|null */
public ?string $changed_by=null,
/** @var DateTime */
public DateTime $timestamp=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
if (isset($o['course_name'])) $this->course_name = $o['course_name'];
if (isset($o['title'])) $this->title = $o['title'];
if (isset($o['pretty_title'])) $this->pretty_title = $o['pretty_title'];
if (isset($o['course_description'])) $this->course_description = $o['course_description'];
if (isset($o['is_active'])) $this->is_active = $o['is_active'];
if (isset($o['added_date'])) $this->added_date = JsonConverters::from('DateTime', $o['added_date']);
if (isset($o['added_by'])) $this->added_by = $o['added_by'];
if (isset($o['changed_date'])) $this->changed_date = JsonConverters::from('DateTime', $o['changed_date']);
if (isset($o['changed_by'])) $this->changed_by = $o['changed_by'];
if (isset($o['timestamp'])) $this->timestamp = JsonConverters::from('DateTime', $o['timestamp']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
if (isset($this->course_name)) $o['course_name'] = $this->course_name;
if (isset($this->title)) $o['title'] = $this->title;
if (isset($this->pretty_title)) $o['pretty_title'] = $this->pretty_title;
if (isset($this->course_description)) $o['course_description'] = $this->course_description;
if (isset($this->is_active)) $o['is_active'] = $this->is_active;
if (isset($this->added_date)) $o['added_date'] = JsonConverters::to('DateTime', $this->added_date);
if (isset($this->added_by)) $o['added_by'] = $this->added_by;
if (isset($this->changed_date)) $o['changed_date'] = JsonConverters::to('DateTime', $this->changed_date);
if (isset($this->changed_by)) $o['changed_by'] = $this->changed_by;
if (isset($this->timestamp)) $o['timestamp'] = JsonConverters::to('DateTime', $this->timestamp);
return empty($o) ? new class(){} : $o;
}
}
class CourseRequirementsResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null,
/** @var int */
public int $course_id=0,
/** @var array<CourseRequirementResponse>|null */
public ?array $requirements=null,
/** @var array<CourseResponse>|null */
public ?array $courses=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
if (isset($o['course_id'])) $this->course_id = $o['course_id'];
if (isset($o['requirements'])) $this->requirements = JsonConverters::fromArray('CourseRequirementResponse', $o['requirements']);
if (isset($o['courses'])) $this->courses = JsonConverters::fromArray('CourseResponse', $o['courses']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
if (isset($this->course_id)) $o['course_id'] = $this->course_id;
if (isset($this->requirements)) $o['requirements'] = JsonConverters::toArray('CourseRequirementResponse', $this->requirements);
if (isset($this->courses)) $o['courses'] = JsonConverters::toArray('CourseResponse', $this->courses);
return empty($o) ? new class(){} : $o;
}
}
class CourseRequirementsRequest implements JsonSerializable
{
public function __construct(
/** @var int */
public int $id=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['id'])) $this->id = $o['id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->id)) $o['id'] = $this->id;
return empty($o) ? new class(){} : $o;
}
}
PHP CourseRequirementsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Course/{id}/Requirements HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
course_id: 0,
requirements:
[
{
course_id: 0,
required_course_id: 0,
requirement_group: 0,
is_prerequisite: False,
is_corequisite: False,
timestamp: 0001-01-01
}
],
courses:
[
{
id: 0,
course_name: String,
title: String,
pretty_title: String,
course_description: String,
is_active: False,
added_date: 0001-01-01,
added_by: String,
changed_date: 0001-01-01,
changed_by: String,
timestamp: 0001-01-01
}
]
}