PrauxTools

General

The Praux Tools API allows you to mash up with Praux in unique ways. I'd say new and exciting but I'm sure you're all done being excited with SoS APIs. The basic premise is you POST or GET with your variables in the HTTP parameters, and you get the result back in a REST-like fashion. e.g. .json gives you JSON, .xml gives you XML, etc. Currently we support: .yaml, .json, and .xml REST extensions. The default return encapsulation (if no extension is given) is JSON.

The return data is neatly tucked into a basic data structure that looks like this one (in Perl):

       {
          'success' => 1,
          'payload' => [

                         {
                         },
                         
                         {
                         },

                       ],
        };

If success is a false value, then error will be in place of payload. payload will also be only be useful for PrauxTools that return one or more entries / values. Other information can come back in the top level of the data structure and will be documented on a Tool by Tool basis. Usually time_taken will contain a floating point number representing the time the request took to process in seconds.

Available PrauxTools

Tool Name	Tool URL	Tool Description
ContentSearch	http://praux.com/pt/content_search	Search through resumes for content. Also lets you arbitrarily list and page through resumes.
ResumeInfo?	http://praux.com/pt/resume_info	Retrieve information about one or more resumes by resume host name.
ListBlocks?	http://praux.com/pt/list_blocks	Get a list of all of the content blocks (content placeholders) that comprise a resume.
BlockInfo?	http://praux.com/pt/block_info	Retrieve information about one or more blocks by block number.
CreateCollection?	http://praux.com/pt/create_collection	Create a new Resume Collection, which is just a simple grouping of resumes.
EditCollection?	http://praux.com/pt/edit_collection	Edit or remove a previously created Resume Collection.
GetCollection?	http://praux.com/pt/get_collection	Retrieve a group of resumes by collection.
DumpAtBlock?	http://praux.com/pt/dump_at_block	Serialize part of the resume starting at a certain block.
ImportAtBlock?	http://praux.com/pt/import_at_block	Load / deserialize yaml into the resume at a certain location.
Provision	http://praux.com/pt/provision	Create a Praux.com account and / or resume.