DigiOffice API Services Services

<back to all web services

GetApplicationInfo

Requires Authentication
<?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 ModuleInformation implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ModuleName=null,
        /** @var string|null */
        public ?string $ModuleVersion=null,
        /** @var DateTime */
        public DateTime $ModuleDate=new DateTime()
    ) {
    }

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

class ApplicationInfo implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ApplicationName=null,
        /** @var string|null */
        public ?string $Version=null,
        /** @var string|null */
        public ?string $VersionGateway=null,
        /** @var string|null */
        public ?string $Environment=null,
        /** @var string|null */
        public ?string $MachineName=null,
        /** @var string|null */
        public ?string $CustomerCode=null,
        /** @var string|null */
        public ?string $CustomerBrandCode=null,
        /** @var string|null */
        public ?string $DatabaseName=null,
        /** @var string|null */
        public ?string $DatabaseVersion=null,
        /** @var string|null */
        public ?string $DatabaseServer=null,
        /** @var string|null */
        public ?string $UserName=null,
        /** @var string|null */
        public ?string $UserLoginName=null,
        /** @var array<ModuleInformation>|null */
        public ?array $ModulesInformation=null,
        /** @var string|null */
        public ?string $WebsiteIntranetUrl=null,
        /** @var bool|null */
        public ?bool $IDBOpties=null,
        /** @var string|null */
        public ?string $OnPremisesUrl=null,
        /** @var string|null */
        public ?string $OnLineUrl=null,
        /** @var bool|null */
        public ?bool $IsApiGateway=null,
        /** @var bool|null */
        public ?bool $HasCRMModuleActive=null,
        /** @var bool|null */
        public ?bool $HasExtranetModuleActive=null,
        /** @var bool|null */
        public ?bool $HasHuisstijlMOModuleActive=null,
        /** @var bool|null */
        public ?bool $HasDigitaalOndertekenenModuleActive=null,
        /** @var bool|null */
        public ?bool $HasDOVoorWordHuisstijl=null,
        /** @var bool|null */
        public ?bool $HasDOVoorWordRegistreren=null,
        /** @var bool|null */
        public ?bool $HasDOVoorExcelHuisstijl=null,
        /** @var bool|null */
        public ?bool $HasDOVoorExcelRegistreren=null,
        /** @var bool|null */
        public ?bool $HasDOVoorPowerPointHuisstijl=null,
        /** @var bool|null */
        public ?bool $HasDOVoorPowerPointRegistreren=null,
        /** @var bool|null */
        public ?bool $HasDOVoorOutlookHuisstijl=null,
        /** @var bool|null */
        public ?bool $HasDOVoorOutlookRegistreren=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ApplicationName'])) $this->ApplicationName = $o['ApplicationName'];
        if (isset($o['Version'])) $this->Version = $o['Version'];
        if (isset($o['VersionGateway'])) $this->VersionGateway = $o['VersionGateway'];
        if (isset($o['Environment'])) $this->Environment = $o['Environment'];
        if (isset($o['MachineName'])) $this->MachineName = $o['MachineName'];
        if (isset($o['CustomerCode'])) $this->CustomerCode = $o['CustomerCode'];
        if (isset($o['CustomerBrandCode'])) $this->CustomerBrandCode = $o['CustomerBrandCode'];
        if (isset($o['DatabaseName'])) $this->DatabaseName = $o['DatabaseName'];
        if (isset($o['DatabaseVersion'])) $this->DatabaseVersion = $o['DatabaseVersion'];
        if (isset($o['DatabaseServer'])) $this->DatabaseServer = $o['DatabaseServer'];
        if (isset($o['UserName'])) $this->UserName = $o['UserName'];
        if (isset($o['UserLoginName'])) $this->UserLoginName = $o['UserLoginName'];
        if (isset($o['ModulesInformation'])) $this->ModulesInformation = JsonConverters::fromArray('ModuleInformation', $o['ModulesInformation']);
        if (isset($o['WebsiteIntranetUrl'])) $this->WebsiteIntranetUrl = $o['WebsiteIntranetUrl'];
        if (isset($o['IDBOpties'])) $this->IDBOpties = $o['IDBOpties'];
        if (isset($o['OnPremisesUrl'])) $this->OnPremisesUrl = $o['OnPremisesUrl'];
        if (isset($o['OnLineUrl'])) $this->OnLineUrl = $o['OnLineUrl'];
        if (isset($o['IsApiGateway'])) $this->IsApiGateway = $o['IsApiGateway'];
        if (isset($o['HasCRMModuleActive'])) $this->HasCRMModuleActive = $o['HasCRMModuleActive'];
        if (isset($o['HasExtranetModuleActive'])) $this->HasExtranetModuleActive = $o['HasExtranetModuleActive'];
        if (isset($o['HasHuisstijlMOModuleActive'])) $this->HasHuisstijlMOModuleActive = $o['HasHuisstijlMOModuleActive'];
        if (isset($o['HasDigitaalOndertekenenModuleActive'])) $this->HasDigitaalOndertekenenModuleActive = $o['HasDigitaalOndertekenenModuleActive'];
        if (isset($o['HasDOVoorWordHuisstijl'])) $this->HasDOVoorWordHuisstijl = $o['HasDOVoorWordHuisstijl'];
        if (isset($o['HasDOVoorWordRegistreren'])) $this->HasDOVoorWordRegistreren = $o['HasDOVoorWordRegistreren'];
        if (isset($o['HasDOVoorExcelHuisstijl'])) $this->HasDOVoorExcelHuisstijl = $o['HasDOVoorExcelHuisstijl'];
        if (isset($o['HasDOVoorExcelRegistreren'])) $this->HasDOVoorExcelRegistreren = $o['HasDOVoorExcelRegistreren'];
        if (isset($o['HasDOVoorPowerPointHuisstijl'])) $this->HasDOVoorPowerPointHuisstijl = $o['HasDOVoorPowerPointHuisstijl'];
        if (isset($o['HasDOVoorPowerPointRegistreren'])) $this->HasDOVoorPowerPointRegistreren = $o['HasDOVoorPowerPointRegistreren'];
        if (isset($o['HasDOVoorOutlookHuisstijl'])) $this->HasDOVoorOutlookHuisstijl = $o['HasDOVoorOutlookHuisstijl'];
        if (isset($o['HasDOVoorOutlookRegistreren'])) $this->HasDOVoorOutlookRegistreren = $o['HasDOVoorOutlookRegistreren'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ApplicationName)) $o['ApplicationName'] = $this->ApplicationName;
        if (isset($this->Version)) $o['Version'] = $this->Version;
        if (isset($this->VersionGateway)) $o['VersionGateway'] = $this->VersionGateway;
        if (isset($this->Environment)) $o['Environment'] = $this->Environment;
        if (isset($this->MachineName)) $o['MachineName'] = $this->MachineName;
        if (isset($this->CustomerCode)) $o['CustomerCode'] = $this->CustomerCode;
        if (isset($this->CustomerBrandCode)) $o['CustomerBrandCode'] = $this->CustomerBrandCode;
        if (isset($this->DatabaseName)) $o['DatabaseName'] = $this->DatabaseName;
        if (isset($this->DatabaseVersion)) $o['DatabaseVersion'] = $this->DatabaseVersion;
        if (isset($this->DatabaseServer)) $o['DatabaseServer'] = $this->DatabaseServer;
        if (isset($this->UserName)) $o['UserName'] = $this->UserName;
        if (isset($this->UserLoginName)) $o['UserLoginName'] = $this->UserLoginName;
        if (isset($this->ModulesInformation)) $o['ModulesInformation'] = JsonConverters::toArray('ModuleInformation', $this->ModulesInformation);
        if (isset($this->WebsiteIntranetUrl)) $o['WebsiteIntranetUrl'] = $this->WebsiteIntranetUrl;
        if (isset($this->IDBOpties)) $o['IDBOpties'] = $this->IDBOpties;
        if (isset($this->OnPremisesUrl)) $o['OnPremisesUrl'] = $this->OnPremisesUrl;
        if (isset($this->OnLineUrl)) $o['OnLineUrl'] = $this->OnLineUrl;
        if (isset($this->IsApiGateway)) $o['IsApiGateway'] = $this->IsApiGateway;
        if (isset($this->HasCRMModuleActive)) $o['HasCRMModuleActive'] = $this->HasCRMModuleActive;
        if (isset($this->HasExtranetModuleActive)) $o['HasExtranetModuleActive'] = $this->HasExtranetModuleActive;
        if (isset($this->HasHuisstijlMOModuleActive)) $o['HasHuisstijlMOModuleActive'] = $this->HasHuisstijlMOModuleActive;
        if (isset($this->HasDigitaalOndertekenenModuleActive)) $o['HasDigitaalOndertekenenModuleActive'] = $this->HasDigitaalOndertekenenModuleActive;
        if (isset($this->HasDOVoorWordHuisstijl)) $o['HasDOVoorWordHuisstijl'] = $this->HasDOVoorWordHuisstijl;
        if (isset($this->HasDOVoorWordRegistreren)) $o['HasDOVoorWordRegistreren'] = $this->HasDOVoorWordRegistreren;
        if (isset($this->HasDOVoorExcelHuisstijl)) $o['HasDOVoorExcelHuisstijl'] = $this->HasDOVoorExcelHuisstijl;
        if (isset($this->HasDOVoorExcelRegistreren)) $o['HasDOVoorExcelRegistreren'] = $this->HasDOVoorExcelRegistreren;
        if (isset($this->HasDOVoorPowerPointHuisstijl)) $o['HasDOVoorPowerPointHuisstijl'] = $this->HasDOVoorPowerPointHuisstijl;
        if (isset($this->HasDOVoorPowerPointRegistreren)) $o['HasDOVoorPowerPointRegistreren'] = $this->HasDOVoorPowerPointRegistreren;
        if (isset($this->HasDOVoorOutlookHuisstijl)) $o['HasDOVoorOutlookHuisstijl'] = $this->HasDOVoorOutlookHuisstijl;
        if (isset($this->HasDOVoorOutlookRegistreren)) $o['HasDOVoorOutlookRegistreren'] = $this->HasDOVoorOutlookRegistreren;
        return empty($o) ? new class(){} : $o;
    }
}

