Service Web Service

Service

Click here for a complete list of operations.

SearchAdvanced

Test

The test form is only available for requests from the local machine.

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 /API2/Service.asmx HTTP/1.1
Host: caf.digimap.je
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.digimap.gg/CAF/2.0/SearchAdvanced"

<?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>
    <SearchAdvanced xmlns="http://www.digimap.gg/CAF/2.0">
      <apiKey>string</apiKey>
      <searchTextProperty>string</searchTextProperty>
      <searchTextRoad>string</searchTextRoad>
      <searchTextRoadAlias>string</searchTextRoadAlias>
      <searchTextParish>string</searchTextParish>
      <searchTextPostcode>string</searchTextPostcode>
      <includeHistoric>boolean</includeHistoric>
      <includeInactive>boolean</includeInactive>
      <useMetaphone>boolean</useMetaphone>
      <sortBy>CAFID or PostCodeHierarchical or AddressHierarchical or AddressTextual or AddressToString</sortBy>
      <sortDescending>boolean</sortDescending>
      <classifications>string</classifications>
      <fromIndex>int</fromIndex>
      <maxResults>int</maxResults>
    </SearchAdvanced>
  </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>
    <SearchAdvancedResponse xmlns="http://www.digimap.gg/CAF/2.0">
      <SearchAdvancedResult>
        <ResultCount>int</ResultCount>
        <AddressList>
          <Address>
            <CAFID>int</CAFID>
            <Active>boolean</Active>
            <DeliveryPointID>int</DeliveryPointID>
            <USRN>int</USRN>
            <Timestamp>dateTime</Timestamp>
            <Business>string</Business>
            <POBox>string</POBox>
            <SubElementDesc>string</SubElementDesc>
            <BuildingName>string</BuildingName>
            <LocationOnStreet>string</LocationOnStreet>
            <NameOfTerrace>string</NameOfTerrace>
            <RoadName>string</RoadName>
            <ParentRoadName>string</ParentRoadName>
            <Locality>string</Locality>
            <Parish>string</Parish>
            <Island>string</Island>
            <PostCode>string</PostCode>
            <Lon>decimal</Lon>
            <Lat>decimal</Lat>
            <X>decimal</X>
            <Y>decimal</Y>
          </Address>
          <Address>
            <CAFID>int</CAFID>
            <Active>boolean</Active>
            <DeliveryPointID>int</DeliveryPointID>
            <USRN>int</USRN>
            <Timestamp>dateTime</Timestamp>
            <Business>string</Business>
            <POBox>string</POBox>
            <SubElementDesc>string</SubElementDesc>
            <BuildingName>string</BuildingName>
            <LocationOnStreet>string</LocationOnStreet>
            <NameOfTerrace>string</NameOfTerrace>
            <RoadName>string</RoadName>
            <ParentRoadName>string</ParentRoadName>
            <Locality>string</Locality>
            <Parish>string</Parish>
            <Island>string</Island>
            <PostCode>string</PostCode>
            <Lon>decimal</Lon>
            <Lat>decimal</Lat>
            <X>decimal</X>
            <Y>decimal</Y>
          </Address>
        </AddressList>
      </SearchAdvancedResult>
    </SearchAdvancedResponse>
  </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 /API2/Service.asmx HTTP/1.1
Host: caf.digimap.je
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>
    <SearchAdvanced xmlns="http://www.digimap.gg/CAF/2.0">
      <apiKey>string</apiKey>
      <searchTextProperty>string</searchTextProperty>
      <searchTextRoad>string</searchTextRoad>
      <searchTextRoadAlias>string</searchTextRoadAlias>
      <searchTextParish>string</searchTextParish>
      <searchTextPostcode>string</searchTextPostcode>
      <includeHistoric>boolean</includeHistoric>
      <includeInactive>boolean</includeInactive>
      <useMetaphone>boolean</useMetaphone>
      <sortBy>CAFID or PostCodeHierarchical or AddressHierarchical or AddressTextual or AddressToString</sortBy>
      <sortDescending>boolean</sortDescending>
      <classifications>string</classifications>
      <fromIndex>int</fromIndex>
      <maxResults>int</maxResults>
    </SearchAdvanced>
  </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>
    <SearchAdvancedResponse xmlns="http://www.digimap.gg/CAF/2.0">
      <SearchAdvancedResult>
        <ResultCount>int</ResultCount>
        <AddressList>
          <Address>
            <CAFID>int</CAFID>
            <Active>boolean</Active>
            <DeliveryPointID>int</DeliveryPointID>
            <USRN>int</USRN>
            <Timestamp>dateTime</Timestamp>
            <Business>string</Business>
            <POBox>string</POBox>
            <SubElementDesc>string</SubElementDesc>
            <BuildingName>string</BuildingName>
            <LocationOnStreet>string</LocationOnStreet>
            <NameOfTerrace>string</NameOfTerrace>
            <RoadName>string</RoadName>
            <ParentRoadName>string</ParentRoadName>
            <Locality>string</Locality>
            <Parish>string</Parish>
            <Island>string</Island>
            <PostCode>string</PostCode>
            <Lon>decimal</Lon>
            <Lat>decimal</Lat>
            <X>decimal</X>
            <Y>decimal</Y>
          </Address>
          <Address>
            <CAFID>int</CAFID>
            <Active>boolean</Active>
            <DeliveryPointID>int</DeliveryPointID>
            <USRN>int</USRN>
            <Timestamp>dateTime</Timestamp>
            <Business>string</Business>
            <POBox>string</POBox>
            <SubElementDesc>string</SubElementDesc>
            <BuildingName>string</BuildingName>
            <LocationOnStreet>string</LocationOnStreet>
            <NameOfTerrace>string</NameOfTerrace>
            <RoadName>string</RoadName>
            <ParentRoadName>string</ParentRoadName>
            <Locality>string</Locality>
            <Parish>string</Parish>
            <Island>string</Island>
            <PostCode>string</PostCode>
            <Lon>decimal</Lon>
            <Lat>decimal</Lat>
            <X>decimal</X>
            <Y>decimal</Y>
          </Address>
        </AddressList>
      </SearchAdvancedResult>
    </SearchAdvancedResponse>
  </soap12:Body>
</soap12:Envelope>