JPX Help
This node is intended to explain (to some degree) the syntax used for the "JPX" XML-based interface to JPEGStore.
Every JPEGStore site has a base URL like:
call the JPX interface by sending an HTTP request like so:
www.jpegstore.com/uk/test/jps.asp
You can then specify additional parameters like the name of the archive to search, search string, sorting direction etc. Below is a list of commands you can use as well as some explanations. I'm adding them as I go along so please excuse any gaps.
- archive (string)
The archive name
- page (integer)
the current page of results
- size (integer)
the number of images to show per page
- pass (string)
user or admin password. Teh results are adapted accordingly. Hidden folders are not listed and passwords are not shown if logged in as user but they are as admin.
- meta (string: true/false)
Whether the results should also return the metadata for the images.
- basketmeta (string: true/false)
Whether the results should also return the metadata for the images contained in the basket.
- search (string)
The search string.
- basketid
the current basket id. Since the XML system is generally disconnected from the GUI, you can't rely on keeping the same session id since each http request is its own session. Thus JPX lets you specify a basket id whcih the GUI then manages control of. This also means you can come back to a saved basket simply by requesting the ID.
- sort (string: see below for options)
sorting criteria for results. Options are as follows:
folderPath
folderName
fileName
fileSize
objectName
headline
caption_abstract
specialInstructions
keywords (; delimited text array so would refer to teh first item)
datelastModified
dateCreated
- dir (string: asc/desc)
sorting direction for results. O
Example url:
http://www.jpegstore.com/test/acidgfx_shop/jps.asp?archive=Video+DVDs&pa...
