TPUpdateDataEMail

Greg Kolinski edited this page Sep 22, 2017 · 1 revision

Back To Common API Calls


Update an ECGridID entry's EMail Address for Data.

 public bool TPUpdateDataEMail(string SessionID, 
                               int ECGridID, 
                               EMailSystem EMailSystem, 
                               string DataEMail, 
                               EMailPayload PayloadPosition)

Parameters:


Returns

True if successful, false on failure. - Boolean


Remarks


Code Example

C#

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 = 9845;
            string DataEMail = "Person@domain.com";

            bool TPResults= ECGrid.TPUpdateDataEMail(SessionID, ECGridID, ECGridService.EMailSystem.smtp, DataEMail, ECGridService.EMailPayload.Attachment);

        }
        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 /v3.2/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ecgridos.net/TPUpdateDataEMail"

<?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>
    <TPUpdateDataEMail xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <ECGridID>int</ECGridID>
      <EMailSystem>smtp or x400</EMailSystem>
      <DataEMail>string</DataEMail>
      <PayloadPosition>Body or Attachment</PayloadPosition>
    </TPUpdateDataEMail>
  </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>
    <TPUpdateDataEMailResponse xmlns="http://ecgridos.net/">
      <TPUpdateDataEMailResult>boolean</TPUpdateDataEMailResult>
    </TPUpdateDataEMailResponse>
  </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 /v3.2/prod/ecgridos.asmx HTTP/1.1
Host: ecgridos.net
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>
    <TPUpdateDataEMail xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <ECGridID>int</ECGridID>
      <EMailSystem>smtp or x400</EMailSystem>
      <DataEMail>string</DataEMail>
      <PayloadPosition>Body or Attachment</PayloadPosition>
    </TPUpdateDataEMail>
  </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>
    <TPUpdateDataEMailResponse xmlns="http://ecgridos.net/">
      <TPUpdateDataEMailResult>boolean</TPUpdateDataEMailResult>
    </TPUpdateDataEMailResponse>
  </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 /v3.2/prod/ecgridos.asmx/TPUpdateDataEMail?SessionID=string&ECGridID=string&EMailSystem=string&DataEMail=string&PayloadPosition=string HTTP/1.1
Host: ecgridos.net
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://ecgridos.net/">boolean</boolean>

HTTP POST

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

POST /v3.2/prod/ecgridos.asmx/TPUpdateDataEMail HTTP/1.1
Host: ecgridos.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&ECGridID=string&EMailSystem=string&DataEMail=string&PayloadPosition=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://ecgridos.net/">boolean</boolean>

Back To Common API Calls

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.