From 16 June 2025, we’ve upgraded our Home Fibre plans. These changes are now live, but while some documents on this site may still reference the old plan names, rest assured, the new speeds apply. Find out more.
Name
Customer Queries Site Information
Description
This process provides you with the ability to query a location and retrieve a list of active product instances, and open orders. This information allows you to make informed pre-sales decisions with your customers.
Related B2B Services
Preceded by
Pre-conditions
Post-conditions
Site information for the specified location is provided to the Customer.
| STEP | DESCRIPTION | ROLE |
|---|---|---|
| 1 | Send query site request with valid supplier location ID. | Customer |
| 2 |
Receive the request, validate location information and retrieve all active Product Instances, including information about Open orders and ONT details. If location information is invalid refer to alternate flow. |
Chorus |
| 3 | Provide the Site Information response to the Customer. | Chorus |
| 4 | Receive the Site Information response. | Customer |
| STEP | DESCRIPTION | ROLE |
|---|---|---|
| 2.1 | If the location information is invalid, return an error response. | Chorus |
| 2.2 | Return an error response explaining why aSite Information match cannot be completed. | Chorus |
Refer to the Exception Codes table for error details.
The following rules apply to the information we will include in the Query Site Information response.
Move Order Example
If an existing product is at location A and there is an in-flight order (Move Primary; from location A to location B), the query will return the following for:
Transfer Order Example
If an existing product is at location A and there is an in-flight order (Transfer Primary; from product 1 to product 2), the query will return the following:
For a full list of exception codes and their meanings see B2B Exception Codes.
| EXCEPTION CODE | EXCEPTION MESSAGE |
|---|---|
| 000 | Backendprocessingerrorencountered-Ifproblem persistspleasecontact Chorus admin |
| 001 | Supplier Location ID not found |
| 005 | Supplier Location ID is not valid |
The following table describes the use cases that support this business process.
| SCENARIO | DESCRIPTION | REQUEST | RESPONSE |
|---|---|---|---|
| Customer Requests Site Information, Response Contains Single ONT, One PRIMARY, One Secondary Instance |
Query site information is executed to obtain product and order information. The site has a single ONT, one primary and one secondary instance. |
|
|
| Customer Requests Site Information, Response Contains Single ONT, Primary Instance and Pending Order | Query site information is executed to obtain product and order information where the site has a single ONT, one primary instance and pending order. |
|
|
| Customer Requests Site Information, Response Contains Disconnect Primary and Pending Order | Query site information is executed to obtain product and order information where the site has a disconnected primary and a pending order. |
|
|
| Customer Requests Site Information, Response Contains Multiple ONTs, Primary Instances and Pending Orders for Other RSPs | Query site information is executed to obtain product and order information where the site has multiple ONTs, one primary instance, and pending orders for another Chorus Customer. |
|
|
| Customer Requests Site Information, Response Contains Single ONT with no Products | Query site information is executed to obtain product and order information where the site has single ONTs with no products. |
|
|
| Customer Requests Site Information, Response Contains Pending Order with no Existing ONT | Query site information is executed to obtain product and order information where the site has a pending order with no existing (installed) ONT. |
|
|
| Customer Requests Site Information, Response Contains no information | Query site information is executed to obtain product and order information where the site has no existing (installed) ONT. |
|
|
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 Site Information, Backend Processing Error | Query site information is executed to obtain product and order information, a backend processing error occurs. |
|
|
|
Customer Requests Site Information, Supplier Location ID is not Valid |
Query site information is executed to obtain product and order information, the Supplier Location ID is invalid. |
|
|
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 |
|---|---|
| US402 | As a Service Provider selling services to an end customer I want to know about the active LFC services for all RSPs at a location so that I can make an appropriate offerto my end customer. |
| SC402.01 | TheServiceProvideris provided with the product instance IDs of each active product instance at thatlocation. |
| SC402.03 | The Service Provider is provided with the product family of the LFC product offering that corresponds with each product instance ID. |
| SC402.04 | The LFC does not identify to other Service Providers the Product Offering that corresponds to that service instance. |
| SC402.05 | There is an industry minimum agreed list of values for Product Family. |
| SC402.07 | Where the product instance provided is not an instance of one of the products covered by the CFH contracts, the product family name will only be identified as ‘private’. |
| SC402.08 | The LFC identifies which product instances (and associated end point ports) are related. |
| SC402.09 | The Gaining Service Provider specifies the LFC Place ID when requesting information about active services at a location. |
| US403 | As a Gaining Service Provider I want to know about the ONT resources at a location so that I can identify which LFC service(s) I need to transfer to meet my End Customer’s requirements. |
| SC403.01 | Service Provider is provided with the corresponding ONT port number for each product instance id. |
| SC403.04 | LFCs use a common naming convention for identifying the ONT ports. |
Response Success Criteria
| ID | DESCRIPTION |
|---|---|
| US402 | As a Service Provider selling services to an end customer I want to know about the active LFC services for all RSPs at a location so that I can make an appropriate offerto my end customer. |
| SC402.01 | TheServiceProvideris provided with the product instance IDs of each active product instance at thatlocation. |
| SC402.03 | The Service Provider is provided with the product family of the LFC product offering that corresponds with each product instance ID. |
| SC402.04 | The LFC does not identify to other Service Providers the Product Offering that corresponds to that service instance. |
| SC402.05 | There is an industry minimum agreed list of values for Product Family. |
| SC402.07 | Where the product instance provided is not an instance of one of the products covered by the CFH contracts, the product family name will only be identified as ‘private’. |
| SC402.08 | The LFC identifies which product instances (and associated end point ports) are related. |
| SC402.09 | The Gaining Service Provider specifies the LFC Place ID when requesting information about active services at a location. |
| US403 | As a Gaining Service Provider I want to know about the ONT resources at a location so that I can identify which LFC service(s) I need to transfer to meet my End Customer’s requirements. |
| SC403.01 | Service Provider is provided with the corresponding ONT port number for each product instance id. |
| SC403.04 | LFCs use a common naming convention for identifying the ONT ports. |
| SC403.06 | The Gaining Service Provider specifies the LFC Place ID when requesting information about resources available at a location. |
| US404 | As a Service Provider I want to know about all open orders with the LFC for each of the active services they provide at a specified location so that I can make an appropriate offer to my End Customer. |
Name
Customer Requests Appointment Reservation
Description
This process provides you with the ability to reserve an Appointment Time Slot.
Note: the reservation prevents other transactions from acquiring the date and time slot, the appointment will be not be confirmed until you create the order. If the appointment is not confirmed, the reservation will time out and release the Appointment Time Slot.
Related B2B Services
Process Pre-conditions
You are reserving an appointment for a site visit where the bookable indicator is True and the order has not been created. You have executed BIC004: Query Appointment Availability and retrieved the available Appointment Time Slots.
Process Post-conditions
The Appointment Time Slot is reserved and an AppointmentSlot id is returned.
| STEP | DESCRIPTION | ROLE |
|---|---|---|
| 1 | Submit a request to reserve an appointment. | Customer |
| 2 |
Process the Reserve Appointment requestandassociatetheSiteVisitidto the AppointmentSlot id. Anew AppointmentSlot id is generated ifone does notalready existagainst the Site Visitid. If an Appointment Time Slot cannot be reserved or the input information is invalid, refer to Alternate Flow 1. |
Chorus |
| 3 | Return the AppointmentSlot id, Appointment Time Slot and the associated Site Visit id. | Chorus |
| 4 | Return an error response explaining why the Reserve Appointment cannot be completed | Customer |
| STEP | DESCRIPTION | ROLE |
|---|---|---|
| 2.1 | If the site information or appointment date and times are invalid, return an error response. | Chorus |
| 2.2 | ReturnanerrorresponseexplainingwhytheReserveAppointmentcannotbe completed. | Chorus |
Refer to the Exception Codes table for error details.
Reservation Expiry Timeframe
The appointment reservation triggers an expiration timer of 30 minutes. If the appointment is not confirmed within this time, using the Create Order service, the reservation will expire.
Update Existing Appointment Costs
Appointments rescheduled after 3pm, during the business day before they due to commence, may be subject to additional charges.
Calculating Lead-time
The service will return available Appointment TimeSlots as a morning or an afternoon slot. The dates, where appointments are available, will begin:
The following table shows the appointment types and the associated Lead-times.
| APPOINTMENT TYPE | OTHER ACTIVE APPOINTMENTS | OFFER TYPE | ADDITIONAL LEAD TIME | INTER-APPOINTMENT LEAD TIME | NOTES |
|---|---|---|---|---|---|
| Scope | N/A | Residential (default) | 1 day | 3 days or more |
Example:
|
| Install (or Install + CSE) | Scope | Residential (default) | 1 day | 3 days or more |
Example:
|
| Install (or Install + CSE) | None | Residential (default) | 4 days | N/A |
Example:
|
| CSE (stand alone) | N/A | Residential (default) | 2 days | N/A |
Example:
|
| Scope | N/A | Business or Educational | 1 day | 5 days or more |
Example:
|
| Install (or Install + CSE) | Scope | Business or Educational | Scope | 5 days or more |
Example:
|
| Install (or Install + CSE) | None | Business or Educational | 6 days | N/A |
Example:
|
| CSE (stand-alone) | N/A | Business or Educational | 2 days | N/A |
Example:
|
Inter-Appointment Lead-time
An Inter-Appointment is where more than one appointment is required for related changes at a site. For example, a site may require Scope and Install appointments.
The Order Feasibility query will return a Site id for each appointment type and you are required to book an appointments for each of them, using the appropriate Inter-Appointment Lead-times.
The inputFilterParameter provides the option of choosing a search criteria that returns only the Appointment time slots which comply with the Inter-Appointment Lead-time rules.
In cases where multiple appointments are required for an Order, you may need to sequence your Reserve Appointment Requests to avoid failing one or more of the validation rules.
Example:
You have a Scope appointment reserved for 30 June 2015 and an associated Install appointment reserved 3 July 2015, for a residential customer.
They ask you to reschedule the Scope appointment to 3 July 2015. The Lead-time validation rules prevent you from changing the Scope appointment to 3 July, until you have rescheduled the Install appointment.
Step 1 – Confirm that there are Scope Appointment Time Slots available for 3 July
Use the Query Appointment Availability to request a list of available Scope Appointments Time Slots, use:
This will return a list of Appointment Time Slots ignoring the appointment Lead-time rules. If there is an available time slot for 3 July, reschedule the Install appointment to or after 8 July 2015.
Step 2 – Reschedule the Install Appointment
Use the Query Appointment Availability to request a list of available Install Appointment Time Slots from 8 July 2015.
Step 3 – Reschedule the Scope Appointment
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 |
| 015 | Site Visit ID not found |
| 016 | DateTime Range not valid |
| 019 | Customer Order ID not found |
| 029 | The Order State of the specified Customer Order does not support the selected action |
| 030 | The Order ID provided belongs to a different customer |
| 031 | Site Visit request failed: {%s} |
| 032 | Site Visit reschedule request rejected |
| 034 | No timeslots available for provided date range |
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 Appointment Reservation - Scope Appointment | Query appointment reservation is executed to reserve a scope appointment. |
|
|
|
Customer Requests Appointment Reservation - Install Appointment |
Query appointment reservation is executed to reserve an install appointment. |
|
|
| Customer Requests Appointment Reservation - Install with CSE Appointment | Query appointment reservation is executed to reserve an install with CSE appointment. |
|
|
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 Appointment Reservation - Backend Processing Error Occurs | Query appointment reservation is executed to reserve the Appointment Time Slot. Backend processing error occurs. |
|
|
| Customer Requests Appointment Reservation - Site Visit ID not found | Query appointment reservation is executed to reserve the Appointment Time Slot. The Site Visit id is not found. |
|
|
| Customer Requests Appointment Reservation - Date time range not valid | Query appointment reservation is executed to reserve the Appointment Time Slot. The Date range is invalid. |
|
|
| Customer Requests Appointment Reservation - Site Visit ID belongs to a different Customer | Query appointment reservation is executed to reserve the Appointment Time Slot. Site Visit ID provided belongs to a different Customer |
|
|
Request and Response 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.
| ID | DESCRIPTION |
|---|---|
| US43 | As a Service Provider, I want to be able to book an appointment for when the LFC is going to perform a site visit so that I can inform the Customer that they need to be at home on that day. |
| SC43.03 | The Service Provider can view AppointmentTimeSlots in the response of a Query Appointment Request. |
| SC43.04 | The Service Provider can view AppointmentTimeSlots after the service request is created. |
| SC43.05 | The Service Provider can view available AppointmentTimeSlots and is allowed to book AppointmentTimeSlots by specifying an AppointmentTimeSlot value that is returned in the response. |
Name
Customer Request Appointment Availability
Description
This process provides you with the ability to retrieve the available Appointment Time Slots for an order.
Related B2B Services
Preceded by
Process Pre-conditions
If you are using query to retrieve an appointment for an order that you:
Process Post-conditions
You receive a response containing a range of available Appointment Time Slots.
If you used this query to retrieve a appointment for an order that you:
| STEP | DESCRIPTION | ROLE |
|---|---|---|
| 1 | Submit request for Site Visit or RFS appointments. | Customer |
| 2 | Process the request and generate the available Appointment Time Slots. If the Appointment Time Slots cannot be generated or the input information is invalid, refer to alternate flow 1. | Chorus |
| 3 | Return a range of Appointment Time Slots. | Chorus |
| 4 | Receive the range of Appointment Time Slots. | Customer |
| STEP | DESCRIPTION | ROLE |
|---|---|---|
| 2.1 | If the Appointment Availability request is invalid, return an error response. | Chorus |
| 2.2 | Return an error response explaining the Appointment Availability query cannot be completed. | Chorus |
Refer to the Exception Codes table for error details.
Input Date Validation
The dates submitted as search criteria must meet the following criteria:
Note: the Default Advance Schedule Duration is currently set to 89 days.
Update Existing Appointment Costs
Appointments rescheduled after 3pm, during the business day before they due to commence, may be subject to additional charges.
Calculating Lead-time
The service will return available AppointmentTimeSlots asa morning oran afternoon slot. The dates, where appointments are available, will begin:
The following table shows the appointment types and the associated Lead-times.
| APPOINTMENT TYPE | OTHER ACTICE APPOINTMENTS | OFFER TYPE | ADDITIONAL LEAD TIME | INTER-APPOINTMENT LEAD TIME | NOTES |
|---|---|---|---|---|---|
| Scope | N/A | Residential (default) | 1 day | 3 days or more |
Example: Scope (Day 1) Install (Day 4). |
| Install (or Install + CSE) | Scope | Residential (default) | 1 day | 3 days or more |
Example: Scope (Day 1) Install (Day 4). |
| Install (or Install + CSE) | None | Residential (default) | 4 days | N/A |
Example: Install (Day 4). |
| CSE (standalone) | N/A | Residential (default) | 2 days | N/A |
Example: CSE (Day 2). |
|
Scope |
N/A |
Business or Educational |
1 day | 5 days or more |
Example: Scope (Day 1) Install (Day 6). |
| Install (or Install + CSE) | Scope | Business or Educational | Scope | 5 days or more |
Example: Scope (Day 1) Install (Day 6). |
| Install (or Install + CSE) | None | Business or Educational | 6 days | N/A |
Example: Install (Day 6). |
| CSE (standalone) | N/A | Business or Educational | 2 days | N/A |
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 | Backendprocessingerrorencountered-Ifproblem persistspleasecontact Chorus admin |
| 015 | Site Visit ID not found |
| 016 | DateTime Range not valid |
| 017 | RFS validation failed: {%s} |
| 019 | Customer Order ID or Customer Reference ID not found |
| 029 | The Order State of the specified Customer Order does not support the selected action |
| 030 | The Order ID provided belongs to a different customer |
| 031 | Site Visit request failed: {%s} |
| 040 | Request for RFS date contains sitevisitID |
| 041 | Request for RFS date contains invalid RFS date type |
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 Queries Appointment Availability - to retrieve site visit appointments | Query Appointment Availability is executed to retrieve available site visit appointments for an order that has not been created, using the Order id and the SiteVisit id. |
|
Note: Appointment slots are between the current date and the end of the period set by the Default Advanced Schedule Duration, regardless of the Inter-Appointment Leadtimes. |
| Customer Queries Appointment Availability to retrieve RFS appointments | Query Appointment Availability is executed to retrieve available RFS date appointments for an existing order, using the Order id and SiteVisit type. |
|
|
| Customer Queries Appointment Availability - with TimeSlot filter | Query Appointment Availability is executed to retrieve available site visit appointments for an order that has not been created, using the Order id, the SiteVisit id and the TimeSlot FilterParameter. |
|
Note: Appointment slots are between the dates selected using the filter, regardless of the Inter-Appointment Lead-times. |
| Customer Queries Appointment Availability - with TimeSlot and VALIDATE_INTER_APPOINTMENT_LEADTIME - Yes filter | Query Appointment Availability is executed to retrieve available site visit appointments for an order that has not been created, using the Order id, the SiteVisit id and the TimeSlot and VALIDATE_INTER_APPOINTMENT_LEADTIME FilterParameters. |
|
|
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 Appointment Availability - backend processing error occurs | Query Appointment Availability is executed to check available appointments times and dates. Backend processing error occurs. |
|
|
| Customer Queries Appointment Availability - SiteVisit id is not found | Query Appointment Availability is executed to check available appointments times and dates. The Site Visit id is not found. |
|
|
| Customer Queries Appointment Availability - dateTime range not valid | Query Appointment Availability is executed to check available appointments times and dates. The date range is invalid. |
|
|
| Customer Queries Appointment Availability - Order id belongs to a different customer |
Query Appointment Availability is executed to check available appointments times and dates. The Order id provided belongs to a different Customer. |
|
|
| Customer Queries Appointment Availability- site visit request contains SiteVisit type | Query Appointment Availability is executed to check available Scope appointments dates. The request for site visit appointments includes the SiteVisit type field. |
|
|
| Customer Queries Appointment Availability - RFS date request contains SiteVisit id | Query Appointment Availability is executed to check available RFS dates. The request for RFS dates includes the SiteVisit id field. |
|
|
Query Appointment Availability Request and Response 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.
| ID | DESCRIPTION |
|---|---|
| US43 | As a Service Provider, I want to be able to book an appointment for when the LFC is going to perform a site visit so that I can inform the Customer that they need to be at home on that day. |
| SC43.03 | The Service Provider can view Appointment TimeSlots in the response of a Query Appointment Request. |
| SC43.04 | The Service Provider can view Appointment TimeSlots after the service request is created. |
| SC43.05 | The Service Provider can view available Appointment TimeSlots and is allowed to book Appointment TimeSlots by specifying an Appointment TimeSlot value that is returned in the response. |
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
Preceded by
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:
| 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 |
| 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.
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:
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.
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} |
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. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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:
|
|
|
| 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:
|
|
|
| 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:
|
|
|
| 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. |
|
|
| 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:
|
|
|
| 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:
|
|
|
| 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:
|
|
|
| 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:
|
|
|
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. |
|
|
| 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. |
|
|
| 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. |
|
|
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. |
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
Process Pre-conditions
Process Post-conditions
| 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 |
| 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.
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.
Please refer to Chorus product catalogue and price book for pricing information.
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} |
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 |
|
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 |
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. |
|
|
| 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. |
|
|
| 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. |
|
|
| 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 |
|
|
| 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. |
|
|
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. |
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
Related Touch points
Pre-conditions
Post-conditions
| 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 |
| 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.
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. |
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 |
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 |
|
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 |
|
|
Query Place is executed using PLSAM AddressKey matching, to determine if a location is valid. |
PLSAM ID |
BIF Structured Address PLSAM ID Place id |
|
|
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 |
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. |
| 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. |
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. |
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.
B2B Web Services currently not implemented
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.
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.
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.
Our B2B Web Services support a range of business processes for each service group.
Click on the links to review the business process details.
BIC003: Query Order Feasibility
BIC101: Customer Creates 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)
No process specifications currently available
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.