Service Web Service

Service

Click here for a complete list of operations.

GetAddresses

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 /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/GetAddresses"

<?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>
    <GetAddresses xmlns="http://www.digimap.gg/CAF/2.0">
      <apiKey>string</apiKey>
      <cafIDs>string</cafIDs>
    </GetAddresses>
  </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>
    <GetAddressesResponse xmlns="http://www.digimap.gg/CAF/2.0">
      <GetAddressesResult>
        <AddressView>
          <RequestedCAFID>int</RequestedCAFID>
          <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>
        </AddressView>
        <AddressView>
          <RequestedCAFID>int</RequestedCAFID>
          <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>
        </AddressView>
      </GetAddressesResult>
    </GetAddressesResponse>
  </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>
    <GetAddresses xmlns="http://www.digimap.gg/CAF/2.0">
      <apiKey>string</apiKey>
      <cafIDs>string</cafIDs>
    </GetAddresses>
  </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>
    <GetAddressesResponse xmlns="http://www.digimap.gg/CAF/2.0">
      <GetAddressesResult>
        <AddressView>
          <RequestedCAFID>int</RequestedCAFID>
          <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>
        </AddressView>
        <AddressView>
          <RequestedCAFID>int</RequestedCAFID>
          <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>
        </AddressView>
      </GetAddressesResult>
    </GetAddressesResponse>
  </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 /API2/Service.asmx/GetAddresses?apiKey=string&cafIDs=string HTTP/1.1
Host: caf.digimap.je

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfAddressView xmlns="http://www.digimap.gg/CAF/2.0">
  <AddressView>
    <RequestedCAFID>int</RequestedCAFID>
    <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>
  </AddressView>
  <AddressView>
    <RequestedCAFID>int</RequestedCAFID>
    <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>
  </AddressView>
</ArrayOfAddressView>

HTTP POST

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

POST /API2/Service.asmx/GetAddresses HTTP/1.1
Host: caf.digimap.je
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apiKey=string&cafIDs=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfAddressView xmlns="http://www.digimap.gg/CAF/2.0">
  <AddressView>
    <RequestedCAFID>int</RequestedCAFID>
    <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>
  </AddressView>
  <AddressView>
    <RequestedCAFID>int</RequestedCAFID>
    <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>
  </AddressView>
</ArrayOfAddressView>

Parameter	Value
apiKey:
cafIDs: