| 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;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
MediaName: String,
MediaCaptured: 0001-01-01,
ContainerName: String,
ImageWidth: 0,
ImageHeight: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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
}
}
}