TPAddVAN - LorenData/ECGrid-API GitHub Wiki

Add a Trading Partner ID to a Value Added Network (VAN) connection.

  public int TPAddVAN(string SessionID,
                      int NetworkID,
                      string Qualifier,
                      string ID,
                      string Description)

Parameters

SessionID - String - GUID
NetworkID - Integer
Qualifier - String
ID - String
Description - String

Returns

int

Remarks

The system will check for duplicates in the same VAN and if the Qualifier/ID pair (QID) exists in a different Network/Mailbox, throwing an appropriate Soap Exception if found.

Use TPAdd() and TPAddEx() to add QIDs to other Network/Mailboxes.

Code Example

using System.Xml;
using System.Web.Services.Protocols;
using ECGridService = <ProjectName>.net.ecgridos;

try
{
    using (ECGridService.ECGridOSAPIv3 ECGrid = new ECGridService.ECGridOSAPIv3())
    {
        try
        {
            string SessionID = "00000000-0000-0000-0000-000000000000";
            int NetworkID = 56845;
            string Qualifier = "ZZ";
            string ID = "YOURISAID";
            string Description = "Description for TP";

            int TPID = ECGrid.TPAddVAN(SessionID, NetworkID, Qualifier, ID, Description);

        }
        catch (SoapException SoapEx)
        {
            // See SOAP Exceptions in the Appendix
            var ECG_Ex = CatchException(SoapEx);
            Console.WriteLine($"ECGridOS Soap Exception: {ECG_Ex.ErrorCode} , Item: {ECG_Ex.ErrorItem}, Message: {ECG_Ex.ErrorMessage}, String: {ECG_Ex.ErrorString}");
        }
    } // END USING
}
catch (Exception ex){ Console.WriteLine("Unhandled Exception: " + ex.ToString()); }

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 /v4.1/prod/ECGridOS.asmx HTTP/1.1
Host: os.ecgrid.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://os.ecgrid.io/TPAddVAN"

<?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>
    <TPAddVAN xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <Qualifier>string</Qualifier>
      <ID>string</ID>
      <Description>string</Description>
    </TPAddVAN>
  </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>
    <TPAddVANResponse xmlns="https://os.ecgrid.io/">
      <TPAddVANResult>int</TPAddVANResult>
    </TPAddVANResponse>
  </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 /v4.1/prod/ECGridOS.asmx HTTP/1.1
Host: os.ecgrid.io
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>
    <TPAddVAN xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <Qualifier>string</Qualifier>
      <ID>string</ID>
      <Description>string</Description>
    </TPAddVAN>
  </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>
    <TPAddVANResponse xmlns="https://os.ecgrid.io/">
      <TPAddVANResult>int</TPAddVANResult>
    </TPAddVANResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /v4.1/prod/ECGridOS.asmx/TPAddVAN?SessionID=string&NetworkID=string&Qualifier=string&ID=string&Description=string HTTP/1.1
Host: os.ecgrid.io

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="https://os.ecgrid.io/">int</int>

HTTP POST

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

POST /v4.1/prod/ECGridOS.asmx/TPAddVAN HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&NetworkID=string&Qualifier=string&ID=string&Description=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="https://os.ecgrid.io/">int</int>

Back To Common API Calls