Fibre Ordering

BIC003: Query Order Feasibility

Getting Started Architecture Processes Web services Help & support FAQs

Back

Name

Customer Queries Order Feasibility

Description

This process provides you with the ability to determine whether it is feasible to order Product Offer for a specified location.

Related B2B Services

Query Order Feasibility

Preceded by

Flow - Customer Requests Order Feasibility

bic003

Process Pre-conditions

Supplier Location id and Order parameters are provided in a valid format.

Process Post-conditions

A response is sent containing the feasibility result for the requested product, it includes:

Pre-order details (design and feasibility results)
Order requirements
Appointment demand types.

Basic Path

STEP	DESCRIPTION	ROLE
1	Submit a feasible to order request.	Customer
2	Verify that the location and order information details are valid. Decompose into required services and resources, initiate the feasibility process to determine if the product can be provisioned and if the necessary resources are available. If request information is invalid, refer to alternate flow 1.	Chorus
3	Return feasibility response. If an appointment is required, provide this information in the response.	Chorus
4	Receive order feasibility response.	Customer

Alternate Flow 1

STEP	DESCRIPTION	ROLE
2.1	If the location information or Product Offer details are invalid, return an error response.	Chorus
2.2	Return an error response explaining why an order feasibility cannot be completed.	Chorus

Refer to the Exception Code Mappings table for error details.

Business Rules

Query Order Feasibility Request

It is mandatory to queryOrder Feasibility before you create an Order. The result will include a feasibility reason advising you if you can progress to Create Order.

Book Order Appointments

The Order Feasibility response will return appointment information. For orders that require:

Ready forService(RFS)appointments, it will include an indicative range of RFS dates. UseQuery AppointmentAvailability to retrieve a list of RFS dates and times before proceeding to Create Order.
SiteVisit appointment reservations, e.g.Scope, Install, it will include aSiteVisit id for each appointment type. The Site visit ID appears in both the Order item and the Site visit elements to allow the particular visit to be associated with the relevant order item. Use Query Appointment Availability and Reserve Appointment to find and reserve the appointments before proceeding to Create Order.

Limitations

If the location has an installed (intact) ONT, the query response will report that the order is feasible.

The Create Order web service will check port availability, if there are no ports available the response will contain an explanation and any further actions or options available to you.

Exception Code Mappings

The Exception Codes table lists the exceptions that may be returned by this service.

For a full list of exception codes and their meanings see B2B Exception Codes.

EXCEPTION CODE	EXCEPTION CODE MESSAGE
000	Backend processing error encountered - If problem persists please contact Chorus admin
001	Supplier Location ID not found
005	Supplier Location ID not valid
012	Order decomposition error: {%s}
014	Customer not on-boarded for requested Product Offer
026	Order validation failed: {%s}

Use Cases

The following table describes the use cases that support this business process.

Click on the scenario link to view the XML sample.

