ECGridOS API v4
Click here for a complete list of operations.
TPUpdateDataEMail
Update an ECGridID entry's EMail Address for Data.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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/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="https://os.ecgrid.io/"> <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="https://os.ecgrid.io/"> <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 /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> <TPUpdateDataEMail xmlns="https://os.ecgrid.io/"> <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="https://os.ecgrid.io/"> <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 /v4.1/prod/ecgridos.asmx/TPUpdateDataEMail?SessionID=string&ECGridID=string&EMailSystem=string&DataEMail=string&PayloadPosition=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"?> <boolean xmlns="https://os.ecgrid.io/">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 /v4.1/prod/ecgridos.asmx/TPUpdateDataEMail HTTP/1.1 Host: os.ecgrid.io 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="https://os.ecgrid.io/">boolean</boolean>