API Reference

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

Meta.Microsoft.Help.Id
T:reqFabSuiteAPI.fsreqGetLoads

fsreqGetLoads Class

Retrieves the completed/remaining status and details by destination and load #. Either ProductionControlID or JobNumber must be specified. This command can be used a few different ways: 1. Retrieve the list of destinations. IncludeLoads = false, IncludeUnshippedLoads = false, IncludeCompletedMaterial = false, IncludeRemainingMaterial = false 2. Retrieve the list of loads. Include[Unshipped]Loads = true, IncludeCompletedMaterial = false, IncludeRemainingMaterial = false 3. Retrieve the details of the material on each load. Include[Unshipped]Loads = true, IncludeCompletedMaterial = true, IncludeRemainingMaterial = false 4. Retrieve the details of the material remaining to be loaded. IncludeLoads = false, IncludeUnshippedLoads = false, IncludeCompletedMaterial = false, IncludeRemainingMaterial = 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 fsreqGetLoads : fsreqCommand

The fsreqGetLoads type exposes the following members.

Constructors
  Name Description
Public method fsreqGetLoads
fsreqGetLoads 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 DestinationName
The shipping destination to restrict the result to. Specify the value 'Jobsite' for the jobsite destination. If this element is not specified then information from all shipping destinations will be retrieved.
Public property Filters
Public property IncludeCompletedMaterial
Indicates if the details of the material on each load should be retrieved.
Public property IncludeLoads
Indicates if the individual loads should be retrieved.
Public property IncludeRemainingMaterial
Indicates if the details of the material remaining to be loaded should be retrieved.
Public property IncludeUnshippedLoads
Indicates if the loads that have not yet been shipped should be retrieved.
Public property JobNumber
The JobNumber of the job to retrieve the status of.
Public property LoadNumber
The load # to restrict the result to. If this element is not specified then information from all loads will be retrieved.
Public property ProductionControlID
The ProductionControlID of the job to retrieve the status of.
Top
See Also