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: FabSuiteRequestApi
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 | |
---|---|---|
fsreqGetLoads |
fsreqGetLoads class constructor
|
Properties
Name | Description | |
---|---|---|
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.) | |
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.) | |
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.
| |
Filters | ||
IncludeCompletedMaterial |
Indicates if the details of the material on each load should be retrieved.
| |
IncludeLoads |
Indicates if the individual loads should be retrieved.
| |
IncludeRemainingMaterial |
Indicates if the details of the material remaining to be loaded should be retrieved.
| |
IncludeUnshippedLoads |
Indicates if the loads that have not yet been shipped should be retrieved.
| |
JobNumber |
The JobNumber of the job to retrieve the status of.
| |
LoadNumber |
The load # to restrict the result to.
If this element is not specified then information from all loads will be retrieved.
| |
ProductionControlID |
The ProductionControlID of the job to retrieve the status of.
|
See Also