SCENARIO	DESCRIPTION	QUERY REQUEST	QUERY RESPONSE
Customer Requests Order Feasibility - Order type Connect Primary	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location using Order type Connect Primary and OrderItem action new.	Order type OrderItem ProductOffering id Place id	Order id Order type OrderItem ProductOffering id Place id Site Visit information Order Feasibility Result Item Detail
Customer Requests Order Feasibility - Order type Connect Additional ONT with CSE	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location using Order type Connect Additional ONT and OrderItem action new.	Order type OrderItem ProductOffering id Place id	Order id Order type OrderItem ProductOffering id Place id Site Visit information Order Feasibility Result Item Detail
Customer Requests Order Feasibility - Order type Connect Secondary	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location using Order type Connect Secondary and OrderItem action new.	Order type OrderItem ProductOffering id Place id Product id	Order id Order type OrderItem ProductOffering id Place id Site Visit information Order Feasibility Result Item Detail
Customer Requests Order Feasibility - Order type Connect and Replace with No CSE	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location using Order type Connect and Replace and OrderItem action new.	Order type OrderItem ProductOffering id Place id	Order id Order type OrderItem ProductOffering id Existing Product id Place id Site Visit information Order Feasibility Result Item Detail
Customer Requests Order Feasibility - Order type Connect and Replace with CSE	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location using Order type Connect and Replace and OrderItem action new.	Order type OrderItem ProductOffering id Place id	Order id Order type OrderItem ProductOffering id Existing Product id Place id Site Visit information Order Feasibility Result Item Detail
Customer Requests Order Feasibility - Order type Move Primary	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location using: Order type Move Primary - OrderItem action new Order type Move Primary - Order Item action relinquish.	Order type OrderItem ProductOffering id Place id Order type OrderItem Product id	Order id Order type OrderItem ProductOffering id Place id Site Visit information Order Feasibility Result Item Detail Order type OrderItem Product id Site Visit information Order Feasibility Result Item Detail
Customer Requests Order Feasibility - Order type Move Additional ONT	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location, using: Order type Move Primary - OrderItem action new Order type Move Primary - OrderI tem action relinquish.	Order id Order type OrderItem ProductOffering id Place id Order type OrderItem Product id	Order id Order type OrderItem ProductOffering id Place id Site Visit information Order Feasibility Result Item Detail Order type OrderItem Product id Site Visit information Order Feasibility Result Item Detail
Customer Requests Order Feasibility - Order Type Change Offer	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location, using: Order type Change Offer - OrderItem action new Order type Change Offer - OrderItem action relinquish.	Order type OrderItem ProductOffering id Place id Order type OrderItem Product id	Order id Order type OrderItem ProductOffering id Place id Site Visit information Order Feasibility Result Item Detail Order type OrderItem Product id Site Visit information Order Feasibility Result Item Detail
Customer Requests Order Feasibility - Order Type Modify Attribute	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location, using: Order Type Modify Attribute - OrderItem action modify.	Order type OrderItem Product id	Order id Order type OrderItem ProductOffering id Place id Site Visit information Order Feasibility Result Item Detail
Customer Requests Order Feasibility - Order Type Modify Attribute (CSE)	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location, using: Order type Modify Attribute - OrderItem action new Order type Modify Attribute - OrderItem action modify.	Order type OrderItem ProductOffering id Place id Order type OrderItem Product id	Order id Order type OrderItem ProductOffering id Place id Site Visit information Order Feasibility Result Item Detail Order type OrderItem Product id Site Visit information Order Feasibility Result Item Detail
Customer Requests Order Feasibility - Order Type Disconnect Primary	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location, using: Order type Type Disconnect Primary - OrderItem action relinquishes.	Order type OrderItem Product id	Order id Order type OrderItem ProductOffering id Place id Site Visit information Order Feasibility Result Item Detail
Customer Requests Order Feasibility - Order Type Transfer Primary	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location, using: Order type Transfer Primary - OrderItem action new.	Order type OrderItem ProductOffering id Place id to be transferred Existing Provider Name Place id	Order id Order type OrderItem ProductOffering id Place id to be transferred Existing Provider Name Place id Site Visit information Order Feasibility Result Item Detail
Customer Requests Order Feasibility - Order Type Transfer Secondary	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location, using: Order type Transfer Secondary - OrderItem action new.	ProductOffering id Place id to be transferred Existing Provider Name Place id	Order id Order type OrderItem ProductOffering id Place id to be transferred Existing Provider Name Place id Site Visit information Order Feasibility Result Item Detail

Use Case Exceptions

The following table describes the use case exceptions that support this business process.

Click on the scenario link to view the XML sample.

SCENARIO	DESCRIPTION	QUERY REQUEST	QUERY RESPONSE
Customer Requests Order Feasibility, Supplier location id not found	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location using Order type Connect Primary and OrderItem action new.	Order type OrderItem ProductOffering id Place id	Order type OrderItem ProductOffering id Place id Exception message
Customer Requests Order Feasibility - Supplier location id not Valid	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location using Order type Connect Primary and OrderItem action new.	Order type OrderItem ProductOffering id Place id	Order type OrderItem ProductOffering id Place id Exception message
Customer Requests Order Feasibility - not Onboarded for the Requested Product Offer	Query Order Feasibility is executed to determine if the Product Offer is feasible at the location using Order type Connect Primary and OrderItem action new.	Order type OrderItem ProductOffering id Place id	Order type OrderItem ProductOffering id Place id Exception message

Success Criteria

This section provides a list of the User Story References that we have met in this business process, as defined by the Ultra-Fast Broadband BSS / OSS Business Interaction Framework.

The document is available from:

Refer to the TCF website for documentation.

Request Success Criteria

