MoveMaterial request message
- Last UpdatedSep 06, 2023
- 4 minute read
This is an example of the full structure of a MoveMaterial request.
<MoveMaterialRequestMessage xmlns="http://www.citect.com/Ampla/Inventory/2010/03">
<Request>
<Credentials>
<Password>********</Password>
<Session xsi:nil="true" />
<Username>User</Username>
</Credentials>
<Submission>
<Comment>manual</Comment>
<DestinationDetail>
<Lot>"Lot1"</Lot>
<Material>Material Model.Raw Coal</Material>
<Quantity>10</Quantity>
<WorkCenter>Enterprise.Coal Site 1.ROM Stockpile</WorkCenter>
<LotGroup>DestinationLotGroup</LotGroup>
</DestinationDetail>
<Direction>Input</Direction>
<FieldValues />
<MaterialMovement>Material Movements.Site 1 Movements.Mine to Stockpile</MaterialMovement>
<SampleDateTime>2012-07-20T00:00:00</SampleDateTime>
<SourceDetail>
<Lot>"Lot 1"</Lot>
<Material>Material Model.Raw Coal</Material>
<Quantity>10</Quantity>
<WorkCenter />
<LotGroup>SourceLotGroup</LotGroup>
<LotBehavior>FIFO</Lot Behavior>
</SourceDetail>
</Submission>
</Request>
</MoveMaterialRequestMessage>
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: Submission section
Contains the submission details about the material movement to make.
<Submission>
<Comment>manual</Comment>
<Direction>Input</Direction>
<FieldValues />
<MaterialMovement>Material Movements.Site 1 Movements.Mine to Stockpile</MaterialMovement>
<SampleDateTime>2012-07-20T00:00:00</SampleDateTime>
</Submission>
|
Parameter |
Description |
|---|---|
|
Comment |
(Required) Enter any comments about the material movement. |
|
Direction |
(Required) The direction of the movement. Specify the movement as an input, internal, or output movement. This value matches the value of the Material Movement item, if specified. Valid values are: Input, Internal, Output. |
|
FieldValues |
Enables you to submit custom field values. This parameter is used for routine movements only, as ad-hoc movements cannot have custom fields. This parameter is optional. |
|
MaterialMovement |
The full name of a preconfigured Material Movement item.For example, MateriaMovements.Input to Storage |
|
SampleDateTime |
The date and time of the sample in the following format: YYYY-MM-DD T HH:MM:SS Z. The T=Time and the Z=UTC time format. For example, 2022-01-22T18:00:00Z. |
Request parameters: DestinationDetail section
Contains information about the destination of the material movement.
<DestinationDetail>
<Lot>"Lot1"</Lot>
<Material>Material Model.Raw Coal</Material>
<Quantity>10</Quantity>
<WorkCenter>Enterprise.Coal Site 1.ROM Stockpile</WorkCenter>
<LotGroup>DestinationLotGroup</LotGroup>
</DestinationDetail>
|
Parameter |
Description |
|---|---|
|
Lot |
Use this parameter to create a new lot for the destination lot. You can specify the name of the new lot or use a lot generator. This value is mandatory when the destination work center is Selective, LIFO or FIFO, but not required for Mixed work centers. This parameter is mutually exclusive with the LotId parameter. |
|
LotId |
Use this parameter to target an existing lot. Mutually exclusive with the Lot parameter. The value is a Lot ID; for example, L999999. |
|
Material |
The destination material. This parameter can have a value of null. This value is mandatory for adhoc movements, and optional for routine movements. For routine movements, the value is already defined; for example, Material.RawCoal. |
|
Quantity |
The destination quantity. This value is not required for output movements and can be left blank. It is mandatory for other directions. The destination quantity is optional if the DestinationQuantityMode on the material movement item is set to UseSourceQuantity or Conversion.Positive or negative numeric value. |
|
WorkCenter |
The destination work center. This value is mandatory for adhoc movements (except Output movements). It is optional for routine movements. For routine movements, the value is already defined as the name of the work center or work unit. |
|
LotGroup |
Use this parameter to specify an existing lot group. Value is a string value that is the name of an existing lot group. This parameter is optional. |
Request parameters: SourceDetail section
Contains information about the source of the material movement.
<SourceDetail>
<Lot>"Lot 1"</Lot>
<Material>Material Model.Raw Coal</Material>
<Quantity>10</Quantity>
<WorkCenter />
<LotGroup>SourceLotGroup</LotGroup>
<LotBehavior>FIFO</Lot Behavior>
</SourceDetail>
|
Parameter |
Description |
|
Lot |
Use this parameter to create a new source lot. You can specify the name of the new lot or use a lot generator. This parameter is valid only for Input movements, because only Input movements may create a new lot. This parameter is mutually exclusive with the LotId parameter. |
|
LotId |
Use this parameter to target an existing lot. The value is a Lot ID; for example, L999999. This parameter is mutually exclusive with the Lot parameter. |
|
Material |
The name of the source material. This parameter may have a value of null. This value is mandatory for adhoc movements, and optional for routine movements. For routine movements, the value is already defined; for example, Material.RawCoal. |
|
Quantity |
The source quantity. This value is not required for input movements and can be left blank. It is mandatory for other directions. The source quantity is optional when the SourceQuantityMode on the material movement item is set to UseAvailableQuantity.Positive or negative numeric value. |
|
WorkCenter |
The source work equipment. This value is mandatory for adhoc movements (except Input movements). It is optional for routine movements. For routine movements, the value is already defined as the name of the work center or work unit. |
|
LotGroup |
Use this parameter to specify an existing lot group. Value is a string value that is the name of an existing lot group. This parameter is optional. |
|
LotBehavior |
Specifies a lot behavior for the material movement that overrides the lot behavior specified at the parent work center. |