class GetApplicationInfo implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $IncludeModules=null,
        /** @var bool|null */
        public ?bool $IncludeOfficeAddins=null
    ) {
    }

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

PHP GetApplicationInfo 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 /xml/reply/GetApplicationInfo HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetApplicationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Diagnostics.DTO">
  <IncludeModules>false</IncludeModules>
  <IncludeOfficeAddins>false</IncludeOfficeAddins>
</GetApplicationInfo>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApplicationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Diagnostics.DTO">
  <ApplicationName>String</ApplicationName>
  <CustomerBrandCode>String</CustomerBrandCode>
  <CustomerCode>String</CustomerCode>
  <DatabaseName>String</DatabaseName>
  <DatabaseServer>String</DatabaseServer>
  <DatabaseVersion>String</DatabaseVersion>
  <Environment>String</Environment>
  <HasCRMModuleActive>false</HasCRMModuleActive>
  <HasDOVoorExcelHuisstijl>false</HasDOVoorExcelHuisstijl>
  <HasDOVoorExcelRegistreren>false</HasDOVoorExcelRegistreren>
  <HasDOVoorOutlookHuisstijl>false</HasDOVoorOutlookHuisstijl>
  <HasDOVoorOutlookRegistreren>false</HasDOVoorOutlookRegistreren>
  <HasDOVoorPowerPointHuisstijl>false</HasDOVoorPowerPointHuisstijl>
  <HasDOVoorPowerPointRegistreren>false</HasDOVoorPowerPointRegistreren>
  <HasDOVoorWordHuisstijl>false</HasDOVoorWordHuisstijl>
  <HasDOVoorWordRegistreren>false</HasDOVoorWordRegistreren>
  <HasDigitaalOndertekenenModuleActive>false</HasDigitaalOndertekenenModuleActive>
  <HasExtranetModuleActive>false</HasExtranetModuleActive>
  <HasHuisstijlMOModuleActive>false</HasHuisstijlMOModuleActive>
  <IDBOpties>false</IDBOpties>
  <IsApiGateway>false</IsApiGateway>
  <IsEmpty>false</IsEmpty>
  <MachineName>String</MachineName>
  <ModulesInformation>
    <ModuleInformation>
      <ModuleDate>0001-01-01T00:00:00</ModuleDate>
      <ModuleName>String</ModuleName>
      <ModuleVersion>String</ModuleVersion>
    </ModuleInformation>
  </ModulesInformation>
  <OnLineUrl>String</OnLineUrl>
  <OnPremisesUrl>String</OnPremisesUrl>
  <UserLoginName>String</UserLoginName>
  <UserName>String</UserName>
  <Version>String</Version>
  <VersionGateway>String</VersionGateway>
  <WebsiteIntranetUrl>String</WebsiteIntranetUrl>
</ApplicationInfo>