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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Updates the specified objects primary image with the specified Images Media File ID.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveImageAsObjectPrimary:
    """
    Updates the specified objects primary image with the specified Images Media File ID.
    """

    # @ApiMember(DataType="Guid", Description="Guid of the object whose primary image details we want to update.", IsRequired=true, Name="ObjectId", ParameterType="query")
    object_id: Optional[str] = None
    """
    Guid of the object whose primary image details we want to update.
    """


    # @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")
    primary_image_media_file_id: Optional[str] = None
    """
    Guid of the Media File that contains details of the image we want to be primary.
    """


    # @ApiMember(DataType="Guid", Description="URL to the full image.", IsRequired=true, Name="BlobImageURL", ParameterType="query")
    blob_image_u_r_l: Optional[str] = None
    """
    URL to the full image.
    """


    # @ApiMember(DataType="Guid", Description="URL to the thumbnail image.", IsRequired=true, Name="BlobImageURLThumbnail", ParameterType="query")
    blob_image_u_r_l_thumbnail: Optional[str] = None
    """
    URL to the thumbnail image.
    """

Python SaveImageAsObjectPrimary 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 /api/json/reply/SaveImageAsObjectPrimary HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ObjectId":"00000000-0000-0000-0000-000000000000","PrimaryImageMediaFileId":"00000000-0000-0000-0000-000000000000","BlobImageURL":"String","BlobImageURLThumbnail":"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"}}