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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<RegistrationActivityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<from_date>0001-01-01T00:00:00</from_date>
<reporting_term>String</reporting_term>
<to_date>0001-01-01T00:00:00</to_date>
<uuid>String</uuid>
</RegistrationActivityRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ArrayOfRegistrationActivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses"> <RegistrationActivityResponse> <amount>0</amount> <course_name>String</course_name> <documents> <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> </documents> <email>String</email> <invoice_notes>String</invoice_notes> <is_add>false</is_add> <is_admin>false</is_admin> <is_audit>false</is_audit> <is_change>false</is_change> <is_drop>false</is_drop> <is_provisional>false</is_provisional> <regent_id>0</regent_id> <reporting_term>String</reporting_term> <section_code>String</section_code> <student_name>String</student_name> <transaction_by>String</transaction_by> <transaction_finished>0001-01-01T00:00:00</transaction_finished> <transaction_notes>String</transaction_notes> <transaction_started>0001-01-01T00:00:00</transaction_started> <transaction_uuid>String</transaction_uuid> <uuid>String</uuid> </RegistrationActivityResponse> </ArrayOfRegistrationActivityResponse>