Platform API

GetMediaImages

The following routes are available for this service:
All Verbs	/api/mediaImages/{ObjectId}

import Foundation
import ServiceStack

public class GetMediaImages : Codable
{
    /**
    * 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="ObjectId")
    public var objectId:String

    required public init(){}
}

// @ApiResponse(Description="Returns list of images linked to an object.")
public class GetMediaImagesResponse : Codable
{
    public var images:[MediaModel]
    public var responseStatus:ResponseStatus

    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(){}
}

Swift GetMediaImages 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/mediaImages/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ObjectId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Images":[{"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"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}