regis

<back to all web services

CourseRequirementsReportingTermRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Course/ReportingTerm/{reporting_term}/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 CourseRequirementsReportingTermRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $reporting_term=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CourseRequirementsReportingTermRequest 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/ReportingTerm/{reporting_term}/Requirements HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourseRequirementsReportingTermRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <reporting_term>String</reporting_term>
</CourseRequirementsReportingTermRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfCourseRequirementsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <CourseRequirementsResponse>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1: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>
      </d3p1:Meta>
    </ResponseStatus>
    <course_id>0</course_id>
    <courses>
      <CourseResponse>
        <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>
    </courses>
    <requirements>
      <CourseRequirementResponse>
        <course_id>0</course_id>
        <is_corequisite>false</is_corequisite>
        <is_prerequisite>false</is_prerequisite>
        <required_course_id>0</required_course_id>
        <requirement_group>0</requirement_group>
        <timestamp>0001-01-01T00:00:00</timestamp>
      </CourseRequirementResponse>
    </requirements>
  </CourseRequirementsResponse>
</ArrayOfCourseRequirementsResponse>