GetCurrentLots request message
- Last UpdatedSep 06, 2023
- 2 minute read
This is an example of the structure of a GetCurrentLots request.
<GetCurrentLotsRequestMessage xmlns="http://www.citect.com/Ampla/Operations/2010/03">
<Request>
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
<Filter>
<Lot>L12345</Lot>
<WorkCenter>Enterprise.Site1.WCA</WorkCenter>
<Material>Material Model.Site1.S1M1</Material>
<MaterialClass>Material Class.Coal.BrownCoal</MaterialClass>
<LotGroup>LG1</LotGroup>
<ApplyLotGroupFilterWhenNull>True</ApplyLotGroupFilterWhenNull>
</Filter>
</Request>
</GetCurrentLotsRequestMessage>
Request parameters: Credentials section
The Credentials section contains the security details for authentication. You can provide the Username and Password values to use the Basic security method. If you do not provide explicit security values, Web services will attempt to use Integrated authentication. You must provide either Basic credentials, Integrated credentials, or a Session ID.
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
|
Parameter |
Description |
|---|---|
|
Username |
The login name of the AVEVA™ Production Management user. This is a string value. Username and Password together are mutually exclusive with Session. |
|
Password |
The password that is associated with the AVEVA Production Management user. This is a string value. Username and Password together are mutually exclusive with Session. |
|
Session |
A GUID string value that identifies the session. This is a string value. Mutually exclusive with Username and Password. |
Request parameters: Filter section
Contains the details of the filter to apply.
<Filter>
<Lot>L12345</Lot>
<WorkCenter>Enterprise.Site1.WCA</WorkCenter>
<Material>Material Model.Site1.S1M1</Material>
<MaterialClass>Material Class.Coal.BrownCoal</MaterialClass>
<LotGroup>LG1</LotGroup>
<ApplyLotGroupFilterWhenNull>True</ApplyLotGroupFilterWhenNull>
</Filter>
|
Parameter |
Description |
|---|---|
|
WorkCenter |
(Required) Filters the results to specified work center. |
|
Material |
Filters the results to a specified material. This value is optional. |
|
MaterialClass |
Filters the results to a specified material class. A value of Non-empty string must match the name of a material class. This parameter is optional. Valid values: Null, Empty string or Non-empty string. |
|
Lot |
Filter the results to the specified Lot ID. This value is optional. |
|
LotGroup |
Filters the results to the specified lot group. The value should be a string value. Any defined lot group is a valid. However, if the lot group doesn't exist, the filter returns nothing. This parameter is optional. |
|
ApplyLotGroupFilterWhenNull |
This filter only takes effect when the value for the LotGroup filter is null. Value is True or False. This parameter is optional. |