itec - European Schoolnet

iTEC Project
Title: ITEC-D10_2_V1-1 041102012.Docx
The request (method invocation) is composed of four items:
1. jsonrpc: protocol version number. It must be the string: “2.0”.
2. id: request unique identifier that will be echoed in the response message.
3. method name: just a string with the method name you wish to invoke.
4. params: a (JSON) object passed to the method. The params structure will depend on the
specific method being invoked.
The response is composed of three items:
1. jsonrpc: protocol version number. It must be the string: “2.0”.
2. id: an echo of the request id.
3. one of these parameters:
a. result: JSON string produced by the invoked method. It is required on success,
omitted on failure.
b. error: JSON string explaining the error, issued by the JSON-RPC server. It is
required on error, omitted on success.
In method invocations params must follow its corresponding JSON schema. The schema
completely specifies the data structure, required and optional fields, as well as the expected data
types or enumerations. Please refer to Appendix III for more specific details.
Figure 14. Basic structure of methods requests and responses
An example invocation of an API method (“Get.Feasible.Learning.Stories” in this case) using
JSON-RPC is illustrated below:
{
"jsonrpc": "2.0",
"id": "request-001",
"method": "Get.Feasible.Learning.Stories",
"params": [
{
"technical_setting_id": "tsVigo1",
"learning_stories": [
Page 29/96