standalone.foundation

The standalone.foundation namespace provides functions to manage sessions for foundation design.

standalone.foundation.start#

At the beginning of every API session, the session must be started. This function must be the first function in the array. This initiates a session and will return a session_id which can be used in subsequent calls made in the following 30 minutes to skip the verification process, thereby dramatically reducing the time to response.

important

The start function must always be the first function even if session_id is provided.

KeyTypeAcceptsDescriptionDefault
keep_openbooleantrue, falseIf the session should be kept on standby. If true, subsequent calls to the API using the session_id provided from the first call in lieu of key, will be 4-8x faster.false
Sample input for standalone.foundation.start
{
"function": "standalone.foundation.start",
"arguments": { "keep_open": false }
}

After authenticating using the API key, the response object will contain some useful information. The session_id key can be used to make further calls to the same session, skipping authentication if keep_open was set to true. The session_expiry_time provides an approximate Unix time until the session expires. After this, the user must re-authenticate using their API key.

tip

The returned session_id can be provided in the auth object of subsequent calls to make the request faster.

standalone.foundation.check#

Simplified design checks can be performed without the need to run an analysis first. Note that standalone.foundation.start should be called prior to this function.

The below samples demonstrate design models for various design standards and footing types. Whilst the documentation is being built for this module, a JSON template can be created by building the model in SkyCiv's Foundation Designer and then Exporting the model as a JSON file.



Sample input for standalone.foundation.check
{
"functions": [
{
"function": "standalone.foundation.start",
"arguments": { "keep_open": false }
},
{
"function": "standalone.foundation.check",
"arguments": {
"1": {
"settings": {
"type": "isolated_foundation",
"code": "ACI_318_2014",
"units": "imperial",
"custom_loads": false
},
"loads": {
"1": {
"DL": {
"axial": 0,
"shear_x": 0,
"shear_z": 0,
"moment_x": 0,
"moment_z": 0
},
"LL": {
"axial": 0,
"shear_x": 0,
"shear_z": 0,
"moment_x": 0,
"moment_z": 0
},
"W": {
"axial": 0,
"shear_x": 0,
"shear_z": 0,
"moment_x": 0,
"moment_z": 0
},
"E": {
"axial": 0,
"shear_x": 0,
"shear_z": 0,
"moment_x": 0,
"moment_z": 0
},
"LR": {
"axial": 0,
"shear_x": 0,
"shear_z": 0,
"moment_x": 0,
"moment_z": 0
},
"RL": {
"axial": 0,
"shear_x": 0,
"shear_z": 0,
"moment_x": 0,
"moment_z": 0
},
"SL": {
"axial": 0,
"shear_x": 0,
"shear_z": 0,
"moment_x": 0,
"moment_z": 0
}
}
},
"geometry": {
"foundation": {
"isolated_depth": 108,
"isolated_width": 108,
"isolated_thickness": 30
}
},
"column": {
"1": {
"column_width": 16,
"column_depth": 16,
"column_height": 16,
"column_type": "rectangular",
"column_diameter": 16,
"column_x_offset": 0,
"column_z_offset": 0
}
},
"material": {
"concrete": {
"concrete_strength": 4000,
"unit_weight": 150,
"concrete_weight_type": "normal_weight"
},
"steel": {
"steel_strength": 60000
}
},
"soil": {
"soil_surcharge_load_value": 0,
"soil_thickness": 16,
"ground_water_height": false,
"coefficient_of_friction_value": 0.45,
"soil_bearing_capacity_value": 5000,
"angle_of_friction_value": 16,
"unit_weight": 100
},
"reinforcement": {
"top": {
"x": {
"rebar_size": false,
"rebar_spacing": false
},
"z": {
"rebar_size": false,
"rebar_spacing": false
}
},
"bottom": {
"x": {
"rebar_size": "#5 (0.625in)",
"rebar_spacing": 4
},
"z": {
"rebar_size": "#5 (0.625in)",
"rebar_spacing": 4
}
},
"column": {
"rebar_size": "#5 (0.625in)",
"secondary_size": "#5 (0.625in)",
"n_col": 4,
"fs_spacing": 4
}
},
"parameters": {
"ld_casting_position": 1,
"ld_coating_factor": 1,
"ld_bar_size_factor": 1,
"concrete_cover_top_value": 3,
"concrete_cover_bottom_value": 3,
"overturning_moment_value": 2,
"sliding_factor_value": 1.5
},
"project_details": {
"company": "",
"name": "",
"designer": "",
"id": "",
"client": "",
"notes": ""
},
"sw_factor": "1.00"
}
}
}
]
}