Platform API

<back to all web services

AddAttachments

export class AddAttachmentsResponse
{
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<AddAttachmentsResponse>) { (Object as any).assign(this, init); }
}

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); }
}

export class AddAttachments
{
    /** @description  including file content, file type, content type and connected object. */
    // @ApiMember(DataType="string", Description=" including file content, file type, content type and connected object.", Name="Files", ParameterType="query")
    public Files: MediaModel[];

    /** @description 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 ApplianceId: string;

    /** @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;

    /** @description Licensee Id of the Object owner for which primary image is to be uploaded. */
    // @ApiMember(DataType="Guid", Description="Licensee Id of the Object owner for which primary image is to be uploaded.", IsRequired=true, Name="ConnectedObjectLicenseeId")
    public ConnectedObjectLicenseeId: string;

    public constructor(init?: Partial<AddAttachments>) { (Object as any).assign(this, init); }
}

TypeScript AddAttachments DTOs

POST /api/attachments HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Files: 
	[
		{
			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
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}