Virima API Specification - SampleService Services
The requests documented in this section are directed to
SampleService resources, which represent .
printHelloWorld GET Interface
Returns Hello World
Method: GET
Relative URL: sample/print-hello-world
Request Headers: Accept, Authorization
Response Headers: Content-Length, Content-Type.
Response Structure:
Field Name | Type | Description |
---|
response | Response | |
Example Request:
Example Response:
{
"id":1319061773,
"response":"?"
}
printLoggedInUser GET Interface
Returns Hello + logged in user's name
Method: GET
Relative URL: sample/print-logged-in-user
Request Headers: Accept, Authorization
Response Headers: Content-Length, Content-Type.
Response Structure:
Field Name | Type | Description |
---|
response | Response | |
Example Request:
Example Response:
{
"id":2147483647,
"response":"?"
}
printUserInput POST Interface
Takes user input and returns the same
Method: POST
Relative URL: sample/print-input
Request Headers: Accept, Authorization
Response Headers: Content-Length, Content-Type.
Request Structure:
Field Name | Type | Description |
---|
input | SampleInput | |
Response Structure:
Field Name | Type | Description |
---|
response | Response | |
Example Request:
PRINTUSERINPUT
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"input":"?"
}
Example Response:
{
"id":2147483647,
"response":"?"
}