regis

<back to all web services

StudentAcademicCredentialExtensionsRequest

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

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

PHP StudentAcademicCredentialExtensionsRequest 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 /StudentAcademicCredentialExtensions HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ArrayOfStudentAcademicCredentialExtensionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <StudentAcademicCredentialExtensionResponse>
    <added_by>String</added_by>
    <added_date>0001-01-01T00:00:00</added_date>
    <amount>0</amount>
    <assignments>String</assignments>
    <changed_by>String</changed_by>
    <changed_date>0001-01-01T00:00:00</changed_date>
    <comments>String</comments>
    <course_name>String</course_name>
    <due_date>0001-01-01T00:00:00</due_date>
    <first_name>String</first_name>
    <grade_penalty>String</grade_penalty>
    <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>
    <is_active>false</is_active>
    <is_audit>false</is_audit>
    <last_name>String</last_name>
    <location_code>String</location_code>
    <received_date>0001-01-01T00:00:00</received_date>
    <regent_id>0</regent_id>
    <reporting_term>String</reporting_term>
    <section_code>String</section_code>
    <stac_uuid>String</stac_uuid>
    <term>String</term>
    <title>String</title>
    <uuid>String</uuid>
  </StudentAcademicCredentialExtensionResponse>
</ArrayOfStudentAcademicCredentialExtensionResponse>