Ultradrop Files are text files that can be used to insert data into an Ultradrop Point. These files are identified by their file name and can be shared across projects by configuring an ultradrop point to load data from the same ultradrop file.
Ultradrop files when fetched via the API return a data record with the follow keys:
filename
- The unique filename for the ultradrop file.length
- File size in bytes.md5
- md5 encoded hash of the file.Example JSON object:
{
"filename": "%PPC_PATH%\ultradrop\hotels_by_zone.txt",
"length": 6273,
"md5": "1b2619e7b73e33c4d088eeae3bd06c70"
}
Returns a list of uploaded ultradrop files in the user’s account.
{
"status": "success",
"message": "success",
"result": [
{
"filename": "%PPC_PATH%\ultradrop\hotels_by_zone2.txt",
"length": 6053,
"md5": "55434271bcd0c7414dead7ba9ecbd914"
},
{
"filename": "%PPC_PATH%\ultradrop\hotels_by_zone3.txt",
"length": 6053,
"md5": "55434271bcd0c7414dead7ba9ecbd914"
},
{
"filename": "%PPC_PATH%\ultradrop\hotels_by_zone.txt",
"length": 6053,
"md5": "55434271bcd0c7414dead7ba9ecbd914"
}
]
}
Returns a list of ultradrop files that are associated with projects in the user’s account.
The filenames are for files that are referenced by one or more of the projects in the user’s account. Uploading a matching filename will update the resource that is used in each project that references the filename.
{
"status": "success",
"message": "success",
"result": [
"%PPC_PATH%\Ultradrop\hotels_by_zone.txt",
"%PPC_PATH%\Ultradrop\cities.txt"
]
}
Returns the number of ultradrop files that have been uploaded.
Fetch the definition of an Ultradrop File including the following attributes:
id
- Unique identifier for this ultradrop file.filename
- The unique filename for the ultradrop file.length
- File size in bytes.md5
- md5 encoded hash of the file.Example JSON object:
{
"id": "1234",
"filename": "%PPC_PATH%\ultradrop\hotels_by_zone.txt",
"length": 6273,
"md5": "1b2619e7b73e33c4d088eeae3bd06c70"
}
Param name | Description |
---|---|
id required |
The unique id of the ultradrop file Validations:
|
Fetch an ultradrop file from the database using the file’s id.
If a file is found with the given filename, the contents of the ultradrop file will be the result.
Param name | Description |
---|---|
id required |
The unique id for the ultradrop file Validations:
|
Fetch an ultradrop file from the database using the file’s filename. Since these filenames often contain characters outside the ASCII set, the filename will have to be converted into a valid ASCII format using URL encoding.
If a file is found with the given filename, the contents of the ultradrop file will be the result.
Param name | Description |
---|---|
filename required |
The URI Encoded filename of the ultradrop file Validations:
|
Upload an ultradrop file to the database using the file’s filename. Since these filenames often contain characters outside the ASCII set, the filename will have to be converted into a valid ASCII format using URL encoding.
On a successful call, a standard JSON response will be returned with the a json result matching the format:
{
"status": "success",
"message": "success",
"result": {
"filename": "%PPC_PATH%\ultradrop\hotels_by_zone.txt",
"length": 6053,
"md5": "55434271bcd0c7414dead7ba9ecbd914"
}
}
Param name | Description |
---|---|
filename required |
The URI Encoded filename of the ultradrop file Validations:
|
The ultradrop file will be deleted from the database.
On a successful call, a standard JSON response will be returned with the a json result matching the format:
{
"status": "success",
"message": "success",
"result": "%PPC_PATH%\ultradrop\hotels_by_zone.txt"
}
Param name | Description |
---|---|
id required |
The unique id for the ultradrop file Validations:
|
Param name | Description |
---|---|
id required |
The unique id for the ultradrop file Validations:
|
Param name | Description |
---|---|
id required |
The unique id for the ultradrop file Validations:
|