ID	DESCRIPTION
US04	As aService ProviderIwanttosubmitapre-qualificationrequestviatheOSS/BSSsoI can save time andcost.
SC04.01	The Service Provider can enter an individual pre-qualification request via the B2B.
SC04.05	The ServiceProvidercansearchbytheuniqueaddressidentifiernumber–Supplier Location ID.
US10	As a Service ProviderI want the option of having a manual pre-qualification completed so that I can find out more about the address.
SC10.01	The Service Provider can enter a manual pre-qualification request via the B2B.
US12	As aServiceProviderI want relevant manual pre-qualification information so I can help my customer make a purchasing decision.
US18	As the LFC I want to collect all relevant information on the manual pre-qualification so I can manage the order effectively.

Response Success Criteria

ID	DESCRIPTION
US05	As a Service Provider I want to receive a notification confirming that my pre-qualification request has been received so that I know it has been logged.
SC05.02	The notification contains the Pre-Qualification Request Reference Number.
SC05.03	The notification contains a date and time stamp.
US06	As a Service Provider I want the automatic pre-qualification to return relevant information on the address so I can present options to a customer making a purchasing decision.
SC06.01	Service Provider is notified if the address or unique address identifier cannot be found.
SC06.02	Service Provider is notified if the unique address identifier is in an invalid format.
SC06.04	The Service Provider is informed of the Central Office identifier servicing the location.
SC06.05	The Service Provider is informed if fibre is available at the location.
SC06.06	If fibre is not currently available but will be in future, the Service Provider is informed of the date fibre will be available at the location.
SC06.07	The Service Provider is notified of the build stage name or identifier within the LFC build area.
SC06.08	The Service Provider is informed whether the premise is likely to be a standard or nonstandard install (where applicable).
SC06.09	The Service Provider is notified where the Premise cannot be determined as standard or non-standard installation (unknown installation type).
SC06.12	The Service Provider is informed of the POI.
SC06.13	The Service Provider is informed whether the service will be underground or overhead.
SC06.14	The Service Provider is informed of the type of premise where possible: Multi-Dwelling Unit (MDU), Single Dwelling Unit (SDU).
SC06.16	The Service Provider is provided with additional information about the location, for example, it is on a right-of-way or part of a gated community.
US12	As aServiceProviderI want relevant manual pre-qualification information so I can help my customer make a purchasing decision.
SC12.01	The Service Provider is informed of the Central Office identifier servicing the location.
SC12.02	The Service Provider is informed of the type of premise: Multi-Dwelling Unit (MDU), Single Dwelling Unit (SDU).
SC12.06	The Service Provider is informed whether a consent process is underway for the property.

Fibre Ordering

BIC002: Customer Requests Product Offer Availability

Getting Started Architecture Processes Web services Help & support FAQs

Back

Name

Customer Requests Product Offer (PO) Availability

Description

This process provides you with the ability to check which products are available at a specified location, that you have been on boarded to order.

Note: This process does not validate if a product can be provisioned at the location.

Related B2B Services

Flow - Customer Requests Product Offer Availability

bic002

Process Pre-conditions

Supplier Location ID provided in a valid format.

Process Post-conditions

Products and their availability information
Location specific network availability information.

Basic Path

STEP	DESCRIPTION	ROLE
1	Send product availability request with Supplier Location ID (Place id).	Customer
2	Receive the request, validate location information and determine if the location is serviceable. Determine product availability and customer eligibility. If location information is invalid refer to alternate flow 1.	Chorus
3	Provide the product and network availability information in response. C	Chorus
4	Receive the product availability response.	Customer

Alternate flow 1

STEP	DESCRIPTION	ROLE
2.1	If the location information is invalid, return an error response.	Chorus
2.2	Return an error response explaining why a product availability match cannot be completed.	Chorus

Refer to the Exception Codes table for error details.

Business Rules

The following table provides the list of industry rules that we have met with this business process, as defined by the Ultra-Fast Broadband BSS / OSS Business Interaction Framework.

This document is available from:

Refer to the TCF website for documentation

ID	BUSINESS RULE
Chorus-IR005	We return all results.

Product Offer Information

The following rules describe the information we will include in our Product Offer responses.

Offers will be presented with Zone information describing the UFB zone status.
If an address has fibre network infrastructure available in a non-UFB or pre-UFB state, we will determine whether UFB services are available and return available product offers.
We will only return current Product Offers.

Please refer to Chorus product catalogue and price book for pricing information.

Exception Codes

The Exception Codes table lists the exceptions that may be returned by this service.

For a full list of exception codes and their meanings see B2B Exception Codes.

