PostcodeServices13 Web Service

PostcodeServices13

Click here for a complete list of operations.

GetLicenseDetails

This function is used to return the License details. More Info at http://www.epostcode.com/what-is-epostcode/web-service-described/service-test

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 /uk/postcodeservices13.asmx HTTP/1.1
Host: ws.epostcode.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.epostcode.com/uk/GetLicenseDetails"

<?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>
    <GetLicenseDetails xmlns="http://ws.epostcode.com/uk/">
      <sMachineName>string</sMachineName>
    </GetLicenseDetails>
  </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>
    <GetLicenseDetailsResponse xmlns="http://ws.epostcode.com/uk/">
      <GetLicenseDetailsResult>
        <List>
          <License>
            <ReferenceNo>string</ReferenceNo>
            <AcccountName>string</AcccountName>
            <GUID>string</GUID>
            <LicenseID>string</LicenseID>
            <LicenseTypeName>string</LicenseTypeName>
            <LicenseTypeDesc>string</LicenseTypeDesc>
            <ExpiryDate>string</ExpiryDate>
            <CurrentCreditsAvailable>string</CurrentCreditsAvailable>
            <AllowedIpAddress>string</AllowedIpAddress>
            <LicenseInUse>string</LicenseInUse>
            <Available>string</Available>
            <Status>string</Status>
            <Return_Code>string</Return_Code>
          </License>
          <License>
            <ReferenceNo>string</ReferenceNo>
            <AcccountName>string</AcccountName>
            <GUID>string</GUID>
            <LicenseID>string</LicenseID>
            <LicenseTypeName>string</LicenseTypeName>
            <LicenseTypeDesc>string</LicenseTypeDesc>
            <ExpiryDate>string</ExpiryDate>
            <CurrentCreditsAvailable>string</CurrentCreditsAvailable>
            <AllowedIpAddress>string</AllowedIpAddress>
            <LicenseInUse>string</LicenseInUse>
            <Available>string</Available>
            <Status>string</Status>
            <Return_Code>string</Return_Code>
          </License>
        </List>
        <IsError>boolean</IsError>
        <ErrorMessage>string</ErrorMessage>
      </GetLicenseDetailsResult>
    </GetLicenseDetailsResponse>
  </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 /uk/postcodeservices13.asmx HTTP/1.1
Host: ws.epostcode.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>
    <GetLicenseDetails xmlns="http://ws.epostcode.com/uk/">
      <sMachineName>string</sMachineName>
    </GetLicenseDetails>
  </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>
    <GetLicenseDetailsResponse xmlns="http://ws.epostcode.com/uk/">
      <GetLicenseDetailsResult>
        <List>
          <License>
            <ReferenceNo>string</ReferenceNo>
            <AcccountName>string</AcccountName>
            <GUID>string</GUID>
            <LicenseID>string</LicenseID>
            <LicenseTypeName>string</LicenseTypeName>
            <LicenseTypeDesc>string</LicenseTypeDesc>
            <ExpiryDate>string</ExpiryDate>
            <CurrentCreditsAvailable>string</CurrentCreditsAvailable>
            <AllowedIpAddress>string</AllowedIpAddress>
            <LicenseInUse>string</LicenseInUse>
            <Available>string</Available>
            <Status>string</Status>
            <Return_Code>string</Return_Code>
          </License>
          <License>
            <ReferenceNo>string</ReferenceNo>
            <AcccountName>string</AcccountName>
            <GUID>string</GUID>
            <LicenseID>string</LicenseID>
            <LicenseTypeName>string</LicenseTypeName>
            <LicenseTypeDesc>string</LicenseTypeDesc>
            <ExpiryDate>string</ExpiryDate>
            <CurrentCreditsAvailable>string</CurrentCreditsAvailable>
            <AllowedIpAddress>string</AllowedIpAddress>
            <LicenseInUse>string</LicenseInUse>
            <Available>string</Available>
            <Status>string</Status>
            <Return_Code>string</Return_Code>
          </License>
        </List>
        <IsError>boolean</IsError>
        <ErrorMessage>string</ErrorMessage>
      </GetLicenseDetailsResult>
    </GetLicenseDetailsResponse>
  </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 /uk/postcodeservices13.asmx/GetLicenseDetails?sMachineName=string HTTP/1.1
Host: ws.epostcode.com

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

<?xml version="1.0" encoding="utf-8"?>
<Licenses xmlns="http://ws.epostcode.com/uk/">
  <List>
    <License>
      <ReferenceNo>string</ReferenceNo>
      <AcccountName>string</AcccountName>
      <GUID>string</GUID>
      <LicenseID>string</LicenseID>
      <LicenseTypeName>string</LicenseTypeName>
      <LicenseTypeDesc>string</LicenseTypeDesc>
      <ExpiryDate>string</ExpiryDate>
      <CurrentCreditsAvailable>string</CurrentCreditsAvailable>
      <AllowedIpAddress>string</AllowedIpAddress>
      <LicenseInUse>string</LicenseInUse>
      <Available>string</Available>
      <Status>string</Status>
      <Return_Code>string</Return_Code>
    </License>
    <License>
      <ReferenceNo>string</ReferenceNo>
      <AcccountName>string</AcccountName>
      <GUID>string</GUID>
      <LicenseID>string</LicenseID>
      <LicenseTypeName>string</LicenseTypeName>
      <LicenseTypeDesc>string</LicenseTypeDesc>
      <ExpiryDate>string</ExpiryDate>
      <CurrentCreditsAvailable>string</CurrentCreditsAvailable>
      <AllowedIpAddress>string</AllowedIpAddress>
      <LicenseInUse>string</LicenseInUse>
      <Available>string</Available>
      <Status>string</Status>
      <Return_Code>string</Return_Code>
    </License>
  </List>
  <IsError>boolean</IsError>
  <ErrorMessage>string</ErrorMessage>
</Licenses>

HTTP POST

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

POST /uk/postcodeservices13.asmx/GetLicenseDetails HTTP/1.1
Host: ws.epostcode.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sMachineName=string

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

<?xml version="1.0" encoding="utf-8"?>
<Licenses xmlns="http://ws.epostcode.com/uk/">
  <List>
    <License>
      <ReferenceNo>string</ReferenceNo>
      <AcccountName>string</AcccountName>
      <GUID>string</GUID>
      <LicenseID>string</LicenseID>
      <LicenseTypeName>string</LicenseTypeName>
      <LicenseTypeDesc>string</LicenseTypeDesc>
      <ExpiryDate>string</ExpiryDate>
      <CurrentCreditsAvailable>string</CurrentCreditsAvailable>
      <AllowedIpAddress>string</AllowedIpAddress>
      <LicenseInUse>string</LicenseInUse>
      <Available>string</Available>
      <Status>string</Status>
      <Return_Code>string</Return_Code>
    </License>
    <License>
      <ReferenceNo>string</ReferenceNo>
      <AcccountName>string</AcccountName>
      <GUID>string</GUID>
      <LicenseID>string</LicenseID>
      <LicenseTypeName>string</LicenseTypeName>
      <LicenseTypeDesc>string</LicenseTypeDesc>
      <ExpiryDate>string</ExpiryDate>
      <CurrentCreditsAvailable>string</CurrentCreditsAvailable>
      <AllowedIpAddress>string</AllowedIpAddress>
      <LicenseInUse>string</LicenseInUse>
      <Available>string</Available>
      <Status>string</Status>
      <Return_Code>string</Return_Code>
    </License>
  </List>
  <IsError>boolean</IsError>
  <ErrorMessage>string</ErrorMessage>
</Licenses>

Parameter	Value
sMachineName: