regis

AuditRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Audit

<?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 AuditResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $ip_address=null,
        /** @var string|null */
        public ?string $url=null,
        /** @var string|null */
        public ?string $controller=null,
        /** @var string|null */
        public ?string $action=null,
        /** @var string|null */
        public ?string $item_id=null,
        /** @var DateTime */
        public DateTime $timestamp=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['ip_address'])) $this->ip_address = $o['ip_address'];
        if (isset($o['url'])) $this->url = $o['url'];
        if (isset($o['controller'])) $this->controller = $o['controller'];
        if (isset($o['action'])) $this->action = $o['action'];
        if (isset($o['item_id'])) $this->item_id = $o['item_id'];
        if (isset($o['timestamp'])) $this->timestamp = JsonConverters::from('DateTime', $o['timestamp']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->ip_address)) $o['ip_address'] = $this->ip_address;
        if (isset($this->url)) $o['url'] = $this->url;
        if (isset($this->controller)) $o['controller'] = $this->controller;
        if (isset($this->action)) $o['action'] = $this->action;
        if (isset($this->item_id)) $o['item_id'] = $this->item_id;
        if (isset($this->timestamp)) $o['timestamp'] = JsonConverters::to('DateTime', $this->timestamp);
        return empty($o) ? new class(){} : $o;
    }
}

class AuditsResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var array<AuditResponse>|null */
        public ?array $audits=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['audits'])) $this->audits = JsonConverters::fromArray('AuditResponse', $o['audits']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->audits)) $o['audits'] = JsonConverters::toArray('AuditResponse', $this->audits);
        return empty($o) ? new class(){} : $o;
    }
}

class AuditRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null,
        /** @var DateTime */
        public DateTime $created_since_date=new DateTime(),
        /** @var string|null */
        public ?string $controller=null,
        /** @var string|null */
        public ?string $action=null,
        /** @var string|null */
        public ?string $item_id=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['created_since_date'])) $this->created_since_date = JsonConverters::from('DateTime', $o['created_since_date']);
        if (isset($o['controller'])) $this->controller = $o['controller'];
        if (isset($o['action'])) $this->action = $o['action'];
        if (isset($o['item_id'])) $this->item_id = $o['item_id'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->created_since_date)) $o['created_since_date'] = JsonConverters::to('DateTime', $this->created_since_date);
        if (isset($this->controller)) $o['controller'] = $this->controller;
        if (isset($this->action)) $o['action'] = $this->action;
        if (isset($this->item_id)) $o['item_id'] = $this->item_id;
        return empty($o) ? new class(){} : $o;
    }
}

PHP AuditRequest DTOs

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

HTTP + XML

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

POST /Audit HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AuditRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <action>String</action>
  <controller>String</controller>
  <created_since_date>0001-01-01T00:00:00</created_since_date>
  <item_id>String</item_id>
  <uuid>String</uuid>
</AuditRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AuditsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <audits>
    <AuditResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <action>String</action>
      <controller>String</controller>
      <ip_address>String</ip_address>
      <item_id>String</item_id>
      <timestamp>0001-01-01T00:00:00</timestamp>
      <url>String</url>
      <uuid>String</uuid>
    </AuditResponse>
  </audits>
</AuditsResponse>