EXCEPTION CODE	EXCEPTION MESSAGE
000	Backend processing error encountered - If problem persists please contact Chorus Admin
001	Supplier Location ID not found
005	Supplier Location ID is not valid
007	Customer is not on-boarded for any Product Offers for this Location ID
011	Unknown filter criteria specified: {%S}

Use Cases

The following table describes the use cases that support this business process.

Click on the scenario link to view the XML sample.

SCENARIO	DESCRIPTION	REQUEST	RESPONSE
Customer Requests PO Availability - No Filters Applied	Query product is executed to check available product offers.	Place id	Product characteristics Product offering details Network availability information
Customer Requests PO Availability - Filter by Offer_Type Customer Requests PO Availability - Filter by Family_Type	Query product is executed to check available product offers where the OFFER_TYPE filter of Primary has been applied. Query product is executed to check available product offers where the FAMILY_TYPE filter has been applied.	Place id Filter parameters Place id Filter parameters	Product characteristics Product offering details Network availability information Product characteristics Product offering details Network availability information
Customer Requests PO Availability - Filter by Family_Type, Market_Segment_Code and Offer_Type	Query product is executed to check available product offers where all filters have been applied.	Place id Filter parameters	Product characteristics Product offering details Network availability information

SCENARIO

DESCRIPTION

REQUEST

RESPONSE

Customer Requests PO Availability - No Filters Applied

Query product is executed to check available product offers.

Place id

Product characteristics Product offering details Network availability information

Customer Requests PO Availability - Filter by Offer_Type

Customer Requests PO Availability - Filter by Family_Type

Query product is executed to check available product offers where the OFFER_TYPE filter of Primary has been applied.

Query product is executed to check available product offers where the FAMILY_TYPE filter has been applied.

Place id Filter parameters

Product characteristics

Product offering details

Network availability information

Product characteristics

Product offering details

Network availability information

Customer Requests PO Availability - Filter by Family_Type, Market_Segment_Code and Offer_Type

Query product is executed to check available product offers where all filters have been applied.

Place id Filter parameters

Product characteristics

Product offering details

Network availability information

Use Case Exceptions

The following table describes the use case exceptions that support this business process.

Click on the scenario link to view the XML sample.

SCENARIO	DESCRIPTION	REQUEST	RESPONSE
Customer Requests PO Availability - Supplier Location ID is not valid	Query product is executed to check available product offers. The Place id is invalid.	Place id	Place id Exception message
Customer Requests PO Availability - No POs onboarded	Query product is executed to check available product offers. You are not onboarded for any products at this location.	Place id	Place id Exception message
Customer Requests PO Availability - Supplier Location ID not found	Query product is executed to check which offers, from our product catalogue, that you have been onboarded to order. The Place id is not found.	Place id	Place id Exception message
Customer Requests PO Availability - Backend processing error	Query product is executed to check which offers, from our product catalogue, that you have been onboarded to order. A backend processing error occurs	Place id	Place id Exception message
Customer Requests PO Availability - Unknown filter criteria	Query product is executed to check which offers, from our product catalogue, that you have been onboarded to order. An unknown filter parameter has been used.	Place id Filter parameter	Place id Exception message

Success Criteria

This section provides a list of the User Story References that we have met in this business process, as defined by the Ultra-Fast Broadband BSS / OSS Business Interaction Framework.

The document is available from:

Refer to the TCF website for documentation.

Request Success Criteria

ID	DESCRIPTION
US04	As a Service Provider I want to submit a pre-qualification request via the OSS/BSSsoI can save time andcost.
SC04.01	The Service Provider can enter an individual pre-qualification request via the B2B.
SC04.05	The Service Provider can search by the unique address identifier number.

Response Success Criteria

