Changes

Umlaut full API

939 bytes added, 16:02, 30 September 2008
API Response
<services_in_progress> lists the ServiceTypeValues that may still have responses coming, that may not be complete. A list of all possible ServiceTypeValues in a default Umlaut installation can be found in the [[http://umlaut.rubyforge.org/svn/trunk/db/orig_fixed_data/service_type_values.yml Umlaut code]].
 
=== <service_statuses> ===
 
This block provides information on the internal service plug-ins involved in this Umlaut request, and what their status is. In most cases, an API client will not need this information.
 
<status> can be one of:
* in_progress : Currently executing
* queued : Background service which is queued up, but not yet running.
* succesful : completed succesfully (may or may not have generated any responses)
* failed_fatal: A fatal error condition was encountered, for instance a bug in Umlaut code.
* failed_temporary: An error condition was encountered, but Umlaut _may_ try to run the service again, the error was not fatal, for instance an external service timed out.
 
These constants are defined in [http://umlaut.rubyforge.org/svn/trunk/app/models/dispatched_service.rb dispatched_service.rb]
 
If the <status> is failed_fatal or failed_temporary, there may be error information in an <exception_info> block.
Anonymous user