sfgboxapi

SystemEntitiesAdd

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

<?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 SystemEntitiesAddResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var string|null */
        public ?string $entity=null,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $longDescription=null,

        // @DataMember(Order=5)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

// @DataContract
class SystemEntitiesAdd implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $entity='',

        // @DataMember(Order=3)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $longDescription=''
    ) {
    }

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

PHP SystemEntitiesAdd DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /system_entities HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"entity":"String","longDescription":"String"}

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

{"entity":"String","longDescription":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}