regis

TermUpdateRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Terms/{term}/Update

<?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 TermUpdateRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $authorizing_uuid=null,
        /** @var string|null */
        public ?string $term=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var int */
        public int $reporting_year=0,
        /** @var string|null */
        public ?string $description=null,
        /** @var DateTime|null */
        public ?DateTime $start_date=null,
        /** @var DateTime|null */
        public ?DateTime $end_date=null,
        /** @var DateTime|null */
        public ?DateTime $registration_start_date=null,
        /** @var DateTime|null */
        public ?DateTime $registration_end_date=null,
        /** @var DateTime|null */
        public ?DateTime $drop_start_date=null,
        /** @var DateTime|null */
        public ?DateTime $drop_end_date=null,
        /** @var DateTime|null */
        public ?DateTime $add_start_date=null,
        /** @var DateTime|null */
        public ?DateTime $add_end_date=null,
        /** @var DateTime|null */
        public ?DateTime $grading_end_date=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
        if (isset($o['term'])) $this->term = $o['term'];
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['reporting_year'])) $this->reporting_year = $o['reporting_year'];
        if (isset($o['description'])) $this->description = $o['description'];
        if (isset($o['start_date'])) $this->start_date = JsonConverters::from('DateTime', $o['start_date']);
        if (isset($o['end_date'])) $this->end_date = JsonConverters::from('DateTime', $o['end_date']);
        if (isset($o['registration_start_date'])) $this->registration_start_date = JsonConverters::from('DateTime', $o['registration_start_date']);
        if (isset($o['registration_end_date'])) $this->registration_end_date = JsonConverters::from('DateTime', $o['registration_end_date']);
        if (isset($o['drop_start_date'])) $this->drop_start_date = JsonConverters::from('DateTime', $o['drop_start_date']);
        if (isset($o['drop_end_date'])) $this->drop_end_date = JsonConverters::from('DateTime', $o['drop_end_date']);
        if (isset($o['add_start_date'])) $this->add_start_date = JsonConverters::from('DateTime', $o['add_start_date']);
        if (isset($o['add_end_date'])) $this->add_end_date = JsonConverters::from('DateTime', $o['add_end_date']);
        if (isset($o['grading_end_date'])) $this->grading_end_date = JsonConverters::from('DateTime', $o['grading_end_date']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        if (isset($this->term)) $o['term'] = $this->term;
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->reporting_year)) $o['reporting_year'] = $this->reporting_year;
        if (isset($this->description)) $o['description'] = $this->description;
        if (isset($this->start_date)) $o['start_date'] = JsonConverters::to('DateTime', $this->start_date);
        if (isset($this->end_date)) $o['end_date'] = JsonConverters::to('DateTime', $this->end_date);
        if (isset($this->registration_start_date)) $o['registration_start_date'] = JsonConverters::to('DateTime', $this->registration_start_date);
        if (isset($this->registration_end_date)) $o['registration_end_date'] = JsonConverters::to('DateTime', $this->registration_end_date);
        if (isset($this->drop_start_date)) $o['drop_start_date'] = JsonConverters::to('DateTime', $this->drop_start_date);
        if (isset($this->drop_end_date)) $o['drop_end_date'] = JsonConverters::to('DateTime', $this->drop_end_date);
        if (isset($this->add_start_date)) $o['add_start_date'] = JsonConverters::to('DateTime', $this->add_start_date);
        if (isset($this->add_end_date)) $o['add_end_date'] = JsonConverters::to('DateTime', $this->add_end_date);
        if (isset($this->grading_end_date)) $o['grading_end_date'] = JsonConverters::to('DateTime', $this->grading_end_date);
        return empty($o) ? new class(){} : $o;
    }
}

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

<TermUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <add_end_date>0001-01-01T00:00:00</add_end_date>
  <add_start_date>0001-01-01T00:00:00</add_start_date>
  <authorizing_uuid>String</authorizing_uuid>
  <description>String</description>
  <drop_end_date>0001-01-01T00:00:00</drop_end_date>
  <drop_start_date>0001-01-01T00:00:00</drop_start_date>
  <end_date>0001-01-01T00:00:00</end_date>
  <grading_end_date>0001-01-01T00:00:00</grading_end_date>
  <registration_end_date>0001-01-01T00:00:00</registration_end_date>
  <registration_start_date>0001-01-01T00:00:00</registration_start_date>
  <reporting_term>String</reporting_term>
  <reporting_year>0</reporting_year>
  <start_date>0001-01-01T00:00:00</start_date>
  <term>String</term>
</TermUpdateRequest>

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>