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 .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 /Registration/Document/StudentSection/{section_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ArrayOfRegistrationDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <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>
</ArrayOfRegistrationDocumentResponse>