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 Foundation
import ServiceStack

/**
* 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.")
public class SaveImageAsObjectPrimary : Codable
{
    /**
    * 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 var objectId:String

    /**
    * 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 var primaryImageMediaFileId:String

    /**
    * URL to the full image.
    */
    // @ApiMember(DataType="Guid", Description="URL to the full image.", IsRequired=true, Name="BlobImageURL", ParameterType="query")
    public var blobImageURL:String

    /**
    * URL to the thumbnail image.
    */
    // @ApiMember(DataType="Guid", Description="URL to the thumbnail image.", IsRequired=true, Name="BlobImageURLThumbnail", ParameterType="query")
    public var blobImageURLThumbnail:String

    required public init(){}
}

Swift SaveImageAsObjectPrimary DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}