ID	DESCRIPTION
US06	As a Service Provider I want the automatic pre-qualification to return relevant information on the address so I can present options to a customer making a purchasing decision.
SC06.01	Service Provider is notified if the address or unique address identifier cannot be found.
SC06.02	Service Provider is notified if the unique address identifier is in an invalid format.
SC06.04	The Service Provider is informed of the Central Office identifier servicing the location.
SC06.05	The Service Provider is informed if fibre is available at the location.
SC06.06	If fibre is not currently available but will be in future, the Service Provider is informed of the date fibre will be available at the location.
SC06.07	The Service Provider is notified of the build stage name or identifier within the LFC build area.
SC06.08	The Service Provider is informed whether the premise is likely to be a standard or nonstandard install (where applicable).
SC06.09	The Service Provider is notified where the Premise cannot be determined as a standard or non-standard installation (unknown installation type).
SC06.11	TheService Provideris informed of the products available at the location that they have been certified for.
SC06.12	The Service Provider is informed of the POI.
SC06.13	The Service Provider is informed whether the service will be underground or overhead.
SC06.14	The Service Provider is informed of the type of premise where possible: Multi Dwelling Unit (MDU), Single Dwelling Unit (SDU).
SC06.15	The Service Provider is informed of the build state of the premise.
SC06.16	The Service Provider is provided with additional information about the location, for example, it is on a right-of-way or part of a gated community.
US37	As the LFC I want to limit the products the Service Provider can order to only those which they have been authorised to order so I can avoid processing of invalid service requests.
SC37.01	The Service Provider can only view products which they are certified for.

Fibre Ordering

BIC001: Query Address or Location

Getting Started Architecture Processes Web services Help & support FAQs

Back

Name

Customer Queries Address or Location

Description

This process provides you with the ability to submit a location to be validated and to retrieve the unique location identifier, which you will use to call subsequent B2B services.

Related B2B Services

Query Place

Related Touch points

Flow - Customer Queries Address or Location

queryaddresslocation

Pre-conditions

Location information is provided in a valid format.

Post-conditions

A single address match is returned with the Supplier Location (Place id).
If there are multiple matches a list of possible addresses is returned with the respective Supplier Locations (Place ids).
If there are no matches, an empty list is returned.

Basic Path

STEP	DESCRIPTION	ROLE
1	Send address location query.	Customer
2	Receive and validate the request. If the validation returns a partial match refer to alternate flow 1. If the validation fails refer to alternate flow 2.	Chorus
3	Return the place response with the address information and the Supplier Location (Place id).	Chorus
4	Receive the place response.	Customer

Alternate Flow 1

STEP	DESCRIPTION	ROLE
1.1	If a partial address match is found, return a list of matching addresses.	Chorus
1.2	Return the place response with a list of addresses and Supplier Locations (Place ids).	Chorus

Refer to the Exception Codes table for error details.

Business Rules

The following table provides the list of industry rules that we have met with this business process, as defined by the Ultra-Fast Broadband BSS / OSS Business Interaction Framework.

This document is available from:

Refer to the TCF website for documentation

ID	BUSINESS RULE
TCF-IR002	The minimum information required to return a partial list of location result(s) when performing an address based request is a street name.
Chorus-IR005	If any search result list is less than or equal to 200 we will return all results. Where a search result returns 200 results then the search criteria needs to be refined.

Exception Codes

The Exception Codes table lists the exceptions that may be returned by this service.

For a full list of exception codes and their meanings see B2B Exception Codes.

EXCEPTION CODE	EXCEPTION MESSAGE
000	Backend processing error encountered - If problem persists please contact Chorus admin
001	Supplier Location ID not found
002	Address not found
004	Required field PLSAM not valid - Please provide a valid PLSAM (1 to 7 digits)
005	Supplier Location ID is not valid
006	Element streetAlphaNumeric contains an invalid value
008	Element streetName contains an invalid value
009	TUI Address Key is not valid
010	TUI Address Key not found
021	EXCHANGE_CODE Address Key is not valid
022	Specified Address Key ‘type’ is not valid
023	PLSAM Address Key is not found
024	EXCHANGE_CODE Address Key is not found
028	Multiple results for Exact Match details entered
035	Unable to determine location search type

Use Cases

The following table describes the use cases that support this business process.

Click on the scenario link to view the XML sample.

SCENARIO	DESCRIPTION	REQUEST	RESPONSE
Customer Queries by BIF Structured Address - Single MDU Premises Returned Customer Queries by BIF Structured Address - Using Partial Address Match Customer Queries by BIF Structured Address - Single Address Match Returned	Query Place is executed using BIF Structured Address matching, to determine if a location is valid.	BIF Structured Address Fields	BIF Structured Address Place id
Customer Queries by BIF Structured Address - Using Exact Match Flag	Query Place is executed using BIF Structured Address and exact matching, to determine if a location is valid.	BIF Structured Address Fields Exact Match Flag	BIF Structured Address Place id
Customer Queries by Supplier Place ID	Query Place is executed using the Place id, to determine if a location is valid.	Place id	BIF Structured Address Core Logic Address Place id
Customer Queries by PLASM ID Address Key	Query Place is executed using PLSAM AddressKey matching, to determine if a location is valid.	PLSAM ID	BIF Structured Address PLSAM ID Place id
Customer Queries by Terralink (TUI) ID Address Key	Query Place is executed using TUI AddressKey matching, to determine if a location is valid.	TUI	Core Logic Structured Address TUI Place id
Customer Queries by CoreLogic Address	Query Place is executed using Core Logic Address matching, to determine if a location is valid.	Core Logic Structured Address	Core Logic Structured Address Place id
Customer Queries by CoreLogic Address - Using Exact Match Flag	Query Place is executed using Core Logic Address and exact matching, to determine if a location is valid.	Core Logic Structured Address	Core Logic Structured Address Place id

