MatrixFrame API Service

Invoke the server, authenticate your user access, specify the project, and define the results you wish to retrieve in a straightforward manner with the MatrixFrame API.

To call the server, use the /SERVER parameter, followed by the server’s URL.

/SERVER:”https://solutions.matrix-software.com”

Authenticate using the /LOGIN parameter, providing your username and password.

/LOGIN:YourUsername:YourPassword

Indicate your project with the /PROJECT parameter, including the path to your .mxml file.

/PROJECT:”path-to-your-file\project-file.mxml”

Specify desired results with /RESULTS and the appropriate flags. Flags can be combined using “|”.

/RESULTS:”nf|mf”

Use these flags for results output. These flags can be combined using symbol |, for example use: “nodal-forces|member-forces” or “nf|mf” to output nodal and member forces.

  • flag[alias if possible] – description
  • full[all] – all available results (should go as a single string)
  • nodal-forces[nf] – nodal forces
  • member-forces[mf] – member forces
  • nodal-displacements[nd] – nodal displacements
  • member-deflections[md] – member deflections
  • support-reactions[sr] – support reactions
  • force-cuts[fc] – force cuts
  • dipls-cuts[dc] – displacement cuts
  • envelope – envelopes
  • polynoms – polynoms
  • stresses – stresses
  • fnl-concrete – fnl concrete results
  • concrete – concrete data (MxFloor only)
  • analysis-options[ao] – analysis options
  • dynamic – dynamic results
  • stability – stability results
  • json – output data in json format instead of xml

Combine the parameters to formulate a full command:

/SERVER:”https://solutions.matrix-software.com” /LOGIN:YourUsername:YourPassword /PROJECT: “path\to\your\project.mxml” /RESULTS:”nf|mf”