| All Verbs | /api/primaryimage | ||
|---|---|---|---|
| All Verbs | /api/primaryimage/userprofile |
import Foundation
import ServiceStack
public class ManagePrimaryImage : Codable
{
/**
* 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")
public var contactIdOwner:String
/**
* 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")
public var file:MediaModel
/**
* 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")
public var applianceId:String
/**
* 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")
public var containerName:String
/**
* 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")
public var connectedObjectId:String
required public init(){}
}
public class MediaModel : Codable
{
public var mediaFileId:String
public var mediaName:String
public var fileContent:String
public var fileContentType:String
public var filePath:String
public var originalFileName:String
public var imageWidth:Int
public var imageHeight:Int
public var fileSizeKB:Int
public var blobUriRaw:String
public var blobUriFull:String
public var blobUriThumbnail:String
public var watermarkUri:String
public var capturedDate:Date
public var capturedByContactId:String?
public var capturedByContactName:String
public var capturedByContactThumbnailUrl:String
public var notes:String
public var resourceActionName:String
public var locationVerified:String
public var trafficLightLocationVerified:String
public var audienceLevel:String
public var worksFor:String
required public init(){}
}
public class SaveMediaResponse : Codable
{
/**
* Media File Guid
*/
// @ApiMember(DataType="Guid", Description="Media File Guid", Name="ErosMediaFileId", ParameterType="query")
public var erosMediaFileId:String
/**
* Media File Name
*/
// @ApiMember(DataType="string", Description="Media File Name", Name="MediaName", ParameterType="query")
public var mediaName:String
/**
* 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 var originalFileName:String
/**
* Url of the media file.
*/
// @ApiMember(DataType="string", Description="Url of the media file.", Name="MediaFileUrl", ParameterType="query")
public var mediaFileUrl:String
/**
* Url of the media file thumbnail.
*/
// @ApiMember(DataType="string", Description="Url of the media file thumbnail.", Name="MediaFileThumbnailUrl", ParameterType="query")
public var mediaFileThumbnailUrl:String
/**
* Service Stack Response Status.
*/
// @ApiMember(DataType="ResponseStatus", Description="Service Stack Response Status.", Name="ResponseStatus", ParameterType="query")
public var responseStatus:ResponseStatus
required public init(){}
}
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>