regis

<back to all web services

RegentLoginAssignedEmailRequest

Requires Authentication
Required permission:ActiveDirectory
The following routes are available for this service:
POST/Person/{uuid}/RegentLoginAssigned/Email
<?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 RegentLoginAssignedEmailRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $preferred_name=null,
        /** @var string|null */
        public ?string $regent_login=null,
        /** @var string|null */
        public ?string $email=null,
        /** @var bool|null */
        public ?bool $is_landlord=null,
        /** @var string|null */
        public ?string $set_password_url=null
    ) {
    }

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

PHP RegentLoginAssignedEmailRequest 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 /Person/{uuid}/RegentLoginAssigned/Email HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	preferred_name: String,
	regent_login: String,
	email: String,
	is_landlord: False,
	set_password_url: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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