| All Verbs | /api/attachments/{ConnectedObjectId} |
|---|
import Foundation
import ServiceStack
public class GetAttachments : 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="ConnectedObjectId")
public var connectedObjectId:String
required public init(){}
}
// @ApiResponse(Description="Returns list of attachments linked to an object.")
public class GetAttachmentsResponse : Codable
{
public var attachments:[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(){}
}
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/attachments/{ConnectedObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Attachments:
[
{
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
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}