Platform API

<back to all web services

SaveMedia

Requires Authentication
The following routes are available for this service:
All Verbs/api/json/reply/savemedia
All Verbs/api/media
All Verbs/api/media/userprofile
"use strict";
export class SaveMediaResponse {
    /** @param {{ErosMediaFileId?:string,MediaName?:string,OriginalFileName?:string,MediaFileUrl?:string,MediaFileThumbnailUrl?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Media File Guid */
    ErosMediaFileId;
    /**
     * @type {string}
     * @description Media File Name */
    MediaName;
    /**
     * @type {string}
     * @description The original name of the media being saved. */
    OriginalFileName;
    /**
     * @type {string}
     * @description Url of the media file. */
    MediaFileUrl;
    /**
     * @type {string}
     * @description Url of the media file thumbnail. */
    MediaFileThumbnailUrl;
    /**
     * @type {ResponseStatus}
     * @description Service Stack Response Status. */
    ResponseStatus;
}
export class SaveMedia {
    /** @param {{MediaFileId?:string,MediaName?:string,MediaCaptured?:string,ContactId?:string,SessionId?:string,ApplianceId?:string,ContainerName?:string,ImageWidth?:number,ImageHeight?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The media file Id to use. */
    MediaFileId;
    /** @type {string} */
    MediaName;
    /** @type {string} */
    MediaCaptured;
    /**
     * @type {string}
     * @description The licensee's contact Id linked to the media file. */
    ContactId;
    /**
     * @type {string}
     * @description The id of the session in which the media file was created. */
    SessionId;
    /** @type {string} */
    ApplianceId;
    /** @type {string} */
    ContainerName;
    /** @type {?number} */
    ImageWidth;
    /** @type {?number} */
    ImageHeight;
}

JavaScript SaveMedia DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/json/reply/savemedia HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"MediaFileId":"00000000-0000-0000-0000-000000000000","MediaName":"String","MediaCaptured":"0001-01-01T00:00:00.0000000","ContactId":"00000000-0000-0000-0000-000000000000","SessionId":"00000000-0000-0000-0000-000000000000","ApplianceId":"00000000-0000-0000-0000-000000000000","ContainerName":"String","ImageWidth":0,"ImageHeight":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ErosMediaFileId":"00000000-0000-0000-0000-000000000000","MediaName":"String","OriginalFileName":"String","MediaFileUrl":"String","MediaFileThumbnailUrl":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}