Platform API

<back to all web services

SaveImageAsObjectPrimary

Updates the specified objects primary image with the specified Images Media File ID.

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


/** @description Updates the specified objects primary image with the specified Images Media File ID. */
// @Api(Description="Updates the specified objects primary image with the specified Images Media File ID.")
class SaveImageAsObjectPrimary implements JsonSerializable
{
    public function __construct(
        /** @description Guid of the object whose primary image details we want to update. */
        // @ApiMember(DataType="Guid", Description="Guid of the object whose primary image details we want to update.", IsRequired=true, Name="ObjectId", ParameterType="query")
        /** @var string */
        public string $ObjectId='',

        /** @description Guid of the Media File that contains details of the image we want to be primary. */
        // @ApiMember(DataType="Guid", Description="Guid of the Media File that contains details of the image we want to be primary.", IsRequired=true, Name="PrimaryImageMediaFileId", ParameterType="query")
        /** @var string */
        public string $PrimaryImageMediaFileId='',

        /** @description URL to the full image. */
        // @ApiMember(DataType="Guid", Description="URL to the full image.", IsRequired=true, Name="BlobImageURL", ParameterType="query")
        /** @var string */
        public string $BlobImageURL='',

        /** @description URL to the thumbnail image. */
        // @ApiMember(DataType="Guid", Description="URL to the thumbnail image.", IsRequired=true, Name="BlobImageURLThumbnail", ParameterType="query")
        /** @var string */
        public string $BlobImageURLThumbnail=''
    ) {
    }

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

PHP SaveImageAsObjectPrimary DTOs

POST /api/json/reply/SaveImageAsObjectPrimary HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveImageAsObjectPrimary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <BlobImageURL>String</BlobImageURL>
  <BlobImageURLThumbnail>String</BlobImageURLThumbnail>
  <ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
  <PrimaryImageMediaFileId>00000000-0000-0000-0000-000000000000</PrimaryImageMediaFileId>
</SaveImageAsObjectPrimary>

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>