regis

<back to all web services

RegistrationDocumentsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/Document/StudentSection/{section_uuid}
POST/Registration/Document/{uuid}/StudentSection/{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 RegistrationDocumentsRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $section_uuid=null
    ) {
    }

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

PHP RegistrationDocumentsRequest DTOs

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

HTTP + JSV

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

POST /Registration/Document/StudentSection/{section_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	section_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		uuid: String,
		regent_id: 0,
		first_name: String,
		last_name: String,
		gender: String,
		email: String,
		program: String,
		concentration: String,
		section_uuid: String,
		course_name: String,
		course_title: String,
		reporting_term: String,
		document_code: String,
		document_json: String,
		document_name: String,
		document_description: String,
		added_date: 0001-01-01,
		changed_date: 0001-01-01
	}
]