Skip to content
/Products

Products

The buyer can query product availability at a given UPRN. For more information about products please see the reference

Operations

Query Products for Location

Request

Check the available products for a given location using the location's UPRN.

The seller will then respond with a list of one or multiple available products (if any) along with information about the need for an appointment (yes/no/maybe). For more information on products see the reference

Some products such as auxiliary services could depend on other products (this is indicated via the dependsOn property). For example ResVOIP1 can depend on CPEInst1, meaning if ResVOIP1 is ordered then CPEInst1 needs to be requested as well.

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

locationobject(Address Key)required
<queryProductsForLocationRequest 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>
</queryProductsForLocationRequest>

Responses

Query Products For Location 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

queryProductsForLocationAcceptedobject(queryProductsForLocationAccepted)required
Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <queryProductsForLocationResponse xmlns="http://www.niccstandards.org.uk/ala_1.0.xsd" xmlns:cfh="http://www.cityfibre.com/ala/ext1">
      <message>
        <messageId>560207a5-c6ff-42f5-9e4c-fa0175bc8704</messageId>
        <correlationId>bac72cfa-475e-11e1-a92e-fb2ff6467c99</correlationId>
        <sentAt>2017-10-12T13:09:06Z</sentAt>
      </message>
      <buyer>
        <buyerIdentifier>SPDEV1</buyerIdentifier>
      </buyer>
      <seller>
        <sellerIdentifier>CITYFIBRE</sellerIdentifier>
      </seller>
      <queryProductsForLocationAccepted>
        <locations>
          <location>
            <addressKey>200004753569</addressKey>
            <addressKeyType>
              <recognisedAddressKey/>
            </addressKeyType>
            <availableProducts>
              <availableProduct>
                <productName>ftthl2r</productName>
                <appointmentRequired>
       …