regis

<back to all web services

StudentGraduationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentGraduation/{year}
<?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 StudentGraduationsRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $year=0
    ) {
    }

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

PHP StudentGraduationsRequest 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 /StudentGraduation/{year} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	year: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		regent_id: 0,
		uuid: String,
		first_name: String,
		preferred_name: String,
		middle_name: String,
		last_name: String,
		email: String,
		phonetic_first_name: String,
		phonetic_middle_name: String,
		phonetic_last_name: String,
		placement: String,
		placement_other: String,
		addr1: String,
		addr2: String,
		city: String,
		state: String,
		country: String,
		code: String,
		citizenship: String,
		citizenship_other: String,
		permanent_resident: String,
		previous_degrees: String,
		gown_size: 0,
		project_title: String,
		supervisor: String,
		is_attending: False,
		is_hood_requested: False,
		is_hood_paid: False,
		is_paid: False,
		is_late: False,
		year: 0,
		comments: String,
		current_status: String,
		current_status_date: 0001-01-01,
		added_date: 0001-01-01,
		applied_programs: 
		[
			{
				program_code: String,
				concentration_code: String,
				program_details: String,
				comments: String
			}
		]
	}
]