PostalWSSimple


Click here for a complete list of operations.

UploadFile

The UploadFile() method is used to upload files for later usage.

Test

The test form is only available for methods with primitive types as parameters.

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 /PostalWS.asmx HTTP/1.1
Host: api.postalmethods.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "PostalMethods/UploadFile"

<?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>
    <UploadFile xmlns="PostalMethods">
      <Username>string</Username>
      <Password>string</Password>
      <MyFileName>string</MyFileName>
      <FileBinaryData>base64Binary</FileBinaryData>
      <Permissions>Account or User</Permissions>
      <Description>string</Description>
      <Overwrite>boolean</Overwrite>
    </UploadFile>
  </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>
    <UploadFileResponse xmlns="PostalMethods">
      <UploadFileResult>int</UploadFileResult>
    </UploadFileResponse>
  </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 /PostalWS.asmx HTTP/1.1
Host: api.postalmethods.com
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>
    <UploadFile xmlns="PostalMethods">
      <Username>string</Username>
      <Password>string</Password>
      <MyFileName>string</MyFileName>
      <FileBinaryData>base64Binary</FileBinaryData>
      <Permissions>Account or User</Permissions>
      <Description>string</Description>
      <Overwrite>boolean</Overwrite>
    </UploadFile>
  </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>
    <UploadFileResponse xmlns="PostalMethods">
      <UploadFileResult>int</UploadFileResult>
    </UploadFileResponse>
  </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 /PostalWS.asmx/UploadFile?Username=string&Password=string&MyFileName=string&FileBinaryData=string&FileBinaryData=string&Permissions=string&Description=string&Overwrite=string HTTP/1.1
Host: api.postalmethods.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<int xmlns="PostalMethods">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 /PostalWS.asmx/UploadFile HTTP/1.1
Host: api.postalmethods.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Username=string&Password=string&MyFileName=string&FileBinaryData=string&FileBinaryData=string&Permissions=string&Description=string&Overwrite=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="PostalMethods">int</int>