BargeExService


Click here for a complete list of operations.

GetDataMappings

This method returns current data mapping information for the indicated trading partner and data map type. All Master values will be returned, even if they do not have a Custom value defined. An optional Master value or Custom value can be specified to limit the results.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/Production/BargeExService.asmx HTTP/1.1
Host: www.bargeex.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.BargeEx.com/BargeExService/GetDataMappings"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <TradingPartnerCredentials xmlns="http://www.BargeEx.com/BargeExService">
      <UserName>string</UserName>
      <Password>string</Password>
      <TradingPartnerNumber>string</TradingPartnerNumber>
    </TradingPartnerCredentials>
  </soap:Header>
  <soap:Body>
    <GetDataMappings xmlns="http://www.BargeEx.com/BargeExService">
      <DataMapType>Barge or Boat or Commodity or Location or Ship or Waterway</DataMapType>
      <MasterValue>string</MasterValue>
      <CustomValue>string</CustomValue>
    </GetDataMappings>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetDataMappingsResponse xmlns="http://www.BargeEx.com/BargeExService">
      <GetDataMappingsResult>UnknownError or Success or FailedAuthentication</GetDataMappingsResult>
      <DataMappings>
        <DataMapPair>
          <MasterValue>string</MasterValue>
          <CustomValue>string</CustomValue>
        </DataMapPair>
        <DataMapPair>
          <MasterValue>string</MasterValue>
          <CustomValue>string</CustomValue>
        </DataMapPair>
      </DataMappings>
    </GetDataMappingsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/Production/BargeExService.asmx HTTP/1.1
Host: www.bargeex.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <TradingPartnerCredentials xmlns="http://www.BargeEx.com/BargeExService">
      <UserName>string</UserName>
      <Password>string</Password>
      <TradingPartnerNumber>string</TradingPartnerNumber>
    </TradingPartnerCredentials>
  </soap12:Header>
  <soap12:Body>
    <GetDataMappings xmlns="http://www.BargeEx.com/BargeExService">
      <DataMapType>Barge or Boat or Commodity or Location or Ship or Waterway</DataMapType>
      <MasterValue>string</MasterValue>
      <CustomValue>string</CustomValue>
    </GetDataMappings>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetDataMappingsResponse xmlns="http://www.BargeEx.com/BargeExService">
      <GetDataMappingsResult>UnknownError or Success or FailedAuthentication</GetDataMappingsResult>
      <DataMappings>
        <DataMapPair>
          <MasterValue>string</MasterValue>
          <CustomValue>string</CustomValue>
        </DataMapPair>
        <DataMapPair>
          <MasterValue>string</MasterValue>
          <CustomValue>string</CustomValue>
        </DataMapPair>
      </DataMappings>
    </GetDataMappingsResponse>
  </soap12:Body>
</soap12:Envelope>