regis

<back to all web services

ExternalDegreeCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/{uuid}/ExternalDegree/Create
<?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 ExternalDegreeCreateRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var int */
        public int $institution_id=0,
        /** @var string|null */
        public ?string $degree_name=null,
        /** @var string|null */
        public ?string $degree_override_name=null,
        /** @var int|null */
        public ?int $start_year=null,
        /** @var int|null */
        public ?int $end_year=null,
        /** @var string|null */
        public ?string $graduation_month=null,
        /** @var string|null */
        public ?string $authorizing_uuid=null
    ) {
    }

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

PHP ExternalDegreeCreateRequest DTOs

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

HTTP + OTHER

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

POST /Academic/{uuid}/ExternalDegree/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"uuid":"String","institution_id":0,"degree_name":"String","degree_override_name":"String","start_year":0,"end_year":0,"graduation_month":"String","authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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