| All Verbs | /api/primaryimage | ||
|---|---|---|---|
| All Verbs | /api/primaryimage/userprofile |
namespace Eros.Saguna.Common.WebAPIModel.Models
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type SaveMediaResponse() =
///<summary>
///Media File Guid
///</summary>
[<ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")>]
member val ErosMediaFileId:Guid = new Guid() with get,set
///<summary>
///Media File Name
///</summary>
[<ApiMember(DataType="string", Description="Media File Name", Name="MediaName", ParameterType="query")>]
member val MediaName:String = null with 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")>]
member val OriginalFileName:String = null with get,set
///<summary>
///Url of the media file.
///</summary>
[<ApiMember(DataType="string", Description="Url of the media file.", Name="MediaFileUrl", ParameterType="query")>]
member val MediaFileUrl:String = null with get,set
///<summary>
///Url of the media file thumbnail.
///</summary>
[<ApiMember(DataType="string", Description="Url of the media file thumbnail.", Name="MediaFileThumbnailUrl", ParameterType="query")>]
member val MediaFileThumbnailUrl:String = null with get,set
///<summary>
///Service Stack Response Status.
///</summary>
[<ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")>]
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type MediaModel() =
member val MediaFileId:Guid = new Guid() with get,set
member val MediaName:String = null with get,set
member val FileContent:String = null with get,set
member val FileContentType:String = null with get,set
member val FilePath:String = null with get,set
member val OriginalFileName:String = null with get,set
member val ImageWidth:Int32 = new Int32() with get,set
member val ImageHeight:Int32 = new Int32() with get,set
member val FileSizeKB:Int32 = new Int32() with get,set
member val BlobUriRaw:String = null with get,set
member val BlobUriFull:String = null with get,set
member val BlobUriThumbnail:String = null with get,set
member val WatermarkUri:String = null with get,set
member val CapturedDate:DateTime = new DateTime() with get,set
member val CapturedByContactId:Nullable<Guid> = new Nullable<Guid>() with get,set
member val CapturedByContactName:String = null with get,set
member val CapturedByContactThumbnailUrl:String = null with get,set
member val Notes:String = null with get,set
member val ResourceActionName:String = null with get,set
member val LocationVerified:String = null with get,set
member val TrafficLightLocationVerified:Guid = new Guid() with get,set
member val AudienceLevel:String = null with get,set
member val WorksFor:String = null with get,set
[<AllowNullLiteral>]
type 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")>]
member val ContactIdOwner:Guid = new Guid() with 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")>]
member val File:MediaModel = null with 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")>]
member val ApplianceId:Guid = new Guid() with 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")>]
member val ContainerName:String = null with 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")>]
member val ConnectedObjectId:Guid = new Guid() with get,set
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/primaryimage HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
File:
{
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-01,
CapturedByContactId: 00000000000000000000000000000000,
CapturedByContactName: String,
CapturedByContactThumbnailUrl: String,
Notes: String,
ResourceActionName: String,
LocationVerified: String,
AudienceLevel: String,
WorksFor: String
},
ContainerName: String
}
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
}
}
}