Aurigma Image Uploader 5.0 Dual
POST Field Reference

This topic contains a information which POST fields can be sent by Image Uploader. Use it when writing the server-side upload processing code. You should extract them in the same manner as if they were sent through the standard HTML form. See code samples for more details how to work with them.

In this topic:

- Standard Fields
- Additional Fields
- EXIF And IPTC Fields
- Hash Fields

# Standard Fields

The table below contains list of POST fields that are generated and uploaded by Image Uploader.

Name | Type | Description | Upload Conditions
--- | --- | --- | ---
Upload Information
PackageIndex | Integer | Zero-based index of the package (i.e. request) inside the current upload session. Using this field you can recognize the order of uploaded files if they are sent in different packages. | Always uploaded, however makes sense only when you upload files in several requests (i.e. the FilesPerOnePackageCount property is not equal to -1)
PackageCount | Integer | Total number of packages in the current upload session. In particular, when FilesPerOnePackageCount is 1, it can be used to get total number of files uploaded within this upload session. | The same.
PackageGuid | GUID | Unique identifier of the current upload session. When the upload is separated into several packages, all of them will have the same GUID. So you can use it to determine whether files are uploaded in the same session (useful for concurrent uploads from several users). | The same.
FileCount | Integer | Number of files uploaded in a request. To get the total number of files sent in a single upload session, multiply this value by the PackageCount. | Always uploaded.
Original File Information
SourceFile_N * | File | Original Nth file. | Uploaded when the UploadSourceFile property is true.
FileName_N * | String | Name of the original Nth file. If entire folder is uploaded, this filename includes a folder structure, i.e. relative path of the file (relatively the folder which is being uploaded, including this folder name). It is useful to use this file to get name of the original file when only resized copy of an image is uploaded (as in the Optimized Upload Sample). | Always uploaded.
SourceFileSize_N * | Integer | Size of the original Nth file. | Aways uploaded.
SourceFileCreatedDateTime_N * | Time | Creation date of the original Nth file in EXIF-style format: YYYY:MM:DD hh:mm:ss For example, 28th of March, 2:40PM would be looking in the following way: 2005:03:28 14:40:00 | Always uploaded.
Note
In Java version the SourceFileCreatedDateTime_N and SourceFileLastModifiedDateTime_N fields has the same value.
SourceFileLastModifiedDateTime_N * | Time | Last modification date of the original Nth file in EXIF-style format: YYYY:MM:DD hh:mm:ss For example, 28th of March, 2:40PM would be looking in the following way: 2005:03:28 14:40:00 | Always uploaded.
Note
In Java version the SourceFileCreatedDateTime_N and SourceFileLastModifiedDateTime_N fields has the same value.
Width_N * | Integer | Width of the original Nth file if it is a supported image. Otherwise, this field contains 0. | Always uploaded.
Height_N * | Integer | Height of the original Nth file if it is a supported image. Otherwise, this field contains 0. | Always uploaded.
HorizontalResolution_N * | Integer | Horizontal resolution of the original Nth file if it is a supported image (measured in DPI - dots per inches). Otherwise, this field contains 0. | Always uploaded.
VerticalResolution_N * | Integer | Vertical resolution of the original Nth file if it is a supported image (measured in DPI - dots per inches). Otherwise, this field contains 0. | Always uploaded.
Thumbnail Information
ThumbnailX_N ** | File | The Xth thumbnail for the Nth uploaded image. Depending on the UploadFileXCompressionMode_N field value this field contains a thumbnail with one of the following names: OriginalFileName.OriginalFileExtension_ThumbnailX.jpg - for Jpeg and Icon compression modes; OriginalFileName.OriginalFileExtension_CompressedX.zip - for Zip compression mode; OriginalFileName.OriginalFileExtension_SourceX.OriginalFileExtension - for SourceFile compression mode. | Not uploaded only if a fit mode of the Xth thumbnail is Off and its compression mode is Jpeg.
UploadFileXCompressionMode_N ** | String | The compression mode of the Xth thumbnail of the Nth uploaded file. Possible values are: Jpeg. The Xth thumbnail is JPEG. Zip. The Xth thumbnail is a zip archive. Icon. The Xth thumbnail is an icon. SourceFile. The Xth thumbnail is a copy of the original file. | The same.
ThumbnailXFileSize_N ** | Integer | Size of the Xth thumbnail of the Nth uploaded image. | The same.
ThumbnailXWidth_N ** | Integer | Actual width of the Xth thumbnail of the Nth uploaded image. Depending on the fit mode, this value may differ from the value specified through parameters. This happens because Image Uploader preserves aspect ratio of the image and not always can use the same dimensions as specified in the thumbnail parameters. | The same.
ThumbnailXHeight_N ** | Integer | Actual height of the Xth thumbnail of the Nth uploaded image. Depending on the fit mode, this value may differ from the value specified through parameters. This happens because Image Uploader preserves aspect ratio of the image and not always can use the same dimensions as specified in the thumbnail parameters. | The same.
ThumbnailXSucceeded_N ** | Boolean | true, if the compression mode of the Xth thumbnail is Jpeg and it is created successfully. Otherwise, false. | Uploaded only if the compression mode of the Xth thumbnail is Jpeg.
User Input
Angle_N * | Integer | Rotation angle of Nth upload item (measured in degrees clockwise). This field is changed if the user click an arrow icon to rotate an image, or if the automatic EXIF rotation is enabled (see the AllowAutoRotate property for more details). You can use it if you would like to rotate images on the server side (e.g. if you upload only source file). Possible values are: 0 90 180 270 | Always uploaded.
Description_N * | String | User-provided description of the Nth upload item. To enable or disable the user to edit the description, use the ShowDescriptions property. Also, it can be edited through the JavaScript via the UploadFileDescription property. | Always uploaded.
* The N character appended to the field name is a placeholder for an index of this file in the POST request. This index is 1-based. For example, if the user uploads three files, they will get SourceFile_1, SourceFile_2, and SourceFile_3 fields (the same is true for others XXX_N fields). ** Image Uploader can generate unlimited number of thumbnails per each image uploaded to the server. The X character is a placeholder for an index of the thumbnail for the Nth image. X value is the same as you specify when configuring thumbnails through parameters or the UploadThumbnailFitMode property. For example, if you set UploadThumbnail1FitMode and UploadThumbnail2FitMode to some value that differs from Off, and upload three files, the following fields will be available on the server: Thumbnail1_1, Thumbnail2_1, Thumbnail1_2, Thumbnail2_2, Thumbnail1_3, and Thumbnail2_3.

