| All Verbs | /api/json/reply/SaveImageAsObjectPrimary | ||
|---|---|---|---|
| All Verbs | /api/SaveImageAsObjectPrimary | ||
| All Verbs | /api/SaveImageAsObjectPrimary/userprofile |
<?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
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/json/reply/SaveImageAsObjectPrimary HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
BlobImageURL: String,
BlobImageURLThumbnail: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}