regis

<back to all web services

AuditCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Audit/Create
<?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 AuditCreateRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $authorizing_uuid=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
    ) {
    }

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

PHP AuditCreateRequest 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 /Audit/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	authorizing_uuid: String,
	uuid: String,
	ip_address: String,
	url: String,
	controller: String,
	action: String,
	item_id: 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
	}
}