<back to all web services

WorkflowOperationMessage

<?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};


enum InlineEditingOperation : string
{
    case Publish = 'Publish';
    case SaveAsDraft = 'SaveAsDraft';
    case Custom = 'Custom';
}

class ItemContextModel implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ItemId=null,
        /** @var string|null */
        public ?string $ItemType=null,
        /** @var string|null */
        public ?string $Provider=null,
        /** @var FieldValueModel[]|null */
        public ?array $FieldValues=null
    ) {
    }

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

class WorkflowOperationMessage implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $PageId=null,
        /** @var InlineEditingOperation|null */
        public ?InlineEditingOperation $WorkflowOperation=null,
        /** @var string|null */
        public ?string $CustomWorkflowOperation=null,
        /** @var array<ItemContextModel>|null */
        public ?array $Items=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['PageId'])) $this->PageId = $o['PageId'];
        if (isset($o['WorkflowOperation'])) $this->WorkflowOperation = JsonConverters::from('InlineEditingOperation', $o['WorkflowOperation']);
        if (isset($o['CustomWorkflowOperation'])) $this->CustomWorkflowOperation = $o['CustomWorkflowOperation'];
        if (isset($o['Items'])) $this->Items = JsonConverters::fromArray('ItemContextModel', $o['Items']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->PageId)) $o['PageId'] = $this->PageId;
        if (isset($this->WorkflowOperation)) $o['WorkflowOperation'] = JsonConverters::to('InlineEditingOperation', $this->WorkflowOperation);
        if (isset($this->CustomWorkflowOperation)) $o['CustomWorkflowOperation'] = $this->CustomWorkflowOperation;
        if (isset($this->Items)) $o['Items'] = JsonConverters::toArray('ItemContextModel', $this->Items);
        return empty($o) ? new class(){} : $o;
    }
}

class FieldValueModel implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Name=null,
        /** @var Object|null */
        public ?Object $Value=null,
        /** @var FieldValueModel[]|null */
        public ?array $ComplexValue=null
    ) {
    }

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

PHP WorkflowOperationMessage DTOs

POST /RestApi/sitefinity/inlineediting/workflow HTTP/1.1 
Host: www.asg.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<WorkflowOperationMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Services.InlineEditing.Messages">
  <CustomWorkflowOperation>String</CustomWorkflowOperation>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Services.InlineEditing">
    <d2p1:ItemContextModel>
      <d2p1:FieldValues>
        <d2p1:FieldValueModel>
          <d2p1:ComplexValue>
            <d2p1:FieldValueModel>
              <d2p1:ComplexValue>
                <d2p1:FieldValueModel>
                  <d2p1:ComplexValue i:nil="true" />
                  <d2p1:Name>String</d2p1:Name>
                  <d2p1:Value />
                </d2p1:FieldValueModel>
              </d2p1:ComplexValue>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:Value />
            </d2p1:FieldValueModel>
          </d2p1:ComplexValue>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Value />
        </d2p1:FieldValueModel>
      </d2p1:FieldValues>
      <d2p1:ItemId>String</d2p1:ItemId>
      <d2p1:ItemType>String</d2p1:ItemType>
      <d2p1:Provider>String</d2p1:Provider>
    </d2p1:ItemContextModel>
  </Items>
  <PageId>String</PageId>
  <WorkflowOperation>Publish</WorkflowOperation>
</WorkflowOperationMessage>

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

<ArrayOfBaseWorkflowOperationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Services.InlineEditing">
  <BaseWorkflowOperationModel>
    <DetailsViewUrl>String</DetailsViewUrl>
    <ItemId>00000000-0000-0000-0000-000000000000</ItemId>
    <ItemName>String</ItemName>
    <ItemStatus>
      <DisplayStatus>String</DisplayStatus>
      <IsAdmin>false</IsAdmin>
      <IsEditable>false</IsEditable>
      <IsLocked>false</IsLocked>
      <IsLockedByMe>false</IsLockedByMe>
      <IsPublished>false</IsPublished>
      <IsStatusEditable>false</IsStatusEditable>
      <LockedByUsername>String</LockedByUsername>
      <WorkflowStatus>String</WorkflowStatus>
    </ItemStatus>
    <ItemType>String</ItemType>
    <ProviderName>String</ProviderName>
  </BaseWorkflowOperationModel>
</ArrayOfBaseWorkflowOperationModel>