regis

CourseUpdateRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Courses/Admin/Update/{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 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 CourseUpdateRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @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 array<CourseRequirementResponse>|null */
        public ?array $course_requirements=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null
    ) {
    }

    /** @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['course_requirements'])) $this->course_requirements = JsonConverters::fromArray('CourseRequirementResponse', $o['course_requirements']);
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
    }
    
    /** @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->course_requirements)) $o['course_requirements'] = JsonConverters::toArray('CourseRequirementResponse', $this->course_requirements);
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CourseUpdateRequest 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 /Courses/Admin/Update/{id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourseUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <course_description>String</course_description>
  <course_name>String</course_name>
  <course_requirements xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
    <d2p1:CourseRequirementResponse>
      <d2p1:course_id>0</d2p1:course_id>
      <d2p1:is_corequisite>false</d2p1:is_corequisite>
      <d2p1:is_prerequisite>false</d2p1:is_prerequisite>
      <d2p1:required_course_id>0</d2p1:required_course_id>
      <d2p1:requirement_group>0</d2p1:requirement_group>
      <d2p1:timestamp>0001-01-01T00:00:00</d2p1:timestamp>
    </d2p1:CourseRequirementResponse>
  </course_requirements>
  <id>0</id>
  <is_active>false</is_active>
  <pretty_title>String</pretty_title>
  <title>String</title>
</CourseUpdateRequest>

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

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>