| All Verbs | /api/primaryimage | ||
|---|---|---|---|
| All Verbs | /api/primaryimage/userprofile |
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Saguna.Common.WebAPIModel.ServiceModels
Imports Eros.Saguna.Common.WebAPIModel.Models
Namespace Global
Namespace Eros.Saguna.Common.WebAPIModel.Models
Public Partial Class MediaModel
Public Overridable Property MediaFileId As Guid
Public Overridable Property MediaName As String
Public Overridable Property FileContent As String
Public Overridable Property FileContentType As String
Public Overridable Property FilePath As String
Public Overridable Property OriginalFileName As String
Public Overridable Property ImageWidth As Integer
Public Overridable Property ImageHeight As Integer
Public Overridable Property FileSizeKB As Integer
Public Overridable Property BlobUriRaw As String
Public Overridable Property BlobUriFull As String
Public Overridable Property BlobUriThumbnail As String
Public Overridable Property WatermarkUri As String
Public Overridable Property CapturedDate As Date
Public Overridable Property CapturedByContactId As Guid?
Public Overridable Property CapturedByContactName As String
Public Overridable Property CapturedByContactThumbnailUrl As String
Public Overridable Property Notes As String
Public Overridable Property ResourceActionName As String
Public Overridable Property LocationVerified As String
Public Overridable Property TrafficLightLocationVerified As Guid
Public Overridable Property AudienceLevel As String
Public Overridable Property WorksFor As String
End Class
End Namespace
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 Overridable Property ContactIdOwner As Guid
'''<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 Overridable Property File As MediaModel
'''<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 Overridable Property ApplianceId As Guid
'''<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 Overridable Property ContainerName As String
'''<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 Overridable Property ConnectedObjectId As Guid
End Class
Public Partial Class SaveMediaResponse
'''<Summary>
'''Media File Guid
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Media File Guid", Name:="ErosMediaFileId", ParameterType:="query")>
Public Overridable Property ErosMediaFileId As Guid
'''<Summary>
'''Media File Name
'''</Summary>
<ApiMember(DataType:="string", Description:="Media File Name", Name:="MediaName", ParameterType:="query")>
Public Overridable Property MediaName As String
'''<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 Overridable Property OriginalFileName As String
'''<Summary>
'''Url of the media file.
'''</Summary>
<ApiMember(DataType:="string", Description:="Url of the media file.", Name:="MediaFileUrl", ParameterType:="query")>
Public Overridable Property MediaFileUrl As String
'''<Summary>
'''Url of the media file thumbnail.
'''</Summary>
<ApiMember(DataType:="string", Description:="Url of the media file thumbnail.", Name:="MediaFileThumbnailUrl", ParameterType:="query")>
Public Overridable Property MediaFileThumbnailUrl As String
'''<Summary>
'''Service Stack Response Status.
'''</Summary>
<ApiMember(DataType:="ResponseStatus", Description:="Service Stack Response Status.", Name:="ResponseStatus", ParameterType:="query")>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET ManagePrimaryImage DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<ManagePrimaryImage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
<ApplianceId>00000000-0000-0000-0000-000000000000</ApplianceId>
<ConnectedObjectId>00000000-0000-0000-0000-000000000000</ConnectedObjectId>
<ContactIdOwner>00000000-0000-0000-0000-000000000000</ContactIdOwner>
<ContainerName>String</ContainerName>
<File xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:AudienceLevel>String</d2p1:AudienceLevel>
<d2p1:BlobUriFull>String</d2p1:BlobUriFull>
<d2p1:BlobUriRaw>String</d2p1:BlobUriRaw>
<d2p1:BlobUriThumbnail>String</d2p1:BlobUriThumbnail>
<d2p1:CapturedByContactId>00000000-0000-0000-0000-000000000000</d2p1:CapturedByContactId>
<d2p1:CapturedByContactName>String</d2p1:CapturedByContactName>
<d2p1:CapturedByContactThumbnailUrl>String</d2p1:CapturedByContactThumbnailUrl>
<d2p1:CapturedDate>0001-01-01T00:00:00</d2p1:CapturedDate>
<d2p1:FileContent>String</d2p1:FileContent>
<d2p1:FileContentType>String</d2p1:FileContentType>
<d2p1:FilePath>String</d2p1:FilePath>
<d2p1:FileSizeKB>0</d2p1:FileSizeKB>
<d2p1:ImageHeight>0</d2p1:ImageHeight>
<d2p1:ImageWidth>0</d2p1:ImageWidth>
<d2p1:LocationVerified>String</d2p1:LocationVerified>
<d2p1:MediaFileId>00000000-0000-0000-0000-000000000000</d2p1:MediaFileId>
<d2p1:MediaName>String</d2p1:MediaName>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:OriginalFileName>String</d2p1:OriginalFileName>
<d2p1:ResourceActionName>String</d2p1:ResourceActionName>
<d2p1:TrafficLightLocationVerified>00000000-0000-0000-0000-000000000000</d2p1:TrafficLightLocationVerified>
<d2p1:WatermarkUri>String</d2p1:WatermarkUri>
<d2p1:WorksFor>String</d2p1:WorksFor>
</File>
</ManagePrimaryImage>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SaveMediaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
<ErosMediaFileId>00000000-0000-0000-0000-000000000000</ErosMediaFileId>
<MediaFileThumbnailUrl>String</MediaFileThumbnailUrl>
<MediaFileUrl>String</MediaFileUrl>
<MediaName>String</MediaName>
<OriginalFileName>String</OriginalFileName>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</SaveMediaResponse>