osrfhttp:osrf_over_http
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
osrfhttp:osrf_over_http [2008/03/24 11:48] – error23 | osrfhttp:osrf_over_http [2022/02/10 13:34] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====Overview==== | ||
+ | OSRF methods can be called via HTTP as browser requests, returning JSON objects or XML documents. | ||
+ | ====Syntax for Calling OSRF Via Web Browser: | ||
+ | http:// | ||
+ | |||
+ | //format// and // | ||
+ | |||
+ | The value for the //service// parameter is the name of the OpenSRF application; | ||
+ | |||
+ | Order matters for the //param// parameters; they must be ordered as they are in the method declaration for the osrf application. | ||
+ | |||
+ | ====Examples: | ||
+ | ===Input Format and Return Format as JSON:=== | ||
+ | Both of these examples return the same values; the return and input types do not need to be explicitly stated when requesting JSON objects. | ||
+ | ==Implicit Defaults for Input/ | ||
+ | list some examples | ||
+ | ==Explicit Declarations of Input/ | ||
+ | list some examples | ||
+ | ===Return Format as XML=== | ||
+ | list some examples | ||
+ | |||
+ | ====Return Status==== | ||
+ | OSRF methods will return a status as part of the JSON object or XML document. | ||
+ | ^ STatus | ||
+ | | 200 | The request is returned successfully; | ||
+ | | 404 | one of the error messages | explanation| | ||
+ | | 404 | Row 2 Col 2 | Row 2 Col 3 | | ||
+ | |||
+ | |||
+ | FIXME Insert examples (include method header from osrf, request to send to demo.gapines.org, | ||
+ | FIXME Create table of Return Status \\ | ||
+ | FIXME Put it in the real wiki! |