regis

<back to all web services

TranscriptNoteUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Transcript/{uuid}/Note/{note_id}/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 TranscriptNoteUpdateRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $note=null,
        /** @var string|null */
        public ?string $academic_level=null,
        /** @var int */
        public int $note_id=0
    ) {
    }

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

PHP TranscriptNoteUpdateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Transcript/{uuid}/Note/{note_id}/Update HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","note":"String","academic_level":"String","note_id":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}