DigiOffice API Services Services

<back to all web services

GetMultiRegistrationProfileFieldStates

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 RegistrationProfileFieldValue implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $DocumentFieldID='',
        /** @var string|null */
        public ?string $Value=null,
        /** @var string|null */
        public ?string $ShadowValue=null,
        /** @var bool|null */
        public ?bool $IsModifiedByUser=null
    ) {
    }

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

class GetRegistrationprofileFieldStates implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $RegistrationprofileID='',
        /** @var string|null */
        public ?string $DocumentID=null,
        /** @var int|null */
        public ?int $QueueDocumentID=null,
        /** @var string|null */
        public ?string $StandardDocumentID=null,
        /** @var array<string>|null */
        public ?array $RequestTriggeredByDependentDocumentFieldIds=null,
        /** @var array<RegistrationProfileFieldValue>|null */
        public ?array $CurrentRegistrationprofileFieldValues=null,
        /** @var bool|null */
        public ?bool $IsOffice365Context=null,
        /** @var bool|null */
        public ?bool $IsOpenedFromNonDMSLocation=null,
        /** @var string|null */
        public ?string $PidTag=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['RegistrationprofileID'])) $this->RegistrationprofileID = $o['RegistrationprofileID'];
        if (isset($o['DocumentID'])) $this->DocumentID = $o['DocumentID'];
        if (isset($o['QueueDocumentID'])) $this->QueueDocumentID = $o['QueueDocumentID'];
        if (isset($o['StandardDocumentID'])) $this->StandardDocumentID = $o['StandardDocumentID'];
        if (isset($o['RequestTriggeredByDependentDocumentFieldIds'])) $this->RequestTriggeredByDependentDocumentFieldIds = JsonConverters::fromArray('Guid', $o['RequestTriggeredByDependentDocumentFieldIds']);
        if (isset($o['CurrentRegistrationprofileFieldValues'])) $this->CurrentRegistrationprofileFieldValues = JsonConverters::fromArray('RegistrationProfileFieldValue', $o['CurrentRegistrationprofileFieldValues']);
        if (isset($o['IsOffice365Context'])) $this->IsOffice365Context = $o['IsOffice365Context'];
        if (isset($o['IsOpenedFromNonDMSLocation'])) $this->IsOpenedFromNonDMSLocation = $o['IsOpenedFromNonDMSLocation'];
        if (isset($o['PidTag'])) $this->PidTag = $o['PidTag'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->RegistrationprofileID)) $o['RegistrationprofileID'] = $this->RegistrationprofileID;
        if (isset($this->DocumentID)) $o['DocumentID'] = $this->DocumentID;
        if (isset($this->QueueDocumentID)) $o['QueueDocumentID'] = $this->QueueDocumentID;
        if (isset($this->StandardDocumentID)) $o['StandardDocumentID'] = $this->StandardDocumentID;
        if (isset($this->RequestTriggeredByDependentDocumentFieldIds)) $o['RequestTriggeredByDependentDocumentFieldIds'] = JsonConverters::toArray('Guid', $this->RequestTriggeredByDependentDocumentFieldIds);
        if (isset($this->CurrentRegistrationprofileFieldValues)) $o['CurrentRegistrationprofileFieldValues'] = JsonConverters::toArray('RegistrationProfileFieldValue', $this->CurrentRegistrationprofileFieldValues);
        if (isset($this->IsOffice365Context)) $o['IsOffice365Context'] = $this->IsOffice365Context;
        if (isset($this->IsOpenedFromNonDMSLocation)) $o['IsOpenedFromNonDMSLocation'] = $this->IsOpenedFromNonDMSLocation;
        if (isset($this->PidTag)) $o['PidTag'] = $this->PidTag;
        return empty($o) ? new class(){} : $o;
    }
}

class GetMultiRegistrationProfileFieldStates implements JsonSerializable
{
    public function __construct(
        /** @var array<GetRegistrationprofileFieldStates>|null */
        public ?array $MultiRegistrationProfileFieldStates=null
    ) {
    }

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

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

<GetMultiRegistrationProfileFieldStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile.Operations">
  <MultiRegistrationProfileFieldStates>
    <GetRegistrationprofileFieldStates>
      <CurrentRegistrationprofileFieldValues xmlns:d4p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
        <d4p1:RegistrationProfileFieldValue>
          <d4p1:DocumentFieldID>00000000-0000-0000-0000-000000000000</d4p1:DocumentFieldID>
          <d4p1:IsModifiedByUser>false</d4p1:IsModifiedByUser>
          <d4p1:ShadowValue>String</d4p1:ShadowValue>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:RegistrationProfileFieldValue>
      </CurrentRegistrationprofileFieldValues>
      <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
      <IsOffice365Context>false</IsOffice365Context>
      <IsOpenedFromNonDMSLocation>false</IsOpenedFromNonDMSLocation>
      <PidTag>String</PidTag>
      <QueueDocumentID>0</QueueDocumentID>
      <RegistrationprofileID>00000000-0000-0000-0000-000000000000</RegistrationprofileID>
      <RequestTriggeredByDependentDocumentFieldIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
      </RequestTriggeredByDependentDocumentFieldIds>
      <StandardDocumentID>00000000-0000-0000-0000-000000000000</StandardDocumentID>
    </GetRegistrationprofileFieldStates>
  </MultiRegistrationProfileFieldStates>
</GetMultiRegistrationProfileFieldStates>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfMultiRegistrationProfileFieldStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
  <MultiRegistrationProfileFieldStates>
    <ControlStates>
      <RegistrationProfileFieldStateBase>
        <Readonly xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common">false</Readonly>
        <Required xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common">false</Required>
        <Visible xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common">false</Visible>
        <DocumentFieldID>00000000-0000-0000-0000-000000000000</DocumentFieldID>
      </RegistrationProfileFieldStateBase>
    </ControlStates>
    <Messages xmlns:d3p1="http://schemas.datacontract.org/2004/07/IDB.Core.Diagnostics.Interfaces">
      <d3p1:InformationMessageBase i:nil="true" />
    </Messages>
    <ReadOnly>false</ReadOnly>
    <DocumentUploadID>0</DocumentUploadID>
  </MultiRegistrationProfileFieldStates>
</ArrayOfMultiRegistrationProfileFieldStates>