Use Case Exceptions

The following table describes the use case exceptions that support this business process.

Click on the scenario link to view the XML sample.

SCENARIO	DESCRIPTION	QUERY REQUEST	QUERY RESPONSE
Customer Queries by BIF Structured Address - Address not found	Query Place is executed using BIF structured Address matching, to determine if a location is valid. The address is not valid.	BIF Structured Address Fields.	Query details Exception message.
Customer Queries by BIF Structured Address - InvalidstreetAlphaNumeric	Query Place is executed using BIF Structured Address matching, to determine if a location is valid. streetAlphaNumeric contains an invalid value, e.g. it may contain special characters.	BIF Structured Address Fields.	Query details Exception message.
Customer Queries by TUI ID Address Key - Invalid TUI ID Customer Queries by TUI ID Address Key - TUI ID not found	Query Place is executed using TUI AddressKey matching, to determine if a location is valid. The TUI ID is invalid or not found.	AddressKey type - TUI	TUI ID Exception message
Customer Queries by Supplier Location ID - Supplier Location ID Invalid Customer Queries by Supplier Location ID - Supplier Location ID Not found	QueryPlaceisexecutedusingthe Place id, to determine if a location is valid. The place id is invalid or not found.	Place id	Query details Exception message.
Customer Queries by Supplier Location ID - Back-end Processing Exception Error Occurs	Query Place is executed. A backend process error occurs.	Place id	Query details Exception message.

Success Criteria

This section provides a list of the User Story References that we have met in this business process, as defined by the Ultra-Fast Broadband BSS / OSS Business Interaction Framework.

The document is available from:

Refer to the TCF website for documentation

Request Success Criteria

ID	DESCRIPTION
US04	As a Service Provider I want to submit a pre-qualification request via the OSS/BSSsoI can save time and cost.
SC04.01	The Service Provider can enter an individual pre-qualification request via the B2B.
SC04.04	The Service Provider can search by an address.
SC04.05	The Service Provider can search by the unique address identifier number.
US14	As a Service Provider I want to be able to search on a partial address so I can select the correct address
SC14.01	The Service Provider enters street name and a list of results are returned.
SC14.02	The Service Provider enters a suburb and a list of results is returned.
US17	As a Service Provider I want a single, unique address identifier for a property so that I am clear what property a LFC is referring to.
SC17.02	The LFC has a process for notifying the Service Provider of the unique identifier.
US34	As a Service Provider I don’t want to have to re-enter any information that comes from the pre-qual so I can save time when placing a service request order.
SC34.03	Service Provider can submit a key related to a previous transaction when submitting a service request via the B2B so they don’t have to submit the whole address.(place ID).

Response Success Criteria

ID	DESCRIPTION
US06	As a Service Provider I want the automatic pre-qualification to return relevant information on the address so I can present options to a customer making a purchasing decision.
SC06.01	Service Provider is notified if the address or unique address identifier cannot be found.
SC06.02	Service Provider is notified if the unique address identifier is in an invalid format.
SC06.03	The Service Provider is informed of the unique address identifier number if not provided.
US14	As a Service Provider I want to be able to search on a partial address so I can select the correct address.
SC14.01	The Service Provider enters street name and a list of results are returned.
SC14.02	The Service Provider enters a suburb and a list of results is returned.
US16	As a Service Provider I want a consistent address format from all providers so that I can manage my databases.
SC16.01	The LFCs have an agreed address format.
US17	As a Service Provider I want a single, unique address identifier for a property so that I am clear what property a LFC is referring to.
SC17.02	The LFC has a process for notifying the Service Provider of the unique identifier.

Fibre Ordering

Help & support