Note
Standard POST fields can be renamed using the RenameField method. Read the Configuring POST Format topic for more details.

# Additional Fields

Image Uploader is able to send not only fields described in the table above, but also custom fields. It can be done in two ways:

- Using the AddField method. It takes the name of a field you want to extract it on the server and its value. The most convenient place to use this method is the BeforeUpload event.
- Using the AdditionalFormName property. You just add somewhere in your code the FORM element, add elements into it (INPUT, SELECT, TEXTAREA elements are supported), and set its name to the AdditionalFormName property. Image Uploader automatically appends data from this FORM to the request that is sent to the server.

See the Uploading Additional Data with Files topic for more details.

# EXIF And IPTC Fields

In addition to standard and custom fields, Image Uploader can extract EXIF and IPTC data and send it along with other POST fields. To do it, you specify a list of required fields in the ExtractExif and ExtractIptc properties. Before the upload start, Image Uploader tries to extract these fields from files which are being sent. If it succeeds, these fields are appended to the request.

To see a list of supported EXIF and IPTC fields, as well as additional information about this, check out the ExtractExif and ExtractIptc properties reference.

# Hash Fields

If it is necessary to organize robust upload and check the integrity of uploaded files, you can use the HashAlgorithm property. It works in the following way:

1. You see one or several hash algorithms in the HashAlgorithm property.
2. Before the upload begins, Image Uploader calculates the hash value (or several values) according to settings specified on the first step.
3. Base64-encoded hash value is appended to the request.
4. The server side code calculates the hash value using the same algorithm and compares it with the uploaded one.
5. If hash values are the same, the verification is successful. Otherwise, the upload is corrupted.

See the Robust Upload Sample to see it in action.