Get Shell

GET /ws/rest/service/v2/admin/shell

Purpose

Fetch all existing shells with additional properties such as Options, Links, and Currency.

Input JSON

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.

Output JSON

1) 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

}

2) When filter condition is provided (shell type "Buildings"), then Response will contain shells only of type "Buildings".

{

"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

}

3) If incorrect shell_type is provided in filter condition, then Error with status 2051 and message "Invalid Shell Type : input shell type " would be the Response.

{

"data":

[

],

"message":

[ "Invalid Shell Type : Buildings_1"

],

"status":2051

}

Get Shell supports all options available through the user interface, including:

Currency
- All currencies added by the user
Options
- Phase, Email Address, Send Notifications To (list of emails), Document Manager Attribute Form, E-Signature Type, Time Zone, Financial Period, Template Name
Links
- Any links added by the user
Default Calendar
Custom Print Template
Gateway Integration
- Project ID
Primavera Integration
- Project ID
View Forms
- Form Name, Permission Structure

Related Topics