Returns the current BargeEx Master Data Mappings for the indicated data mapping type. Allows for filtering by Master value or trading partner value.

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

Syntax

C#
public StandardReturnCode GetDataMappings(
	DataMapType dataMapType,
	string masterValue,
	string customValue,
	ref List<DataMapPair> dataMappings
)
Visual Basic (Declaration)
Public Function GetDataMappings ( _
	dataMapType As DataMapType, _
	masterValue As String, _
	customValue As String, _
	ByRef dataMappings As List(Of DataMapPair) _
) As StandardReturnCode
Visual C++
public:
StandardReturnCode GetDataMappings(
	DataMapType dataMapType, 
	String^ masterValue, 
	String^ customValue, 
	List<DataMapPair^>^% dataMappings
)

Parameters

dataMapType
Type: BargeEx..::.DataMapType
The BargeEx data mapping type of the BargeEx Master Data Mappings to return.
masterValue
Type: System..::.String
The BargeEx Master value filter. If this parameter is set to anything other than a null reference (Nothing in Visual Basic) or an empty string, only BargeEx Master values that start with this string will be returned.
customValue
Type: System..::.String
The trading partner value filter. If this parameter is set to anything other than a null reference (Nothing in Visual Basic) or an empty string, only BargeEx Data Mappings that have a trading partner value begining with this value will be returned. If this parameter is set to a null reference (Nothing in Visual Basic) or an empty string, this method returns all BargeEx Master values that meet the specified criteria, even if the BargeEx Master values do not have trading partner mappings defined.
dataMappings
Type: System.Collections.Generic..::.List<(Of <(DataMapPair>)>) %
Output - If GetDataMappings returns Success, this parameter contains the BargeEx Master Data Mappings that were returned.

Return Value

A StandardReturnCode value that indicates whether or not the data mappings could be returned.

Remarks

This method invokes the GetDataMappings method available from the BargeEx web service. A value of Success indicates the BargeEx Master Data Mappings were successfully returned. Any other value indicates a failure.

See Also