| All Verbs | /api/primaryimage | ||
|---|---|---|---|
| All Verbs | /api/primaryimage/userprofile |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class ManagePrimaryImage
{
/**
* The licensee's contact Id linked to the media file.
*/
@ApiMember(DataType="Guid", Description="The licensee's contact Id linked to the media file.", IsRequired=true, Name="ContactIdOwner", ParameterType="query")
open var ContactIdOwner:UUID? = null
/**
* Primary image file to be uploaded including file type and content type.
*/
@ApiMember(DataType="MediaModel", Description="Primary image file to be uploaded including file type and content type.", IsRequired=true, Name="File")
open var File:MediaModel? = null
/**
* Appliance from which primary image file is to be uploaded.
*/
@ApiMember(DataType="Guid", Description="Appliance from which primary image file is to be uploaded.", IsRequired=true, Name="ApplianceId")
open var ApplianceId:UUID? = null
/**
* Blob storage container to which primary image file is to be uploaded.
*/
@ApiMember(DataType="Guid", Description="Blob storage container to which primary image file is to be uploaded.", IsRequired=true, Name="ContainerName")
open var ContainerName:String? = null
/**
* Object for which primary image is to be uploaded.
*/
@ApiMember(DataType="Guid", Description="Object for which primary image is to be uploaded.", IsRequired=true, Name="ConnectedObjectId")
open var ConnectedObjectId:UUID? = null
}
open class MediaModel
{
open var MediaFileId:UUID? = null
open var MediaName:String? = null
open var FileContent:String? = null
open var FileContentType:String? = null
open var FilePath:String? = null
open var OriginalFileName:String? = null
open var ImageWidth:Int? = null
open var ImageHeight:Int? = null
open var FileSizeKB:Int? = null
open var BlobUriRaw:String? = null
open var BlobUriFull:String? = null
open var BlobUriThumbnail:String? = null
open var WatermarkUri:String? = null
open var CapturedDate:Date? = null
open var CapturedByContactId:UUID? = null
open var CapturedByContactName:String? = null
open var CapturedByContactThumbnailUrl:String? = null
open var Notes:String? = null
open var ResourceActionName:String? = null
open var LocationVerified:String? = null
open var TrafficLightLocationVerified:UUID? = null
open var AudienceLevel:String? = null
open var WorksFor:String? = null
}
open class SaveMediaResponse
{
/**
* Media File Guid
*/
@ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")
open var ErosMediaFileId:UUID? = null
/**
* Media File Name
*/
@ApiMember(DataType="string", Description="Media File Name", Name="MediaName", ParameterType="query")
open var MediaName:String? = null
/**
* The original name of the media being saved.
*/
@ApiMember(DataType="string", Description="The original name of the media being saved.", Name="OriginalFileName", ParameterType="query")
open var OriginalFileName:String? = null
/**
* Url of the media file.
*/
@ApiMember(DataType="string", Description="Url of the media file.", Name="MediaFileUrl", ParameterType="query")
open var MediaFileUrl:String? = null
/**
* Url of the media file thumbnail.
*/
@ApiMember(DataType="string", Description="Url of the media file thumbnail.", Name="MediaFileThumbnailUrl", ParameterType="query")
open var MediaFileThumbnailUrl:String? = null
/**
* Service Stack Response Status.
*/
@ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
open var ResponseStatus:ResponseStatus? = null
}
Kotlin ManagePrimaryImage DTOs
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
}
}
}