| All Verbs | /api/json/reply/SaveImageAsObjectPrimary | ||
|---|---|---|---|
| All Verbs | /api/SaveImageAsObjectPrimary | ||
| All Verbs | /api/SaveImageAsObjectPrimary/userprofile |
/** @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.")
export class SaveImageAsObjectPrimary
{
/** @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")
public ObjectId: string;
/** @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")
public PrimaryImageMediaFileId: string;
/** @description URL to the full image. */
// @ApiMember(DataType="Guid", Description="URL to the full image.", IsRequired=true, Name="BlobImageURL", ParameterType="query")
public BlobImageURL: string;
/** @description URL to the thumbnail image. */
// @ApiMember(DataType="Guid", Description="URL to the thumbnail image.", IsRequired=true, Name="BlobImageURLThumbnail", ParameterType="query")
public BlobImageURLThumbnail: string;
public constructor(init?: Partial<SaveImageAsObjectPrimary>) { (Object as any).assign(this, init); }
}
TypeScript 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
}
}