Platform API

<back to all web services

SaveImageAsObjectPrimary

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

Requires Authentication
The following routes are available for this service:
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 .xml suffix or ?format=xml

HTTP + XML

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: 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>