regis

ClassRosterRequest

**Requires Authentication**
Required permission:	ReadClassRosters

The following routes are available for this service:
POST	/ClassRoster/{reporting_term}
POST	/ClassRoster/{reporting_term}/{section_uuid}

<?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 ClassRosterRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var string|null */
        public ?string $section_uuid=null
    ) {
    }

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

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

<ClassRosterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <reporting_term>String</reporting_term>
  <section_uuid>String</section_uuid>
</ClassRosterRequest>

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

<ArrayOfClassRosterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ClassRosterResponse>
    <capacity>0</capacity>
    <course_name>String</course_name>
    <course_title>String</course_title>
    <end_date>0001-01-01T00:00:00</end_date>
    <end_times>String</end_times>
    <first_meeting_date>0001-01-01T00:00:00</first_meeting_date>
    <has_required_documents>false</has_required_documents>
    <instructors>
      <InstructorResponse>
        <ResponseStatus xmlns:d5p1="http://schemas.servicestack.net/types">
          <d5p1:ErrorCode>String</d5p1:ErrorCode>
          <d5p1:Message>String</d5p1:Message>
          <d5p1:StackTrace>String</d5p1:StackTrace>
          <d5p1:Errors>
            <d5p1:ResponseError>
              <d5p1:ErrorCode>String</d5p1:ErrorCode>
              <d5p1:FieldName>String</d5p1:FieldName>
              <d5p1:Message>String</d5p1:Message>
              <d5p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:KeyValueOfstringstring>
                  <d8p1:Key>String</d8p1:Key>
                  <d8p1:Value>String</d8p1:Value>
                </d8p1:KeyValueOfstringstring>
              </d5p1:Meta>
            </d5p1:ResponseError>
          </d5p1:Errors>
          <d5p1: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>
          </d5p1:Meta>
        </ResponseStatus>
        <email>String</email>
        <first_name>String</first_name>
        <full_name>String</full_name>
        <image_base64>String</image_base64>
        <last_name>String</last_name>
        <preferred_name>String</preferred_name>
        <regent_id>0</regent_id>
        <regent_login>String</regent_login>
      </InstructorResponse>
    </instructors>
    <last_meeting_date>0001-01-01T00:00:00</last_meeting_date>
    <meeting_days>String</meeting_days>
    <registrations>
      <RegistrationClassRosterResponse>
        <academic_concentration>String</academic_concentration>
        <academic_program>String</academic_program>
        <additional_instructors>
          <InstructorResponse>
            <ResponseStatus xmlns:d7p1="http://schemas.servicestack.net/types">
              <d7p1:ErrorCode>String</d7p1:ErrorCode>
              <d7p1:Message>String</d7p1:Message>
              <d7p1:StackTrace>String</d7p1:StackTrace>
              <d7p1:Errors>
                <d7p1:ResponseError>
                  <d7p1:ErrorCode>String</d7p1:ErrorCode>
                  <d7p1:FieldName>String</d7p1:FieldName>
                  <d7p1:Message>String</d7p1:Message>
                  <d7p1:Meta xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:KeyValueOfstringstring>
                      <d10p1:Key>String</d10p1:Key>
                      <d10p1:Value>String</d10p1:Value>
                    </d10p1:KeyValueOfstringstring>
                  </d7p1:Meta>
                </d7p1:ResponseError>
              </d7p1:Errors>
              <d7p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:KeyValueOfstringstring>
                  <d8p1:Key>String</d8p1:Key>
                  <d8p1:Value>String</d8p1:Value>
                </d8p1:KeyValueOfstringstring>
              </d7p1:Meta>
            </ResponseStatus>
            <email>String</email>
            <first_name>String</first_name>
            <full_name>String</full_name>
            <image_base64>String</image_base64>
            <last_name>String</last_name>
            <preferred_name>String</preferred_name>
            <regent_id>0</regent_id>
            <regent_login>String</regent_login>
          </InstructorResponse>
        </additional_instructors>
        <amount>0</amount>
        <date>0001-01-01T00:00:00</date>
        <documents>
          <RegistrationDocumentResponse>
            <added_date>0001-01-01T00:00:00</added_date>
            <changed_date>0001-01-01T00:00:00</changed_date>
            <concentration>String</concentration>
            <course_name>String</course_name>
            <course_title>String</course_title>
            <document_code>String</document_code>
            <document_description>String</document_description>
            <document_json>String</document_json>
            <document_name>String</document_name>
            <email>String</email>
            <first_name>String</first_name>
            <gender>String</gender>
            <last_name>String</last_name>
            <program>String</program>
            <regent_id>0</regent_id>
            <reporting_term>String</reporting_term>
            <section_uuid>String</section_uuid>
            <uuid>String</uuid>
          </RegistrationDocumentResponse>
        </documents>
        <email>String</email>
        <first_name>String</first_name>
        <is_audit>false</is_audit>
        <is_credit>false</is_credit>
        <is_provisional>false</is_provisional>
        <last_name>String</last_name>
        <middle_name>String</middle_name>
        <phone_bus>String</phone_bus>
        <phone_cell>String</phone_cell>
        <phone_home>String</phone_home>
        <preferred_name>String</preferred_name>
        <regent_id>0</regent_id>
        <regent_login>String</regent_login>
        <uuid>String</uuid>
      </RegistrationClassRosterResponse>
    </registrations>
    <reporting_term>String</reporting_term>
    <room>String</room>
    <section_code>String</section_code>
    <section_uuid>String</section_uuid>
    <start_date>0001-01-01T00:00:00</start_date>
    <start_times>String</start_times>
    <term>String</term>
  </ClassRosterResponse>
</ArrayOfClassRosterResponse>