regis

CourseRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Course/{id}

<?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 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 CourseRequest 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 CourseRequest 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 /Course/{id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <id>0</id>
</CourseRequest>

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

<CourseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <added_by>String</added_by>
  <added_date>0001-01-01T00:00:00</added_date>
  <changed_by>String</changed_by>
  <changed_date>0001-01-01T00:00:00</changed_date>
  <course_description>String</course_description>
  <course_name>String</course_name>
  <id>0</id>
  <is_active>false</is_active>
  <pretty_title>String</pretty_title>
  <timestamp>0001-01-01T00:00:00</timestamp>
  <title>String</title>
</CourseResponse>