| All Verbs | /api/attachments/{ConnectedObjectId} |
|---|
export class MediaModel
{
public MediaFileId: string;
public MediaName: string;
public FileContent: string;
public FileContentType: string;
public FilePath: string;
public OriginalFileName: string;
public ImageWidth: number;
public ImageHeight: number;
public FileSizeKB: number;
public BlobUriRaw: string;
public BlobUriFull: string;
public BlobUriThumbnail: string;
public WatermarkUri: string;
public CapturedDate: string;
public CapturedByContactId?: string;
public CapturedByContactName: string;
public CapturedByContactThumbnailUrl: string;
public Notes: string;
public ResourceActionName: string;
public LocationVerified: string;
public TrafficLightLocationVerified: string;
public AudienceLevel: string;
public WorksFor: string;
public constructor(init?: Partial<MediaModel>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="Returns list of attachments linked to an object.")
export class GetAttachmentsResponse
{
public Attachments: MediaModel[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetAttachmentsResponse>) { (Object as any).assign(this, init); }
}
export class GetAttachments
{
/** @description 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 ConnectedObjectId: string;
public constructor(init?: Partial<GetAttachments>) { (Object as any).assign(this, init); }
}
TypeScript GetAttachments DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ConnectedObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Attachments":[{"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"}}}