DigiOffice API Services Services

GetEntityIdentifier

Returns the identifier information of an entity.

The following routes are available for this service:
GET	/api/entities/{EntityName}/{EntityID}

<?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 CommonEntityIdentifier implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ID=null,
        /** @var string|null */
        public ?string $DisplayName=null,
        /** @var string|null */
        public ?string $EntityName=null
    ) {
    }

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

/** @description Returns the identifier information of an entity. */
// @Api(Description="Returns the identifier information of an entity.")
class GetEntityIdentifier 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 GetEntityIdentifier 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.

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

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

<CommonEntityIdentifier xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.General">
  <DisplayName>String</DisplayName>
  <EntityName>String</EntityName>
  <ID>String</ID>
</CommonEntityIdentifier>