DigiOffice API Services Services

<back to all web services

GetEntitySummary

Get the summary of an entity.

<?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 EntitySummaryResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Summary=null
    ) {
    }

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

/** @description Get the summary of an entity. */
// @Api(Description="Get the summary of an entity.")
class GetEntitySummary implements JsonSerializable
{
    public function __construct(
        /** @description ID of the entity */
        // @ApiMember(Description="ID of the entity", IsRequired=true)
        /** @var string */
        public string $EntityID='',

        /** @description Name of the entity */
        // @ApiMember(Description="Name of the entity", IsRequired=true)
        /** @var string */
        public string $EntityName=''
    ) {
    }

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

PHP GetEntitySummary DTOs

GET /api/entities/{EntityName}/{EntityID}/summary HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Summary: String
}