Platform API

<back to all web services

ManagePrimaryImage

Requires Authentication
The following routes are available for this service:
All Verbs/api/primaryimage
All Verbs/api/primaryimage/userprofile
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Saguna.Common.WebAPIModel.ServiceModels;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class MediaModel
    {
        public virtual Guid MediaFileId { get; set; }
        public virtual string MediaName { get; set; }
        public virtual string FileContent { get; set; }
        public virtual string FileContentType { get; set; }
        public virtual string FilePath { get; set; }
        public virtual string OriginalFileName { get; set; }
        public virtual int ImageWidth { get; set; }
        public virtual int ImageHeight { get; set; }
        public virtual int FileSizeKB { get; set; }
        public virtual string BlobUriRaw { get; set; }
        public virtual string BlobUriFull { get; set; }
        public virtual string BlobUriThumbnail { get; set; }
        public virtual string WatermarkUri { get; set; }
        public virtual DateTime CapturedDate { get; set; }
        public virtual Guid? CapturedByContactId { get; set; }
        public virtual string CapturedByContactName { get; set; }
        public virtual string CapturedByContactThumbnailUrl { get; set; }
        public virtual string Notes { get; set; }
        public virtual string ResourceActionName { get; set; }
        public virtual string LocationVerified { get; set; }
        public virtual Guid TrafficLightLocationVerified { get; set; }
        public virtual string AudienceLevel { get; set; }
        public virtual string WorksFor { get; set; }
    }

}

namespace Eros.Saguna.Common.WebAPIModel.ServiceModels
{
    public partial class ManagePrimaryImage
    {
        ///<summary>
        ///The licensee's contact Id linked to the media file.
        ///</summary>
        [ApiMember(DataType="Guid", Description="The licensee's contact Id linked to the media file.", IsRequired=true, Name="ContactIdOwner", ParameterType="query")]
        public virtual Guid ContactIdOwner { get; set; }

        ///<summary>
        ///Primary image file to be uploaded including file type and content type.
        ///</summary>
        [ApiMember(DataType="MediaModel", Description="Primary image file to be uploaded including file type and content type.", IsRequired=true, Name="File")]
        public virtual MediaModel File { get; set; }

        ///<summary>
        ///Appliance from which primary image file is to be uploaded.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Appliance from which primary image file is to be uploaded.", IsRequired=true, Name="ApplianceId")]
        public virtual Guid ApplianceId { get; set; }

        ///<summary>
        ///Blob storage container to which primary image file is to be uploaded.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Blob storage container to which primary image file is to be uploaded.", IsRequired=true, Name="ContainerName")]
        public virtual string ContainerName { get; set; }

        ///<summary>
        ///Object for which primary image is to be uploaded.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Object for which primary image is to be uploaded.", IsRequired=true, Name="ConnectedObjectId")]
        public virtual Guid ConnectedObjectId { get; set; }
    }

    public partial class SaveMediaResponse
    {
        ///<summary>
        ///Media File Guid
        ///</summary>
        [ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")]
        public virtual Guid ErosMediaFileId { get; set; }

        ///<summary>
        ///Media File Name
        ///</summary>
        [ApiMember(DataType="string", Description="Media File Name", Name="MediaName", ParameterType="query")]
        public virtual string MediaName { get; set; }

        ///<summary>
        ///The original name of the media being saved.
        ///</summary>
        [ApiMember(DataType="string", Description="The original name of the media being saved.", Name="OriginalFileName", ParameterType="query")]
        public virtual string OriginalFileName { get; set; }

        ///<summary>
        ///Url of the media file.
        ///</summary>
        [ApiMember(DataType="string", Description="Url of the media file.", Name="MediaFileUrl", ParameterType="query")]
        public virtual string MediaFileUrl { get; set; }

        ///<summary>
        ///Url of the media file thumbnail.
        ///</summary>
        [ApiMember(DataType="string", Description="Url of the media file thumbnail.", Name="MediaFileThumbnailUrl", ParameterType="query")]
        public virtual string MediaFileThumbnailUrl { get; set; }

        ///<summary>
        ///Service Stack Response Status.
        ///</summary>
        [ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# ManagePrimaryImage 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/primaryimage HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ContactIdOwner":"00000000-0000-0000-0000-000000000000","File":{"MediaFileId":"00000000-0000-0000-0000-000000000000","MediaName":"String","FileContent":"String","FileContentType":"String","FilePath":"String","OriginalFileName":"String","ImageWidth":0,"ImageHeight":0,"FileSizeKB":0,"BlobUriRaw":"String","BlobUriFull":"String","BlobUriThumbnail":"String","WatermarkUri":"String","CapturedDate":"0001-01-01T00:00:00.0000000","CapturedByContactId":"00000000000000000000000000000000","CapturedByContactName":"String","CapturedByContactThumbnailUrl":"String","Notes":"String","ResourceActionName":"String","LocationVerified":"String","TrafficLightLocationVerified":"00000000-0000-0000-0000-000000000000","AudienceLevel":"String","WorksFor":"String"},"ApplianceId":"00000000-0000-0000-0000-000000000000","ContainerName":"String","ConnectedObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}