Server API + Examples

[yelmam]

**All the data should be sent using POST method, please insert the JSON data into
using the following key: "key_data" **
Example:
request.setAttribute("key_data", JSON);

Command "Create recording request"
Title :: Create recording request
Description :: Creates a new recording on server
Params keys:: (string)key_name - recording name
JSON Tag :: command_create_recording
JSON Key :: key_command

Example:
{
"key_command": "command_create_recording",
"name": "Amazing Recording"
}

Command "Create recording response"
Title :: Create recording response
Description :: Response of creating new recording on server
Return keys:: (int)key_recording_id - Unique recording ID, (string)key_name
JSON Tag :: command_create_recording
JSON Key :: key_command

Example:
{
"key_command": "command_create_recording",
"key_recording_id": "12345",
"key_name": "Amazing Recording"
}

[yuvadm]

@yelmam Nice work, although I wasn't aware you were going for a server side component as well, from what I remember from class.

What is the place of this API in the entire architecture? Which data is being saved locally on the client, and which is being sent to the server?

[yelmam]

Its the part which responsible for persistent storage logic, it comes between processing and the player elements.
We decided to use server in order to have the ability to share recordings easily and it removed local storage dependency.

All the data is being saved on the server, but not upon each command, at the end of recording session.

[yelmam]

Server is now live for create recording command, example:
Add Json to post request under property "key_data"
Request Json:
"key_command": "command_create_recording",
"key_name": "Amazing Recording"

Server URL: http://67.231.242.50:8080/EasyGuide/Main

Expected response:
{"key_recording_id":2,"key_name":""Amazing Recordingg"","key_command":"command_create_recording"}