Platform Subscription API

<back to all web services

SaveCustomContentFWECM

Saves Framework ECM data into EROS for linked objects.

<?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 SubscriptionCustomContentModel implements JsonSerializable
{
    public function __construct(
        /** @description Guid representing the external systems datasource information. */
        // @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId")
        /** @var string */
        public string $SuiteDataSourceInstanceId='',

        /** @description Eros RmsTableCtxId of the object we are saving custom content to. */
        // @ApiMember(DataType="Guid", Description="Eros RmsTableCtxId of the object we are saving custom content to.", IsRequired=true, Name="RmsTableCtxId")
        /** @var string */
        public string $RmsTableCtxId='',

        /** @description The unique key that represents the object on the external system. */
        // @ApiMember(DataType="string", Description="The unique key that represents the object on the external system.", Name="AlternateKey")
        /** @var string|null */
        public ?string $AlternateKey=null,

        /** @description Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key. */
        // @ApiMember(DataType="Guid", Description="Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId")
        /** @var string */
        public string $ObjectId='',

        /** @var bool|null */
        public ?bool $IgnoreValidation=null,
        /** @description RmsFieldCtxId of the external ECM field that is used to link with the Custom Content Field in Eros. */
        // @ApiMember(DataType="int", Description="RmsFieldCtxId of the external ECM field that is used to link with the Custom Content Field in Eros.", IsRequired=true, Name="RmsFieldCtxId")
        /** @var int */
        public int $RmsFieldCtxId=0,

        /** @description Value to be saved for the object. */
        // @ApiMember(DataType="string", Description="Value to be saved for the object.", Name="Value")
        /** @var string|null */
        public ?string $Value=null,

        /** @var string */
        public string $LicenseeId='',
        /** @var string */
        public string $SessionId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SuiteDataSourceInstanceId'])) $this->SuiteDataSourceInstanceId = $o['SuiteDataSourceInstanceId'];
        if (isset($o['RmsTableCtxId'])) $this->RmsTableCtxId = $o['RmsTableCtxId'];
        if (isset($o['AlternateKey'])) $this->AlternateKey = $o['AlternateKey'];
        if (isset($o['ObjectId'])) $this->ObjectId = $o['ObjectId'];
        if (isset($o['IgnoreValidation'])) $this->IgnoreValidation = $o['IgnoreValidation'];
        if (isset($o['RmsFieldCtxId'])) $this->RmsFieldCtxId = $o['RmsFieldCtxId'];
        if (isset($o['Value'])) $this->Value = $o['Value'];
        if (isset($o['LicenseeId'])) $this->LicenseeId = $o['LicenseeId'];
        if (isset($o['SessionId'])) $this->SessionId = $o['SessionId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SuiteDataSourceInstanceId)) $o['SuiteDataSourceInstanceId'] = $this->SuiteDataSourceInstanceId;
        if (isset($this->RmsTableCtxId)) $o['RmsTableCtxId'] = $this->RmsTableCtxId;
        if (isset($this->AlternateKey)) $o['AlternateKey'] = $this->AlternateKey;
        if (isset($this->ObjectId)) $o['ObjectId'] = $this->ObjectId;
        if (isset($this->IgnoreValidation)) $o['IgnoreValidation'] = $this->IgnoreValidation;
        if (isset($this->RmsFieldCtxId)) $o['RmsFieldCtxId'] = $this->RmsFieldCtxId;
        if (isset($this->Value)) $o['Value'] = $this->Value;
        if (isset($this->LicenseeId)) $o['LicenseeId'] = $this->LicenseeId;
        if (isset($this->SessionId)) $o['SessionId'] = $this->SessionId;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Saves Framework ECM data into EROS for linked objects. */
// @Api(Description="Saves Framework ECM data into EROS for linked objects.")
class SaveCustomContentFWECM implements JsonSerializable
{
    public function __construct(
        /** @description To pass bulk upload of data to save for objects. */
        // @ApiMember(DataType="List<SubscriptionCustomContentModel>", Description="To pass bulk upload of data to save for objects.", IsRequired=true, Name="CustomContents")
        /** @var array<SubscriptionCustomContentModel>|null */
        public ?array $CustomContents=null
    ) {
    }

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

PHP SaveCustomContentFWECM DTOs

POST /api/rmsdataexchange/bulk/project HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveCustomContentFWECM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
  <CustomContents xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
    <d2p1:SubscriptionCustomContentModel>
      <d2p1:_x003C_AlternateKey_x003E_k__BackingField>String</d2p1:_x003C_AlternateKey_x003E_k__BackingField>
      <d2p1:_x003C_LicenseeId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_LicenseeId_x003E_k__BackingField>
      <d2p1:_x003C_ObjectId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ObjectId_x003E_k__BackingField>
      <d2p1:_x003C_RmsFieldCtxId_x003E_k__BackingField>0</d2p1:_x003C_RmsFieldCtxId_x003E_k__BackingField>
      <d2p1:_x003C_RmsTableCtxId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_RmsTableCtxId_x003E_k__BackingField>
      <d2p1:_x003C_SessionId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SessionId_x003E_k__BackingField>
      <d2p1:_x003C_SuiteDataSourceInstanceId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_SuiteDataSourceInstanceId_x003E_k__BackingField>
      <d2p1:_x003C_Value_x003E_k__BackingField>String</d2p1:_x003C_Value_x003E_k__BackingField>
    </d2p1:SubscriptionCustomContentModel>
  </CustomContents>
</SaveCustomContentFWECM>

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

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>