Simple Photo Upload Specification
Version 0.2 (2008 Oct 3)
This document intends to document Simple Photo Upload, a XML-RPC interface for photo blogging. It is incredibly incomplete. If you have any suggestions, questions, or complaints, please contact the author.
Interface members
spu.getGalleries
(user:string, pass:string) returns array(struct)
This method returns a list of gallery IDs and names.
Parameters:
- user:string
- User name for the hosting service.
- pass:string
- User password.
Returns: array(struct)
A list of structures, each structure holding an ID and name for a gallery:
- blogid:string
- Identifier for the photo blog or gallery to host the image.
- name:string
- User-friendly name for the photo blog or gallery.
Remarks
The user name and password parameters can be blank when calling this function. When blank, this function should return a list of blogs or galleries with public access (i.e. any user can see or upload images into them). If a user name is provided, the user account must be validated against the password given. If the validation passes, then a list of blogs or galleries to which the user may post will be returned rather than the global, public list.
spu.newImage
(blogid:string, user:string, pass:string, content:struct) returns string
This method is used for uploading an image, with associated data attached.
Parameters:
- blogid:string
- Identifier for the photo blog or gallery to host the image. NOT YET USED.
- user:string
- User name for the hosting service.
- pass:string
- User password.
- content:struct
- The actual image file itself, along with filename and metadata. The struct can have any number of fields, but the following names are special:
- filename:string
- The actual file name, without path.
- data:base64
- The content of the file.
- title:string
- A name for the image.
- description:string
- A description of the image.
- date:dateTime.iso8601
- Date and time that the photo was taken.
- tags:array(string)
- An array of tags for taxonomic purposes.
Returns: string
Identifier for the uploaded photo.
Release history
| Version 0.2 | 2008 October 3 | Added spu.getGalleries function |
| Version 0.1.1 | 2008 October 2 | Documented return value for spu.newImage |
| Version 0.1 | 2008 September 26 | Original release |
