ThisB2B service allows you to check the available product offers, which you are on-boarded to order, and the network capability for a specified location.
Note: it does not validate if a specific product can be provisioned at a location.
Related Product
This service is available for fibre products.
The data elements and attributes that may be used by this service are described below.
The following table describes the Place element
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Mandatory I | I/O |
The primary key for address or location searches. The Place id is commonly referred to as:
|
The filter parameter elements allow you to apply search criteria against Product Characteristics.
The following table describes the FilterParameter elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| FAMILY_TYPE | Optional | I/O | Family of related products. |
| MARKET_SEGMENT_CODE | Optional | I/O |
Code Crown Fibre Holdings (CFH) market offer segment designation of the product offering. Note: this is not the dwelling or premises type for the location. |
| OFFER_TYPE | Optional | I/O | Type of offer |
The following table describes the values provided by the family type element
| VALUE | DESCRIPTION |
|---|---|
| BITSTREAM | Fibre to the premises. |
| CSE | Customer Service Experience |
The following table describes the values provided by the market segment code element.
| VALUE | DESCRIPTION |
|---|---|
| BUSINESS | |
| RESIDENTIAL | |
| EDUCATION |
The following table describes the values provided by the offer type element.
| VALUE | DESCRIPTION |
|---|---|
| Primary | Primary product offering. |
| Secondary | Secondary product offering. |
| Not Applicable | Offers that do not have a Primary or Secondary classification. |
The following table describes the ProductOfferingInteractionItemDetail elements
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| MDU_Class | O | A numeric class representation of the type of MDU. | |
| Fibre_Available | O | Current fibre availability status. | |
| Demand_Point_Type | O | Describes the dwelling or situation at the address. | |
| Right_Of_Way | O | Flag to indicate if the location is within the right of way (ROW) boundary. | |
| Zone _Type | O | The type of zone. | |
| Availability_Status | O | The state of our network deployment for the location. | |
| Central_Office | O | Code of the Central office feeding the location. | |
| Point_Of_Interconnect | O | UFBPoint of Interconnect(POI) that serves the location. | |
| Install_Type | O | Type of installation expected to be required. | |
| Install_Distance | O | Expected installation distance in metres, from the Access Point to the Service point | |
| Service_Lead_Type | O | The service lead type proposed for new fibre-based service | |
| Consent_Required | O | Flag to indicate if consent is required. | |
| Consent_Status | O | Current consenting process status | |
| Coverage_Area | O | Indicates if Chorus is the Local Fibre Company (LFC). | |
| LFC_Area | O | Name of UFB candidate area | |
| Design_Required | O | Flag to indicate if the design is required. | |
| Build_Required | O | Flag to indicate if a build is required. | |
| MDU_Build_Status | O | Current MDU builds status. | |
| Availability_Date | O | The expected date for fibre to be available. |
The following table describes the values provided by the MDU_Class element.
| VALUE | DESCRIPTION |
|---|---|
| 0 | Single Dwelling Unit (SDU) |
| 1 | 2 to 6 Tenancies. |
| 2 | 7 to 12 Tenancies. |
| 3 | 13 to 32 Tenancies |
| 4 | More than 32 Tenancies. |
| 5 | Greenfield / Development. |
| 6 | Within Complex. |
The following table describes the values provided by the Fibre_Available element.
| VALUE | DESCRIPTION |
|---|---|
| Y | is “Ready”. |
| N | is “Planned”, “Unplanned”, “Under Build” or “Future”. |
| UNKNOWN | is any other value. |
The following table describes the values provided by the demand point type element
| VALUE | DESCRIPTION |
|---|---|
| MDU | Multiple Dwelling Unit |
| Unknown | Not able to determine based on our inventory records. |
| SDU | Single Dwelling Unit. |
| Subdivision | Exists in an area of known development. |
| NBAP | Non-Building Access Point |
The following table describes the values provided by the Right_Of_Way element.
| VALUE | DESCRIPTION |
|---|---|
| Y | Part of a Right of Way. |
| N | Not part of a Right of Way |
The following table describes the values provided by the Zone _Type element.
| VALUE | DESCRIPTION |
|---|---|
| Non-UFB |
This value is returned to one of the following: Non-Ultra Fast Broadband (UFB) - we are not the LFC in this area. It has been migrated from Broadband over Fibre (BoF). The available fibre is the Blue Zone even though it's in our LFC area. |
| RBI | Rural Broadband Initiative (RBI). A 1Mbps or 5Mbps+ copper or fibre service available in this area as part of the RBI initiative. |
| UFB | Ultra-Fast Broadband. Fibre is (or will be) available in this area from us as the LFC |
The following table describes the values provided by the Availability_Status element.
| VALUE | DESCRIPTION |
|---|---|
| Planned | Premises within our UFB footprint where we will deliver fibre in the future. |
| Ready | Fibre has passed these premises, and an order can be placed. |
| UnderBuild | A premises to which we are currently building a fibre network, an indicative completion date will be returned using the element. |
| Unplanned | We do not have plans to build fibre to these premises |
| Unknown | Not able to determine based on our inventory records |
| Future |
A premise within our UFB footprint where we will deliver fibre more than two years in the future, no target date is available. Note: This value is conditional, it will only be returned under certain circumstances. |
The following table describes the values provided by the Point_Of_Interconnect element.
| VALUES | ||
|---|---|---|
| DN/SOD | GLF/MDR | PM |
| NA/HBN | NN | QST |
| WR | AR | HN |
| WN/PRO | TG | IN |
| WHK | TU | MS |
| BM | TPO | WG |
| OU | GS | LVN |
| CH | RO | PRM |
| NU | GM |
The following table describes the values provided by the install type element
| VALUE | DESCRIPTION |
|---|---|
| Unknown | Not able to determine based on our inventory records. |
| Standard Install |
Zero install cost for residential customers. CFH Service LevelAgreements (SLA) apply:
|
| Non-Standard Install | Price on application (POA) install. CFH SLAs do not apply. |
| Standard Install (Basic) |
Extend cable to 200m until capital runs out for business customers. Zero install cost for residential customers. CFH SLAs do not apply. |
The following table describes the values provided by the Service_Lead_Type element
| VALUE | DESCRIPTION |
|---|---|
| Aerial | A premises that is served by overhead lines. |
| Underground | A premises that is served by an underground route that will require civil work onsite, e.g. digging. |
| MDU | A premises that is part of a multi-dwelling unit |
The following table describes the values provided by the Consent_Status element.
| VALUE | DESCRIPTION |
|---|---|
| Consent under action | We are investigating the consent requirements. |
| Consent declined | The consent request has been declined, or it was not obtained within the required time |
| Build Consent Gained | We have gained consent to build and will request a technician to organise the build. |
| Existing Rights | Consent is not required, but this was only discovered after the consent process was initiated. |
| Not Required | Consent is not required. |
| Unknown | The MDU Class is unknown |
| Consent Required | Consent is required before this order can be progressed. However, if consent is already gained or in progress, the Consent team will update the order within approximately 48 hours and you will receive a notification update of the status of your order. |
The following table describes the values provided by the Coverage_Area element.
| VALUE | DESCRIPTION |
|---|---|
| Chorus | We are the LFC for this location |
| Other | We are not the LFC for this location. |
The following table describes the values provided by the LFC_Area element
| VALUE | ||
|---|---|---|
| AK: Auckland | GS: Gisbourne | PUK: Pukekohe |
| AK: Beachlands | GS: Wainui | QST: Queenstown |
| AK: Hibiscus Coast/Redbeach | HN: Cambridge Lost | RO: Ngongotaha |
| AK: Kumeu | HN: Te Awamutu Lost | RO: Rotorua |
| AK: Maraetai | HN: Hamilton Lost | TG: Tauranga Lost |
| AK: Riverhead | HW: Hawera Lost | TOB: Tokoroa Lost |
| AK: Runciman | HW: Normanby Lost | TPO: Acacia Bay |
| AR: Ashburton | IN: Gore | TPO: Taupo |
| BM: Blenheim | IN: Invercargill | TU: Timaru |
| CH: Brooklands Lost | IN: Mataura | WG: Wanganui Lost |
| CH: Christchurch Lost | Kapiti: Paekakariki | WH: Waiheke |
| CH: Kaianga Lost | Kapiti: Paraparaumu | WHK: Whakatane |
| CH: Kaiapoi Lost | Kapiti: Pukerua Bay | WKU: Waiuku |
| CH: Lincoln Lost | Kapiti: Waikanae | WN: Wellington |
| CH: Prebbleton Lost | LVN: Levin | WR: Whangarei Lost |
| CH: Rangiora Lost | MS: Masterton | |
| CH: Rolleston Lost | NA: Flaxmere | |
| CH: Spencerville Lost | NA: Hastings | |
| CH: Templeton Lost | NA: Havelock North | |
| CH: Woodend Lost | NA: Napier | |
| DN: Brighton | NN: Nelson | |
| DN: Dunedin | NU: New Plymouth Lost | |
| DN: Mosgiel | OKR: Oakura Lost | |
| FG: Feilding | OU: Oamaru | |
| GM: Greymouth | PM: Palmerston North |
The following table describes the values provided by the design required element
| VALUE | DESCRIPTION |
|---|---|
| Y | Location requires a design. |
| N | Location does not require design, or already has a design. |
The following table describes the values provided by the build required element.
| VALUE | DESCRIPTION |
|---|---|
| Y | Location is not ready for provisioning and will require build to be undertaken |
| N | Location does not require the additional build. |
The following table describes the values provided by the MDU_Build_Status element
| VALUE | DESCRIPTION |
|---|---|
| Design and Build Required | Design and Build is required for this location |
| Ready for Provisioning | NGA is able to be provisioned at this location. If there is an order which has just gone through the consent process, the order will start processing again. You will be notified to schedule an install date with the customer. |
| Not Required | MDU build not required for these premises. |
The availability date of the fibre network is returned by the ProductOfferingInteractionItemDetail - Availability_Date element where the is “Under Build”.
Date and time values use the xsd:DateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00].
The following table describes the ProductOffering elements.
| NAME | CARDINALITY I | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | O | Chorus catalogue product offering identifier. | |
| name | O | Chorus catalogue product offering name. | |
| ProductCharacteristic | O | Product characteristics. |
The following table describes the ProductCharacteristics elements
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| Family_Type | O | Family of related products. | |
| Market_Segment_Code | O |
Code Crown Fibre Holdings (CFH) market offer segment designation of the product offering. Note: this is not the dwelling or premises type for the location. |
|
| Offer_Type | O | Type of offer. |
The following table describes the values provided by the family type element.
| VALUE | DESCRIPTION |
|---|---|
| BITSTREAM | Fibre to the premises |
| CSE | Customer Service Experience. |
The following table describes the values provided by the offer type element
| VALUE | DESCRIPTION |
|---|---|
| Primary | Primary product offering. |
| Secondary | Secondary product offering. |
| Not Applicable O | Offers that do not have a Primary or Secondary classification. |
Service Name
QueryProductOfferAvailabilityRequest
Service Inputs
The following criteria must be used when requesting this service:
| INPUT | DESCRIPTION |
|---|---|
| Place id | Primary key for address or location searches, this is commonly referred to as the Supplier Location ID or The Location Code (TLC). |
This service also provides the option of restricting the search criteria by Product Characteristic using one or more of the following the FilterParameter elements:
The filters behave as follows:
Note: the filter option only restricts the results returned to you, it does not affect the underlying availability of products we offer you.
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | The query for an available product offer(s) at a given location. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes |
| Description | Initiates a transaction to query a product offer |
Service Name
QueryProductOfferAvailabilityResponse
Service Outputs
If a valid Place id was provided, the response will contain the Place id and the relevant fields from the following list:
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Response to your query for available Product Offer(s) at a location. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes |
| Description | Query product offer availability is processed or has an exception. |