Get Shell
GET /ws/rest/service/v1/admin/shell
This REST service also supports the Shell Manager Attribute Form.
Request Format
Optional filter condition can be provided as parameter to the GET request.
Name of key is options and value is in JSON format as below:
{
"filter": {"shell_type" : "Buildings"}
}
The only applicable filter condition is the "shell_type".
Only one value for shell_type is supported.
Sample Success Response
When filter condition is not provided, Response will contain all the shells (not template) that are in "Active" status.
{
"data":[
{
"shell_model_name":"us_apr",
"shell_number":"RE00000",
"shell_name":"All Properties",
"shell_phase":null,
"latitude":null,
"longitude":null,
"shell_location":null
},
{
"shell_model_name":"us_st",
"shell_number":"site-001",
"shell_name":"Site_1",
"shell_phase":null,
"latitude":null,
"longitude":null,
"shell_location":"/All Properties"
},
{
"shell_model_name":"us_bld",
"shell_number":"B-0001",
"shell_name":"Building_1",
"shell_phase":null,
"latitude":null,
"longitude":null,
"shell_location":"/All Properties/Site_1"
}
],
"message": [""],
"status":200
}
Sample Success Response
When the filter condition is provided (shell type "Buildings"), the response will contain shells only of type "Buildings" as shown below.
{
"data":
[
{
"shell_model_name":"us_bld",
"shell_number":"B-0001",
"shell_name":"Building_1",
"shell_phase":null,
"latitude":null,
"longitude":null,
"shell_location":"/All Properties/Site_1"
}
],
"message": [""],
"status":200
}
Sample Failed Response
If an incorrect shell_type is provided in the filter condition, the Error with status 2051 and message "Invalid Shell Type : input shell type " is included in the Response.
{
"data": [ ],
"message": [ "Invalid Shell Type : Buildings_1" ],
"status":2051
}
Related Topics
Last Published Wednesday, April 9, 2025