TPMoveEx - LorenData/ECGrid-API GitHub Wiki

Move a single Trading Partner ID from a Network/Mailbox to a specified Network/Mailbox.

  public int TPMoveEx(string SessionID,
                      int NetworkID,
                      int MailboxID,
                      int ECGridID,
                      dateTime MoveDateTime)

Parameters

SessionID - String - GUID
NetworkID - Integer
MailboxID - Integer
ECGridID - Integer
MoveDateTime - System.DateTime

Returns

int

Remarks

Moving a Trading Partner Qualifier/ID (QID) from one Network/Mailbox to another is a process also known as a Migration. There are numerous complexities in this process which may include written authorization by the owner of the QID to release the QID from the existing Network. In general, a PDF of such a request on company letterhead is sufficient.

Most Networks require at least 3 business days advanced notification for an ID to be moved. The system enforces this rule. If you need a move expedited, please contact ECGrid NetOps to override this limitation.

ECGrid can optionally manage this migration by sending out notices of the pending migration to all Networks, sending reminders and tracking confirmations.

A Network Admin/Network User can move QIDs between Mailboxes within the same Network. To move QIDs to another Network requires NetOps Authorization Level.

To move a QID on the Session Network/Mailbox use TPMove().

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 ECGridID = 56845;
            int NetworkID = 56845;
            int MailboxID = 5684456;
            DateTime MoveDateTime = new DateTime(2017, 10, 1);

            int TPECGridIDResults= ECGrid.TPMoveEx(SessionID, NetworkID, MailboxID, ECGridID, MoveDateTime);

        }
        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/TPMoveEx"

<?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>
    <TPMoveEx xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <ECGridID>int</ECGridID>
      <MoveDateTime>dateTime</MoveDateTime>
    </TPMoveEx>
  </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>
    <TPMoveExResponse xmlns="https://os.ecgrid.io/">
      <TPMoveExResult>int</TPMoveExResult>
    </TPMoveExResponse>
  </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>
    <TPMoveEx xmlns="https://os.ecgrid.io/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <ECGridID>int</ECGridID>
      <MoveDateTime>dateTime</MoveDateTime>
    </TPMoveEx>
  </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>
    <TPMoveExResponse xmlns="https://os.ecgrid.io/">
      <TPMoveExResult>int</TPMoveExResult>
    </TPMoveExResponse>
  </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/TPMoveEx?SessionID=string&NetworkID=string&MailboxID=string&ECGridID=string&MoveDateTime=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/TPMoveEx HTTP/1.1
Host: os.ecgrid.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&NetworkID=string&MailboxID=string&ECGridID=string&MoveDateTime=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