Required role: | REGISUserRole |
POST | /registration/activity |
---|
<?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 RegistrationActivityRequest implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $uuid=null,
/** @var string|null */
public ?string $reporting_term=null,
/** @var DateTime */
public DateTime $from_date=new DateTime(),
/** @var DateTime */
public DateTime $to_date=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['uuid'])) $this->uuid = $o['uuid'];
if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
if (isset($o['from_date'])) $this->from_date = JsonConverters::from('DateTime', $o['from_date']);
if (isset($o['to_date'])) $this->to_date = JsonConverters::from('DateTime', $o['to_date']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->uuid)) $o['uuid'] = $this->uuid;
if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
if (isset($this->from_date)) $o['from_date'] = JsonConverters::to('DateTime', $this->from_date);
if (isset($this->to_date)) $o['to_date'] = JsonConverters::to('DateTime', $this->to_date);
return empty($o) ? new class(){} : $o;
}
}
PHP RegistrationActivityRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /registration/activity HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String,
reporting_term: String,
from_date: 0001-01-01,
to_date: 0001-01-01
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length [ { regent_id: 0, uuid: String, student_name: String, email: String, course_name: String, section_code: String, amount: 0, is_change: False, is_drop: False, is_add: False, is_provisional: False, is_audit: False, reporting_term: String, transaction_uuid: String, transaction_notes: String, invoice_notes: String, documents: [ { 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 } ], transaction_started: 0001-01-01, transaction_finished: 0001-01-01, is_admin: False, transaction_by: String } ]