Getting Started Architecture Processes Web services Help & support FAQs

Back

Additional information about B2B scheme

B2B Exception Codes

Get Support from our Team

Chorus Portal Customer List

Fibre Ordering

Web services

Getting Started Architecture Processes Web services Help & support FAQs

Back

Our B2B Web Services provide businesses integration services for each service group.

Click on the links to review the Web Service specifications.

Note: the Data Element section of each Web Service page uses > to identify Element tables, and -- for value tables. Element tables list elements and their cardinality, values tables list possible values for the element.

Assurance

B2B Web Services currently not implemented

Location, Product and Appointment Web Services

The location, product and appointment web services are used to retrieve pre-order information, request order feasibility and reserve the required appointments. It is mandatory to use the Query Order Feasibility web service before you create an order. The appointment web services are mandatory or recommended depending on the type of appointment.

webservices1

Order Fulfilment Web Services

The order fulfilment web services are used to create an order and manage it through the fulfilment process.

We will use the Amend Order Notification service to keep you updated with the latest order information.

You may also use the the Amend Order Request and Query Order Request multiple times to update your order or retrieve information.

webservices2

Supplier Initiated Web Service Flow

We use the supplier Create Order web service to perform an action on one of your existing products, e.g

if another customer's transfer order triggers the disconnection of your product.

Your response, and any updates we make to this order will use the Amend Order web services.

webservices3

Fibre Ordering

Processes

Getting Started Architecture Processes Web services Help & support FAQs

Back

Our B2B Web Services support a range of business processes for each service group.

Click on the links to review the business process details.

Location

BIC001: Query Address or Location

Product

BIC002: Query Product Offer Availability

BIC008: Request Site Information

Appointment

BIC004: Query Appointment Availability

BIC005: Request Appointment Reservation

Fulfilment

BIC003: Query Order Feasibility

BIC101: Customer Creates Order

BIC102: Supplier Amends Order

BIC105: Customer Amends Order

BIC108: SupplierNotifiesCustomerOrderInformationRequired

BIC113: Customer Requests Order Information

BIC116: Supplier Notifies of Order Cost Variation

BIC106-BIC110: Supplier Reschedules Order Appointment

BIC109: Customer Reschedules Order Appointment

BIC104: Supplier Cancels Order

BIC103: Customer Cancels Order

BIC114: Supplier Notifies Losing Customer of Transfer (Relinquish)

Assurance

No process specifications currently available

Fibre Ordering

Architecture

Getting Started Architecture Processes Web services Help & support FAQs

Back

Our architecture and security guidelines describe our B2B Web Services implementation in terms of TCF BIF Web Services Specification, configuration and extension.

They will enable you to build to our interface in order to facilitate Pre-qualification and Fibre provisioning through a B2B channel using the TCF web services specification as a guideline for web service interactions.

Click on the links to review the documentation.

Fibre Ordering

Getting Started

Getting Started Architecture Processes Web services Help & support FAQs

Back

Welcome to the knowledge base for our B2B Web Services.

We highly recommend you familiarise yourself with the content here so you can understand our on-boarding process and the context of how to use our web services to integrate your business with ours.

Help us improve

Fibre Ordering

BIC003: Query Order Feasibility

Flow - Customer Requests Order Feasibility

Basic Path

Alternate Flow 1

Business Rules

Exception Code Mappings

Use Cases

Use Case Exceptions

Success Criteria

Share

Fibre Ordering

BIC002: Customer Requests Product Offer Availability

Flow - Customer Requests Product Offer Availability

Basic Path

Alternate flow 1

Business Rules

Exception Codes

Use Cases

Use Case Exceptions

Success Criteria

Share

Fibre Ordering

BIC001: Query Address or Location

Flow - Customer Queries Address or Location

Basic Path

Alternate Flow 1

Business Rules

Exception Codes

Use Cases

Use Case Exceptions

Success Criteria

Share

Fibre Ordering

Help & support

Share

Fibre Ordering

Web services

Location

Product

Appointments

Fulfilment

Assurance

Location, Product and Appointment Web Services

Order Fulfilment Web Services

Supplier Initiated Web Service Flow

Share

Fibre Ordering

Processes

Location

Product

Appointment

Fulfilment

Assurance

Share

Fibre Ordering

Architecture

Share

Fibre Ordering

Getting Started

How to use our web service information

Share

Fibre passed statement of accuracy July 2019 data

Clean fibre-passed address July 2019