Platform Subscription API

<back to all web services

SaveObjectDynamicContent

Inserts or Updates dynamic content for an object.

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 DynamicContentModel implements JsonSerializable
{
    public function __construct(
        /** @description Dynamic Content Definition indicating the content type. */
        // @ApiMember(DataType="DynamicContentModel", Description="Dynamic Content Definition indicating the content type.", IsRequired=true, Name="DynamicContentDefinitionId")
        /** @var string */
        public string $DynamicContentDefinitionId='',

        /** @description Guid indicating the content format. Not required to be passed. */
        // @ApiMember(DataType="DynamicContentModel", Description="Guid indicating the content format. Not required to be passed.", Name="ContentFormatId")
        /** @var string */
        public string $ContentFormatId='',

        /** @description Actual Content to be added to the object. */
        // @ApiMember(DataType="DynamicContentModel", Description="Actual Content to be added to the object.", IsRequired=true, Name="Content")
        /** @var string */
        public string $Content=''
    ) {
    }

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

/** @description Inserts or Updates dynamic content for an object. */
// @Api(Description="Inserts or Updates dynamic content for an object.")
class SaveObjectDynamicContent implements ISubscription, 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 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.", IsRequired=true, Name="AlternateKey")
        /** @var string */
        public string $AlternateKey='',

        /** @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='',

        /** @description Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update. */
        // @ApiMember(DataType="Guid", Description="Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update.", Name="RmsTableCtxId")
        /** @var string */
        public string $RmsTableCtxId='',

        /** @var bool|null */
        public ?bool $IgnoreValidation=null,
        /** @description Dynamic Content to be added to the object. */
        // @ApiMember(DataType="DynamicContentModel", Description="Dynamic Content to be added to the object.", IsRequired=true, Name="DynamicContent")
        /** @var DynamicContentModel|null */
        public ?DynamicContentModel $DynamicContent=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SuiteDataSourceInstanceId'])) $this->SuiteDataSourceInstanceId = $o['SuiteDataSourceInstanceId'];
        if (isset($o['AlternateKey'])) $this->AlternateKey = $o['AlternateKey'];
        if (isset($o['ObjectId'])) $this->ObjectId = $o['ObjectId'];
        if (isset($o['RmsTableCtxId'])) $this->RmsTableCtxId = $o['RmsTableCtxId'];
        if (isset($o['IgnoreValidation'])) $this->IgnoreValidation = $o['IgnoreValidation'];
        if (isset($o['DynamicContent'])) $this->DynamicContent = JsonConverters::from('DynamicContentModel', $o['DynamicContent']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SuiteDataSourceInstanceId)) $o['SuiteDataSourceInstanceId'] = $this->SuiteDataSourceInstanceId;
        if (isset($this->AlternateKey)) $o['AlternateKey'] = $this->AlternateKey;
        if (isset($this->ObjectId)) $o['ObjectId'] = $this->ObjectId;
        if (isset($this->RmsTableCtxId)) $o['RmsTableCtxId'] = $this->RmsTableCtxId;
        if (isset($this->IgnoreValidation)) $o['IgnoreValidation'] = $this->IgnoreValidation;
        if (isset($this->DynamicContent)) $o['DynamicContent'] = JsonConverters::to('DynamicContentModel', $this->DynamicContent);
        return empty($o) ? new class(){} : $o;
    }
}

PHP SaveObjectDynamicContent DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/SaveObjectDynamicContent HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"AlternateKey":"String","IgnoreValidation":false,"DynamicContent":{"Content":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}