Virima API Specification - HomePageService Services
The requests documented in this section are directed to
HomePageService resources, which represent .
getAllLinks GET Interface
get all available links for the logged in user
Method: GET
Relative URL: home-page-service/get-all-links
Request Headers: Accept, Authorization
Response Headers: Content-Length, Content-Type.
Response Structure:
Field Name | Type | Description |
---|
links | Response | |
Example Request:
Example Response:
{
"id":2147483647,
"response":"?"
}
getAllShrinkLinks GET Interface
get all available links for the logged in user
Method: GET
Relative URL: home-page-service/get-all-shrink-links
Request Headers: Accept, Authorization
Response Headers: Content-Length, Content-Type.
Response Structure:
Field Name | Type | Description |
---|
links | Response | |
Example Request:
Example Response:
{
"id":2147483647,
"response":"?"
}
saveQuickLink GET Interface
Service to add a link as quick link for the logged in user or remove a link as quick link
Method: GET
Relative URL: home-page-service/save-as-quick-link/id/action
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":"?"
}
orderLink POST Interface
Service to order link
Method: POST
Relative URL: home-page-service/order-link
Request Headers: Accept, Authorization
Response Headers: Content-Length, Content-Type.
Request Structure:
Field Name | Type | Description |
---|
linkList | ArrayOfId | |
Response Structure:
Field Name | Type | Description |
---|
response | Response | |
Example Request:
ORDERLINK
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
"id":2147483647,
"ids":[
{
"id":2147483647,
"scopeId":?,
"width":"?",
"flag":?,
"calendar":"?"
} ]
}
Example Response:
{
"id":1098617109,
"response":"?"
}