Skip to content
/Addresses

Addresses

The buyer can query address availability. The buyer can search by postcode to get a list of locations which may be available to order to in that region or may look up a single address via UPRN

Operations

Query Address Search

Request

To check the availability of a given location, the buyer should send a request containing either a postcode or a UPRN.

The seller is then going to respond with detailed information about the queried location.

If the buyer queried using a UPRN, the response will contain only one location.

On a postcode request, the seller might respond with multiple locations that match the given postcode.

The location details include among other fields: UPRN, RFS (Ready For Service) status, cabinet release date, LOC (Limit Of Construction), if the order will be a preorder (aka <cfh:preOrder/> XML tag is returned).

Security
Certificate
Bodyapplication/xml
messageobject(message)required

The meta-data of the request. It includes information regarding the message UUID, transaction ID and the sent timestamp

buyerobject(buyer)required

The Service Provider who consumes the service is the buyer

sellerobject(seller)required

the Active Network Operator who provides the service is the seller

locationAddress Key (object) or Postcode (object)required
One of:
<queryAddressSearchRequest xmlns="http://www.niccstandards.org.uk/ala_1.0.xsd" xmlns:cfh="http://www.cityfibre.com/ala/ext1">
  <message>
    <messageId>b68b2cf4-475e-11e1-a92e-fb2ff6467c99</messageId>
    <correlationId>bac72cfa-475e-11e1-a92e-fb2ff6467c99</correlationId>
    <sentAt>2012-01-20T18:30:43Z</sentAt>
  </message>
  <buyer>
    <buyerIdentifier>SPDEV1</buyerIdentifier>
  </buyer>
  <seller>
    <sellerIdentifier>CITYFIBRE</sellerIdentifier>
  </seller>
  <location>
    <addressKey>123456</addressKey>
  </location>
</queryAddressSearchRequest>

Responses

Query Address Search Response

Bodyapplication/xml
One of:
messageobject(message)required

The meta-data of the request. It includes information regarding the message UUID, transaction ID and the sent timestamp

buyerobject(buyer)required

The Service Provider who consumes the service is the buyer

sellerobject(seller)required

the Active Network Operator who provides the service is the seller

queryAddressSearchAcceptedobject(queryAddressSearchAccepted)required
Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <queryAddressSearchResponse xmlns="http://www.niccstandards.org.uk/ala_1.0.xsd" xmlns:cfh="http://www.cityfibre.com/ala/ext1">
      <message>
        <messageId>5cd77a84-f329-4cec-af7e-521e7a7e0861</messageId>
        <correlationId>bac72cfa-475e-11e1-a92e-fb2ff6467c99</correlationId>
        <sentAt>2017-10-18T17:10:33Z</sentAt>
      </message>
      <buyer>
        <buyerIdentifier>SPDEV1</buyerIdentifier>
      </buyer>
      <seller>
        <sellerIdentifier>CITYFIBRE</sellerIdentifier>
      </seller>
      <queryAddressSearchAccepted>
        <locations>
          <location>
            <addressKey>200002813013</addressKey>
            <addressKeyType>
              <recognisedAddressKey/>
            </addressKeyType>
            <britishAddress>
              <buildingNumber>12</buildingNumber>
              <dependentThoroughfareName>CROSS LANE</dependentThoroughfareName>
              …