regis

GradeByCourseSaveRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Academic/Course/{secUUID}/Grade/Save

<?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 GradeByCourseSaveResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $secUUID=null,
        /** @var array<string>|null */
        public ?array $messages=null,
        /** @var bool|null */
        public ?bool $is_successful=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['secUUID'])) $this->secUUID = $o['secUUID'];
        if (isset($o['messages'])) $this->messages = JsonConverters::fromArray('string', $o['messages']);
        if (isset($o['is_successful'])) $this->is_successful = $o['is_successful'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->secUUID)) $o['secUUID'] = $this->secUUID;
        if (isset($this->messages)) $o['messages'] = JsonConverters::toArray('string', $this->messages);
        if (isset($this->is_successful)) $o['is_successful'] = $this->is_successful;
        return empty($o) ? new class(){} : $o;
    }
}

class GradeStudentAcademicCredentialRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $stacUUID=null,
        /** @var string|null */
        public ?string $grade=null,
        /** @var bool|null */
        public ?bool $is_grade_final=null
    ) {
    }

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

class GradeByCourseSaveRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $secUUID=null,
        /** @var DateTime|null */
        public ?DateTime $override_grading_end_date=null,
        /** @var bool|null */
        public ?bool $crosslists_included=null,
        /** @var array<GradeStudentAcademicCredentialRequest>|null */
        public ?array $studentAcademicCredentials=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['secUUID'])) $this->secUUID = $o['secUUID'];
        if (isset($o['override_grading_end_date'])) $this->override_grading_end_date = JsonConverters::from('DateTime', $o['override_grading_end_date']);
        if (isset($o['crosslists_included'])) $this->crosslists_included = $o['crosslists_included'];
        if (isset($o['studentAcademicCredentials'])) $this->studentAcademicCredentials = JsonConverters::fromArray('GradeStudentAcademicCredentialRequest', $o['studentAcademicCredentials']);
        if (isset($o['authorizing_uuid'])) $this->authorizing_uuid = $o['authorizing_uuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->secUUID)) $o['secUUID'] = $this->secUUID;
        if (isset($this->override_grading_end_date)) $o['override_grading_end_date'] = JsonConverters::to('DateTime', $this->override_grading_end_date);
        if (isset($this->crosslists_included)) $o['crosslists_included'] = $this->crosslists_included;
        if (isset($this->studentAcademicCredentials)) $o['studentAcademicCredentials'] = JsonConverters::toArray('GradeStudentAcademicCredentialRequest', $this->studentAcademicCredentials);
        if (isset($this->authorizing_uuid)) $o['authorizing_uuid'] = $this->authorizing_uuid;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GradeByCourseSaveRequest 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 /Academic/Course/{secUUID}/Grade/Save HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GradeByCourseSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <crosslists_included>false</crosslists_included>
  <override_grading_end_date>0001-01-01T00:00:00</override_grading_end_date>
  <secUUID>String</secUUID>
  <studentAcademicCredentials>
    <GradeStudentAcademicCredentialRequest>
      <grade>String</grade>
      <is_grade_final>false</is_grade_final>
      <stacUUID>String</stacUUID>
    </GradeStudentAcademicCredentialRequest>
  </studentAcademicCredentials>
</GradeByCourseSaveRequest>

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

<GradeByCourseSaveResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <is_successful>false</is_successful>
  <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </messages>
  <secUUID>String</secUUID>
</GradeByCourseSaveResponse>