Platform API

<back to all web services

UploadFile

Requires Authentication
The following routes are available for this service:
All Verbs/api/media/file

export class SaveMediaResponse
{
    /** @description Media File Guid */
    // @ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")
    public ErosMediaFileId: string;

    /** @description Media File Name */
    // @ApiMember(DataType="string", Description="Media File Name", Name="MediaName", ParameterType="query")
    public MediaName: string;

    /** @description The original name of the media being saved. */
    // @ApiMember(DataType="string", Description="The original name of the media being saved.", Name="OriginalFileName", ParameterType="query")
    public OriginalFileName: string;

    /** @description Url of the media file. */
    // @ApiMember(DataType="string", Description="Url of the media file.", Name="MediaFileUrl", ParameterType="query")
    public MediaFileUrl: string;

    /** @description Url of the media file thumbnail. */
    // @ApiMember(DataType="string", Description="Url of the media file thumbnail.", Name="MediaFileThumbnailUrl", ParameterType="query")
    public MediaFileThumbnailUrl: string;

    /** @description Service Stack Response Status. */
    // @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<SaveMediaResponse>) { (Object as any).assign(this, init); }
}

export class UploadFile
{
    public Path: string;
    public MediaCaptured: string;
    public ContactId: string;
    public ApplianceId: string;
    public ImageWidth?: number;
    public ImageHeight?: number;

    public constructor(init?: Partial<UploadFile>) { (Object as any).assign(this, init); }
}

TypeScript UploadFile DTOs

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

HTTP + JSV

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

POST /api/media/file HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Path: String,
	MediaCaptured: 0001-01-01,
	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
		}
	}
}