API Reference

This is the reference documentation of Tekla EPM Open API. The API contains request and response namespaces.

fsreqGetStations Class

Retrieves the completed/remaining status and details by station. Either ProductionControlID or JobNumber must be specified. This command can be used a few different ways: 1. Retrieve the list of stations. IncludeCompleted = false, IncludeRemaining = false 3. Retrieve the details of the completed material for each station. IncludeCompleted = true, IncludeRemaining = false 4. Retrieve the details of the remaining material for each station. IncludeCompleted = false, IncludeRemaining = true
Inheritance Hierarchy

Namespace:  reqFabSuiteAPI
Assembly:  FabSuiteRequestApi (in FabSuiteRequestApi.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
[SerializableAttribute]
[XmlTypeAttribute(Namespace = "http://www.fabsuite.com/xml/fabsuite-xml-request-v0108.xsd")]
public class fsreqGetStations : fsreqCommand

The fsreqGetStations type exposes the following members.

Constructors
  Name Description
Public method fsreqGetStations
fsreqGetStations class constructor
Top
Properties
  Name Description
Public property APILog
Indicates if this command should be logged to the database. The command must be of a type that supports logging to the database in order to take effect. Currently the commands supporting this option are: TFSCut
(Inherited from fsreqCommand.)
Public property CommandGUID
A GUID identifying this particular XML command. If a command fails due to a communication failure the client has no way of knowing if it has been processed. Each command that makes changes (as opposed to just retrieving data) will check the CommandGUID against the GUIDs that have already been processed. If the GUID has already been processed then it will not be re-processed and instead return with an error. This allows the client to saftely re-try a failed command without risking unintended changes.
(Inherited from fsreqCommand.)
Public property Filters
Public property IncludeCompleted
Indicates if the details of the completed material should be retrieved.
Public property IncludeRemaining
Indicates if the details of the remaining material should be retrieved.
Public property JobNumber
The JobNumber of the job to retrieve the status of.
Public property ProductionControlID
The ProductionControlID of the job to retrieve the status of.
Public property StationName
The station to restrict the result to. If this element is not specified then information from all stations will be retrieved.
Top
See Also