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
"use strict";
export class SaveImageAsObjectPrimary {
    /** @param {{ObjectId?:string,PrimaryImageMediaFileId?:string,BlobImageURL?:string,BlobImageURLThumbnail?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Guid of the object whose primary image details we want to update. */
    ObjectId;
    /**
     * @type {string}
     * @description Guid of the Media File that contains details of the image we want to be primary. */
    PrimaryImageMediaFileId;
    /**
     * @type {string}
     * @description URL to the full image. */
    BlobImageURL;
    /**
     * @type {string}
     * @description URL to the thumbnail image. */
    BlobImageURLThumbnail;
}

JavaScript 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"}}