Lookup


Click here for a complete list of operations.

getCredits

Returns the current credit balances of the account.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
account:
password:

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 /lookup.asmx HTTP/1.1
Host: ws1.postcodesoftware.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://postcodesoftware.co.uk/getCredits"

<?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>
    <getCredits xmlns="http://postcodesoftware.co.uk/">
      <account>string</account>
      <password>string</password>
    </getCredits>
  </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>
    <getCreditsResponse xmlns="http://postcodesoftware.co.uk/">
      <getCreditsResult>
        <PAFBalance>string</PAFBalance>
        <PAFExpire>string</PAFExpire>
        <POSTZONBalance>string</POSTZONBalance>
        <POSTZONExpire>string</POSTZONExpire>
        <ErrorNumber>short</ErrorNumber>
        <ErrorMessage>string</ErrorMessage>
      </getCreditsResult>
    </getCreditsResponse>
  </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 /lookup.asmx HTTP/1.1
Host: ws1.postcodesoftware.co.uk
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>
    <getCredits xmlns="http://postcodesoftware.co.uk/">
      <account>string</account>
      <password>string</password>
    </getCredits>
  </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>
    <getCreditsResponse xmlns="http://postcodesoftware.co.uk/">
      <getCreditsResult>
        <PAFBalance>string</PAFBalance>
        <PAFExpire>string</PAFExpire>
        <POSTZONBalance>string</POSTZONBalance>
        <POSTZONExpire>string</POSTZONExpire>
        <ErrorNumber>short</ErrorNumber>
        <ErrorMessage>string</ErrorMessage>
      </getCreditsResult>
    </getCreditsResponse>
  </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 /lookup.asmx/getCredits?account=string&password=string HTTP/1.1
Host: ws1.postcodesoftware.co.uk
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Account xmlns="http://postcodesoftware.co.uk/">
  <PAFBalance>string</PAFBalance>
  <PAFExpire>string</PAFExpire>
  <POSTZONBalance>string</POSTZONBalance>
  <POSTZONExpire>string</POSTZONExpire>
  <ErrorNumber>short</ErrorNumber>
  <ErrorMessage>string</ErrorMessage>
</Account>

HTTP POST

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

POST /lookup.asmx/getCredits HTTP/1.1
Host: ws1.postcodesoftware.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

account=string&password=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Account xmlns="http://postcodesoftware.co.uk/">
  <PAFBalance>string</PAFBalance>
  <PAFExpire>string</PAFExpire>
  <POSTZONBalance>string</POSTZONBalance>
  <POSTZONExpire>string</POSTZONExpire>
  <ErrorNumber>short</ErrorNumber>
  <ErrorMessage>string</ErrorMessage>
</Account>