Updates the BargeEx Data Mapping as indicated.

Namespace:  BargeEx
Assembly:  BargeEx (in BargeEx.dll)
Version: 3.0.400.140 (3.0.400.140)

Syntax

C#
public UpdateDataMappingReturnCode UpdateDataMapping(
	DataMapType dataMapType,
	string valueToMap,
	string customValue,
	string senderTradingPartnerNumber
)
Visual Basic (Declaration)
Public Function UpdateDataMapping ( _
	dataMapType As DataMapType, _
	valueToMap As String, _
	customValue As String, _
	senderTradingPartnerNumber As String _
) As UpdateDataMappingReturnCode
Visual C++
public:
UpdateDataMappingReturnCode UpdateDataMapping(
	DataMapType dataMapType, 
	String^ valueToMap, 
	String^ customValue, 
	String^ senderTradingPartnerNumber
)

Parameters

dataMapType
Type: BargeEx..::.DataMapType
The BargeEx data mapping type of the BargeEx Data Mapping to update.
valueToMap
Type: System..::.String
The value to map in the BargeEx Data Mapping. This value can be a BargeEx Master Value or a BargeEx Temporary Custom Mapping sender value. This parameter is required and cannot be a null reference (Nothing in Visual Basic) or empty.
customValue
Type: System..::.String
The new trading partner value that should be used for the indicated valueToMap. Use a null reference (Nothing in Visual Basic) or an empty string to reset a BargeEx Master Data Mapping back to the BargeEx Master Value or to remove a BargeEx Temporary Custom Mapping.
senderTradingPartnerNumber
Type: System..::.String
The trading partner number of the organization that sent the document containing the valueToMap. This parameter is not specified, valueToMap must be a BargeEx Master Value.

Return Value

An UpdateDataMappingReturnCode value that indicates whether or not the data mapping could be updated.

Remarks

This method invokes the UpdateDataMapping method available from the BargeEx web service. A value of Success indicates the BargeEx Data Mapping was successfully updated. Any other value indicates a failure.

The UpdateDataMapping method can be used to perform the following data mapping related operations:

  • Create a new or update an existing BargeEx Master Data Mapping

    To perform this operation set the valueToMap parameter to a BargeEx Master Value and set the customValue parameter to the desired mapping. The senderTradingPartnerNumber parameter can be set to a null reference (Nothing in Visual Basic) or an empty string in this scenario.

  • Delete an existing BargeEx Master Data Mapping

    To perform this operation set the valueToMap parameter to a BargeEx Master Value and set the customValue parameter to a null reference (Nothing in Visual Basic) or an empty string. The senderTradingPartnerNumber parameter can be set to a null reference (Nothing in Visual Basic) or an empty string in this scenario.

  • Create a new or update an existing BargeEx Temporary Custom Data Mapping

    To perform this operation set the valueToMap parameter to the value that was received in a document from the sender trading partner, set the customValue parameter to the desired mapping for this valueToMap value, and set the senderTradingPartnerNumber parameter to the BargeEx Trading Partner Number of the sender trading partner.

  • Delete an existing BargeEx Temporary Custom Data Mapping

    To perform this operation set the valueToMap parameter to the value that was received in a document from the sender trading partner, set the customValue parameter a null reference (Nothing in Visual Basic) or an empty string, and set the senderTradingPartnerNumber parameter to the BargeEx Trading Partner Number of the sender trading partner.

See Also