ECGridOS API v3
Click here for a complete list of operations.
AS2Update
Update an AS2 Connection.
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 /v3.0/prod/ecgridos.asmx HTTP/1.1 Host: ecgridos.net Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://ecgridos.net/AS2Update" <?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> <AS2Update xmlns="http://ecgridos.net/"> <SessionID>string</SessionID> <CommID>int</CommID> <OwnerUserID>int</OwnerUserID> <AS2Identifier>string</AS2Identifier> <URL>string</URL> <SignData>boolean</SignData> <EncryptData>boolean</EncryptData> <CompressData>boolean</CompressData> <ReceiptType>None or SynchronousUnsigned or SynchronousSigned or AsynchronousUnsigned or AsynchronousSigned</ReceiptType> <HTTPAuthentication>None or Basic or Digest</HTTPAuthentication> <HTTPUser>string</HTTPUser> <HTTPPassword>string</HTTPPassword> <UseType>Undefined or Test or Production or TestAndProduction</UseType> <BeginUsage>dateTime</BeginUsage> <EndUsage>dateTime</EndUsage> </AS2Update> </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> <AS2UpdateResponse xmlns="http://ecgridos.net/"> <AS2UpdateResult>boolean</AS2UpdateResult> </AS2UpdateResponse> </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.0/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> <AS2Update xmlns="http://ecgridos.net/"> <SessionID>string</SessionID> <CommID>int</CommID> <OwnerUserID>int</OwnerUserID> <AS2Identifier>string</AS2Identifier> <URL>string</URL> <SignData>boolean</SignData> <EncryptData>boolean</EncryptData> <CompressData>boolean</CompressData> <ReceiptType>None or SynchronousUnsigned or SynchronousSigned or AsynchronousUnsigned or AsynchronousSigned</ReceiptType> <HTTPAuthentication>None or Basic or Digest</HTTPAuthentication> <HTTPUser>string</HTTPUser> <HTTPPassword>string</HTTPPassword> <UseType>Undefined or Test or Production or TestAndProduction</UseType> <BeginUsage>dateTime</BeginUsage> <EndUsage>dateTime</EndUsage> </AS2Update> </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> <AS2UpdateResponse xmlns="http://ecgridos.net/"> <AS2UpdateResult>boolean</AS2UpdateResult> </AS2UpdateResponse> </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.0/prod/ecgridos.asmx/AS2Update?SessionID=string&CommID=string&OwnerUserID=string&AS2Identifier=string&URL=string&SignData=string&EncryptData=string&CompressData=string&ReceiptType=string&HTTPAuthentication=string&HTTPUser=string&HTTPPassword=string&UseType=string&BeginUsage=string&EndUsage=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.0/prod/ecgridos.asmx/AS2Update HTTP/1.1 Host: ecgridos.net Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&CommID=string&OwnerUserID=string&AS2Identifier=string&URL=string&SignData=string&EncryptData=string&CompressData=string&ReceiptType=string&HTTPAuthentication=string&HTTPUser=string&HTTPPassword=string&UseType=string&BeginUsage=string&EndUsage=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>