DigiOffice Gateway Web Services

<back to all web services

GetUsersAndGroupsForTransition

Get available users and groups to assign to a transition.

<?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 UserOrGroup implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ID=0,
        /** @var string|null */
        public ?string $Title=null,
        /** @var bool|null */
        public ?bool $IsChecked=null,
        /** @var string|null */
        public ?string $Image=null
    ) {
    }

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

class QuickAddOption implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $EntityType=null
    ) {
    }

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

class UsersOrGroupsResponse implements IBaseQuickLookupResponse, JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $NumberOfAllRecords=0,
        /** @var array<UserOrGroup>|null */
        public ?array $UsersOrGroups=null,
        /** @var array<QuickAddOption>|null */
        public ?array $QuickAddOptions=null
    ) {
    }

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

/** @description Get available users and groups to assign to a transition. */
// @Api(Description="Get available users and groups to assign to a transition.")
class GetUsersAndGroupsForTransition implements JsonSerializable
{
    public function __construct(
        /** @description ID of the transition */
        // @ApiMember(Description="ID of the transition", IsRequired=true)
        /** @var string */
        public string $TransitionID='',

        /** @var int */
        public int $PageSize=0,
        /** @var int */
        public int $PageNumber=0,
        /** @var string|null */
        public ?string $SearchCriteria=null,
        /** @var array<int>|null */
        public ?array $SelectedUserIDs=null,
        /** @var array<int>|null */
        public ?array $SelectedGroupIDs=null
    ) {
    }

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

PHP GetUsersAndGroupsForTransition DTOs

GET /api/workflowtransitions/{TransitionID}/getusersandgroups HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/xml

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

<UsersOrGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.UserInformation">
  <NumberOfAllRecords>0</NumberOfAllRecords>
  <QuickAddOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Controls.QuickLookup">
    <d2p1:QuickAddOption>
      <d2p1:EntityType>String</d2p1:EntityType>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:QuickAddOption>
  </QuickAddOptions>
  <UsersOrGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO">
    <d2p1:UserOrGroup i:nil="true" />
  </UsersOrGroups>
</UsersOrGroupsResponse>