Documentation

Getting Started

General Info

Beam

Structural 3D

Section Builder

Member Design

RC Design
General
Code Verification


Connection Design

API

Can't find what you're after?

Status

Data is returned about the solving process and whether it was successful or not. These keys are specified in the response object.

Key Type Description
status Object Contains the status of the solving process and other API information.

Key Type Description
status_code Number A code relating to the status of the solving process. 0 refers to a successful solve. Any positive integer is a failure.
status_msg String A message about the status of the solving process.
monthly_api_calls_performed Number The number of times you have used the API this month (reset at UTC+0 on the first day of each month).

Example

{
   "status": {
      "status_code": 0,
      "status_msg": "Solved Successfully! Linear Static Analysis Completed"
      "monthly_api_calls_performed": 12,
   }
}

Explanation of Status Codes

The table below explains the meaning behind the status codes returned by the API.

Status Code Meaning
1 Incorrect API Credentials (check your auth object) or Denied Authentication.
2 No valid members - please add a member.
3 No valid loads - please add a load.
4 No valid supports - please add a support.
5 No valid sections - please add a section.
6 Young's Modulus of the section cannot be zero.
7 Area of the section cannot be zero.
8 Moment of Inertia (Iz) of the section cannot be zero.
9 The section for a specific member does not exist.
10 Structure is not constrained enough.
11 There is a free-floating or disconencted node. Please remove it.
12 There is a free-floating or disconencted member. Please remove it.
13 Some translation or rotation of the structure is not constrained.
14 or 15 Linear Static Analysis Failed - please check the setup of the structure.
16 Moment of Inertia (Iy) of the section cannot be zero.
17 Torsion Constant (J) of the section cannot be zero.
18 General Solver Error - please check the setup of the structure or contact SkyCiv Support for assistance.
21 Structure is unstable. It needs to be restrained more by adding more supports.
22 A member is not constrained enough. Adjust the end fixities to make it more constrained.
23 Plates are not meshed. Please mesh the plates and try again.
24 A plate has more than 4 nodes and is not meshed. Mesh the plate or delete it and try again.
200 Non-Linear Static Analysis Failed.
201 Non-Linear Static Analysis Failed to converge - please consider increasing convergence tolerance.
202 Buckling Analysis Failed.
900 Solver Conflict - contact SkyCiv Support for assistance.
901 or 902 You've exceeded a structure limit - contact SkyCiv Support for assistance.
1000 API Error - contact SkyCiv Support for assistance.