| All Verbs | /api/attachments/{ConnectedObjectId} |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class GetAttachments
{
/**
* 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 UUID ConnectedObjectId = null;
public UUID getConnectedObjectId() { return ConnectedObjectId; }
public GetAttachments setConnectedObjectId(UUID value) { this.ConnectedObjectId = value; return this; }
}
@ApiResponse(Description="Returns list of attachments linked to an object.")
public static class GetAttachmentsResponse
{
public ArrayList<MediaModel> Attachments = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<MediaModel> getAttachments() { return Attachments; }
public GetAttachmentsResponse setAttachments(ArrayList<MediaModel> value) { this.Attachments = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetAttachmentsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class MediaModel
{
public UUID MediaFileId = null;
public String MediaName = null;
public String FileContent = null;
public String FileContentType = null;
public String FilePath = null;
public String OriginalFileName = null;
public Integer ImageWidth = null;
public Integer ImageHeight = null;
public Integer FileSizeKB = null;
public String BlobUriRaw = null;
public String BlobUriFull = null;
public String BlobUriThumbnail = null;
public String WatermarkUri = null;
public Date CapturedDate = null;
public UUID CapturedByContactId = null;
public String CapturedByContactName = null;
public String CapturedByContactThumbnailUrl = null;
public String Notes = null;
public String ResourceActionName = null;
public String LocationVerified = null;
public UUID TrafficLightLocationVerified = null;
public String AudienceLevel = null;
public String WorksFor = null;
public UUID getMediaFileId() { return MediaFileId; }
public MediaModel setMediaFileId(UUID value) { this.MediaFileId = value; return this; }
public String getMediaName() { return MediaName; }
public MediaModel setMediaName(String value) { this.MediaName = value; return this; }
public String getFileContent() { return FileContent; }
public MediaModel setFileContent(String value) { this.FileContent = value; return this; }
public String getFileContentType() { return FileContentType; }
public MediaModel setFileContentType(String value) { this.FileContentType = value; return this; }
public String getFilePath() { return FilePath; }
public MediaModel setFilePath(String value) { this.FilePath = value; return this; }
public String getOriginalFileName() { return OriginalFileName; }
public MediaModel setOriginalFileName(String value) { this.OriginalFileName = value; return this; }
public Integer getImageWidth() { return ImageWidth; }
public MediaModel setImageWidth(Integer value) { this.ImageWidth = value; return this; }
public Integer getImageHeight() { return ImageHeight; }
public MediaModel setImageHeight(Integer value) { this.ImageHeight = value; return this; }
public Integer getFileSizeKB() { return FileSizeKB; }
public MediaModel setFileSizeKB(Integer value) { this.FileSizeKB = value; return this; }
public String getBlobUriRaw() { return BlobUriRaw; }
public MediaModel setBlobUriRaw(String value) { this.BlobUriRaw = value; return this; }
public String getBlobUriFull() { return BlobUriFull; }
public MediaModel setBlobUriFull(String value) { this.BlobUriFull = value; return this; }
public String getBlobUriThumbnail() { return BlobUriThumbnail; }
public MediaModel setBlobUriThumbnail(String value) { this.BlobUriThumbnail = value; return this; }
public String getWatermarkUri() { return WatermarkUri; }
public MediaModel setWatermarkUri(String value) { this.WatermarkUri = value; return this; }
public Date getCapturedDate() { return CapturedDate; }
public MediaModel setCapturedDate(Date value) { this.CapturedDate = value; return this; }
public UUID getCapturedByContactId() { return CapturedByContactId; }
public MediaModel setCapturedByContactId(UUID value) { this.CapturedByContactId = value; return this; }
public String getCapturedByContactName() { return CapturedByContactName; }
public MediaModel setCapturedByContactName(String value) { this.CapturedByContactName = value; return this; }
public String getCapturedByContactThumbnailUrl() { return CapturedByContactThumbnailUrl; }
public MediaModel setCapturedByContactThumbnailUrl(String value) { this.CapturedByContactThumbnailUrl = value; return this; }
public String getNotes() { return Notes; }
public MediaModel setNotes(String value) { this.Notes = value; return this; }
public String getResourceActionName() { return ResourceActionName; }
public MediaModel setResourceActionName(String value) { this.ResourceActionName = value; return this; }
public String getLocationVerified() { return LocationVerified; }
public MediaModel setLocationVerified(String value) { this.LocationVerified = value; return this; }
public UUID getTrafficLightLocationVerified() { return TrafficLightLocationVerified; }
public MediaModel setTrafficLightLocationVerified(UUID value) { this.TrafficLightLocationVerified = value; return this; }
public String getAudienceLevel() { return AudienceLevel; }
public MediaModel setAudienceLevel(String value) { this.AudienceLevel = value; return this; }
public String getWorksFor() { return WorksFor; }
public MediaModel setWorksFor(String value) { this.WorksFor = value; return this; }
}
}
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
}
}
}