standalone.member

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

standalone.member.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.member.start
{
"function": "standalone.member.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.member.check#

Simplified design checks can be performed without the need to run an analysis first. Provide loads, members, sections and parameters to run design checks. The API will calculate all member capacities, utility ratios and generate summary and in-depth calculation reports.

KeyTypeAcceptsDescription
unitsstringimperial, metricThe units system to be used.
design_codestringAISC_360-16_LRFD,
AISC_360-16_ASD,
AISC_360-10_LRFD,
AISC_360-10_ASD,
EN_1993-1-1-2005,
BS_5950-1-2000,
NDS_2018_ASD,
NDS_2018_LRFD,
CSA_S16-14,
AS_4100-1998,
AS_1720-2010,
AS_4600-2005,
AISI_S100-12_ASD,
AISI_S100-12_LRFD,
DNV_2-7-1_2006_with_AISC_360-10_ASD,
DNV_2-7-1_2006_with_AISC_360-10_LRFD		The design code for which the design object in the response should represent.
sections[[string]]An array of string arraysSection maps as defined in S3D.SB.getLibraryTree.
materials[object]An array of objectsMaterial definitions.
forces[object]An array of objectsForces to apply.
design_members[object]An array of objectsDesign member definitions.
design_factorsobjectAn objectDesign factors to use.
Sample input for standalone.member.check
{
"function": "standalone.member.check",
"arguments": {
"units": "imperial",
"design_code": "AISC_360-10_ASD",
"sections": [
["American", "AISC", "W shapes", "W14x808"],
["American", "AISC", "Rectangular HSS", "HSS2x1-1/2x3/16"]
],
"materials": [
{
"id": 1,
"name": "Some Custom Structural Steel",
"density": 450,
"elasticity_modulus": 29000,
"poissons_ratio": 0.27,
"yield_strength": 33,
"ultimate_strength": 52,
"class": "steel"
}
],
"forces": [
{
"axial": 10,
"Fz": 10,
"Fy": 15,
"torsion": 3,
"Mz": -0.5,
"My": -0.5
}
],
"design_members": [
{
"L": 12,
"Ly": 1,
"Lz": 1,
"Lb": 10,
"Cb": 1,
"Ky": 1,
"Kz": 1,
"sr_c": 200,
"sr_t": 300,
"element_id": 1,
"section_id": 2,
"material_id": 1
},
{
"L": 8,
"Ly": 1,
"Lz": 1,
"Lb": 6,
"Cb": 1,
"Ky": 1,
"Kz": 1,
"sr_c": 200,
"sr_t": 300,
"element_id": 1,
"section_id": 1,
"material_id": 1
}
],
"design_factors": {
"omega_t": 1.67,
"omega_c": 2.0,
"omega_b": 1.7,
"omega_v": 1.67
}
}
}
Try standalone.member.check