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.
This B2B service allows you to query a location to review active product instances and open orders.
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/O |
The primary key for address or location searches. The Place id is commonly referred to as:
or
|
The following table describes the Product elements.
Note: if an Order/OrderItem is acting on a product instance, the product id will also be included. A common example is where an in-flight order exists to disconnect(relinquish) a product. In these cases, it is important that you can identify which product is being relinquished, particularly where multiple products exist at a location.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | O | Product identifier. | |
| ProductCharacteristic | O | Lists the product characteristics. | |
| Order | O | Orders are included if the order has reached the state and substate Acknowledged/Received, and has not passed the state Service Given. | |
| SiteInformationInteractionItemDetails | O | Site inventory items. |
The following table describes the ProductCharacteristic elements
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| ONT_ID | O | Identifier of the ONT that the product is using. | |
| ATA_PORT | O | ATA port. | |
| PORT_NUMBER | O | Port Number of the ATA port that the product is using. | |
| UNI_PORT | O | UNI port | |
| PORT_NUMBER | O | Port Number of the UNI port the product is using. | |
| FAMILY_TYPE | O | Family of related products. | |
| OFFER_TYPE | O | Type of offer. | |
| OWNED_BY_RSP | O | Flag to indicate if the requesting customer owns the product. |
The following table describes the values provided by the family type element
| VALUE | DESCRIPTION |
|---|---|
| BITSTREAM | Fibre to the premises |
| CSE | Customer Servic |
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 values provided by the OWNED_BY_RSP element.
| VALUE | DESCRIPTION |
|---|---|
| Y | Product is owned by the requesting customer. |
| N | Product is NOT owned by the requesting customer. |
The order elements contain Order header information. The following table describes the Order elements
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | O | Order identifier. | |
| type | O | Type of order. | |
| OrderItem | O | Contains details of the order items. |
The OrderItem elements contain details of the Order items. The following table describes the OrderItem elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | O | Order item identifier. | |
| action | O | Type of action to be performed. | |
| state | O | Used to manage the order progress. | |
| substate | O | Used to manage the order progress against each state. | |
| Timing | O | Timing information for order items. |
The following table describes the values provided by the action element.
| VALUE | DESCRIPTION |
|---|---|
| new |
Creates or connects a new product for the customer. Note: this includes moves and transfers. |
| modify | Modify or change the characteristics of an existing product. |
| relinquish | Relinquish or disconnect an existing product. |
Orders are managed using status and sub-status. The status changes as the order progresses and when scoping and installation work is carried out. Not all statuses apply to all orders.
The following table describes the values provided by the state and associated substate elements.
| STATEVALUE | SUBSTATEVALUE | DESCRIPTION |
|---|---|---|
| Acknowledged | Received | The order has been received by Chorus. |
| Accepted | The order has been checked and is accepted for provisioning. | |
| In Progress | Consent Required | Consent is required before this order can be progressed. |
| Consent Requested | Consent has been requested. | |
| Consent Not Required | It has been determined that consent is not required for this order | |
| Consent Gained | Consent has been gained. | |
| Consent Declined | The consent request has been declined, or it was not obtained within the required time. | |
| Generate Quotation | A quote is being generated for the order. | |
| Intent to Cancel | Chorus has advised the intent to cancel the order and provided a reason for the cancellation. | |
| Network Design | The network design is currently in progress. | |
| Network Build | The network build is currently in progress. | |
| Scoping Scheduled | Scoping for this order has been scheduled. | |
| Scheduled | The order install has been scheduled. | |
| Investigation Required | Identified as a potential multi-dwelling unit (MDU) or right of way (ROW). Investigation is required. | |
| Held | Waiting on Quote Acceptance | A quote has been created and is ready for your acceptance. |
| Schedule Scoping | Scoping for this order is to be scheduled. | |
| Schedule Install | You now need to schedule the required installation date | |
| Intent to Cancel | Chorus has advised the intent to cancel the order and provided a reason for the cancellation. | |
| Provider to Advise | You need to provide information to Chorus before the order can progress. | |
| Pending Disconnect Acceptance | ||
| Service Given | Service Given | Installation work is now complete. The end-user should now be able to use the service at their location. |
| Completed | Billing | Billing is now complete |
| Closed | Rejected | The order has been rejected. |
| Cancelled | The order has been cancelled and closed. | |
| Completed | The order has been completed and closed. |
Note: An order is placed in the Held stage when we are waiting for an action to be completed by you
The timing details are provided where they are available. In most cases, this is once the values have been set, it may also be dependent on other order lifecycle scenarios.
The following table describes the Timing elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| name | o | Description of the dateTime value. | |
| dateTime | o | Date and time value. |
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 values provided by the name element.
| VALUE | DESCRIPTION |
|---|---|
| CONNECT_RFS_DATE_TIME | Service connection dates. |
| DISCONNECT_RFS_DATE_TIME | Service disconnection dates |
| ORDER_DATE | Date and time of the order feasibility request. |
The following table describes the SiteInformationInteractionItemDetail elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| ONT_ID | O | ONT Identifier. | |
| ONT_STATUS | O | Status of the ONT. |
The following table describes the values provided by the ONT_STATUS element.
Note: if an ONT is not installed, the ONT_STATUS value is NULL, and the element is not returned in the response.
| VALUE | DESCRIPTION |
|---|---|
| INTACT | ONT is installed at the location. |
QuerySiteInformationRequest
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). |
| NAME | QUERYSITEINFORMATIONREQUEST |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Query site information for a location |
| Outputs | Synchronous Acknowledgement |
| Non-Repudiation | Yes. |
| Description | Initiates a transaction to query site information. |
QuerySiteInformationResponse
If a valid Place id was provided, the response will contain the Place id and the site information, as shown in the following table.
| FOR EACH | INFORMATION RETURNED |
|---|---|
| Active product |
Product Details Product id Family type Offer type UNI port configuration ATA port configuration RSP Owned ONT Details
|
| In-flight Orders |
Order Details
ONT Details
The ONT ID is included if the order has reached the state and substate of Acknowledged/Accepted, and has not been closed. |
| ONT installed with no active products and no inflight orders |
ONT Details
|
| NAME | QUERYSITEINFORMATIONRESPONSE |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Response to your query of site information for a location. |
| Outputs | Synchronous Acknowledgement. |
| Non-Repudiation | Yes. |
| Description | Query site information is processed or has an exception. |
We use this B2B notification to advise you that we have created an order on your behalf.
Related Business Process
Related Product
This service is available for fibre products.
The order elements contain Order header information. The following table describes the Order elements.
| NAME | OUTPUT | DESCRIPTION |
|---|---|---|
| id | Always | Order identifier returned by Query Order Feasibility. |
| BillingInformation | Conditional | Order billing details. |
| customerReferenceId | Conditional | Your unique orderreference number for matching this order to yourrecords. |
| type | Always | Type of order |
| OrderItem | Always | Details of the order items. |
The OrderItem elements contain details of the Order items. The following table describes the OrderItem elements.
| NAME | OUTPUT | DESCRIPTION |
|---|---|---|
| id | Always | Order item identifier. |
| action | Conditional | Type of action to be performed. |
| ExistingProviderDetail | Conditional | Existing provider and product details. |
| Timing | Conditional | Date for service activity. |
| Place | Conditional | Provide site access details.Order - OrderItem - action |
The following table describes the values provided by the action element.
| VALUE | DESCRIPTION |
|---|---|
| new |
Creates or connects a new product for the customer. Note: this includes moves and transfers. |
| modify | Modify or change the characteristics of an existing product. |
| relinquish | Relinquish or disconnect an existing product. |
The ExistingProviderDetail elements contain details of the existing provider (RSP) and the product being replaced. The following table describes the values provided by the ExistingProviderDetail element.
| VALUE | DESCRIPTION |
|---|---|
| productId | The product identifier for the product being replaced by the successful completion of the order. |
| existingProviderName | Chorus system name for the customer who owns the product that is being replaced. |
The following table describes the BillingInformation elements.
| NAME | OUTPUT | DESCRIPTION |
|---|---|---|
| billingAccount | Always | Your billing account value. |
| billingEffectiveDate | Conditional | Payment date for the bill. |
| cancellationFBN | Conditional | Number used to associate order cancellation charges. |
| Charge | Conditional | Charges for the order. |
The following table describes the values provided by the type element.
| VALUE | DESCRIPTION |
|---|---|
| Connect Primary | New connection for a primary product offer, where there is no existing primary product offer at the location. |
| Connect Additional ONT | New connection for a primary product offer, where there is an existing or pending primary product offer at the location. |
| Connect Secondary | New connection for a secondary product offer, where there is an existing primary product offer at the location. |
| Connect and Replace |
New Connection for a primary product offer, where there is an existing primary product offer at this location, which must be disconnected, and replaced by your incoming order. This order type is used when your end-customer is moving in to a property and assuming ownership. |
| Disconnect Primary | Disconnect of a primary product offer, where there is an active product instance. |
| Disconnect Secondary | Disconnect of a secondary product offer, where there is an active product instance. |
| Change Offer | Change of an existing product offer for an existing product instance – for the same RSP, end customer andlocation. |
| Modify Attribute | Modification of product attributes of an existing product instance. |
| Modify Attribute | Order a CSE for an existing product instance. |
| Move Primary |
Move your existing offer to a property where there is no existing primary product offer at the location. Note: If consent is required at the new address you will need to complete Disconnect and Connect orders instead of a Move. |
| Move Additional ONT | Add an additional ONT as part of the move. |
| Move and Replace |
New Connection for a primary product offer and disconnection of an existing customer product offer at a different location. Where there is an existing primary product offer at this location, which must be disconnected, and replaced by your incoming order. This order type is used when your end-customer is moving in to a property and assuming ownership. |
| Transfer Primary | Transfer of an existing primary product offerfrom another RSP to the Gaining (requesting) Service provider – for the same end customer and location. |
| Transfer Secondary | Transfer of an existing secondary product offerfrom another RSPto the Gaining (requesting) Service provider – for the same end customer and location. |
The following table describes the Timing elements.
| NAME | OUTPUT | DESCRIPTION |
|---|---|---|
| name | Always | Type of RFS date. |
| dateTime | Always | Date and time value. |
The following table describes the values provided by the name element.
| VALUE | DESCRIPTION |
|---|---|
| CONNECT_RFS_DATE_TIME | Service connection dates. |
| DISCONNECT_RFS_DATE_TIME | Service disconnection dates. |
The Place elements provide the location and equipment access information. The following table describes the Place element.
| NAME | OUTPUT | DESCRIPTION |
|---|---|---|
| id | Always | Location identifier. |
| Access | Conditional | Free text field to enter site access information. |
| EquipmentLocation | Conditional | Free text field to guidance on the location for the equipment installation. |
The following table provides details of the Notification elements.
| NAME | OUTPUT | DESCRIPTION |
|---|---|---|
| id | Always | Notification identifier. |
| type | Always | Type of information contained in the notification. |
| dateTime | Always | Date and time values using the xsd:dateTime format: YYYY-MMDDTHH:MM:SS+[UTC offset, e.g. 12:00]. |
| NotificationItem | Always | Details of the notification. |
The following table describes the values that may be returned by the CreateOrderNotification Notification - type element.
| VALUE | DESCRIPTION |
|---|---|
| INTENT_TO_DISCONNECT_SECONDARY | Theprimaryproducthasbeendisconnected, we provide you with the option of promoting your secondary product or accepting the disconnection. |
| CEASE_BILLING | Your end customer has transferred their product to another RSP. We advise your product disconnection. |
| INTENT_TO_DISCONNECT_ABANDONMENT | A new end customer is moving the location. We advise you of the intent to disconnection your product. |
The following table provides details of the NotificationItem elements.
| VALUE | DESCRIPTION |
|---|---|
| id |
Notification item identifier. A unique id will be returned with each notification item. |
| description | Description of the notification item. |
| reference | XPath reference of the notification item. |
The following table provides the OrderItem state and substate associated with the CreateOrderNotification - Notification - type - INTENT_TO_DISCONNECT_SECONDARY.
| ORDERITEM | VALUE |
|---|---|
| state | Held |
| substate | Provider To Advise |
The following table describes the values provided by the INTENT_TO_DISCONNECT_SECONDARY NotificationItem elements.
| VALUE | DESCRIPTION |
|---|---|
| description | Chorus has created a customer order on your behalf to disconnect a secondary product instance |
| reference | /CreateOrderNotification/Order/id[text()='ORDER_ID'] |
| description | Your secondary product instance is scheduled for disconnection |
| reference | /CreateOrderNotification/Order/OrderItem/ProductOffering/Product/id[text='*************'] |
| description | State transition |
| reference | /CreateOrderNotification/Order/OrderItem/state[text()='Current state'] |
| description | Sub-state transition |
| reference | /CreateOrderNotification/Order/OrderItem/substate[text()='Current substate'] |
| description | Please refer to the following customer order question |
| reference | /CreateOrderNotification/Order/OrderItem/Question/id[text='QUESTION_ID']../questionValue/text() |
| description | A response is required by |
| reference | /CreateOrderNotification/Order/OrderItem/Question/id[text='QUESTION_ID']/validFor/endDateTime/text() |
The following table provides the OrderItem state and substate associated with the CreateOrderNotification - Notification - type - CEASE_BILLING.
| ORDERITEM | VALUE |
|---|---|
| state | Closed |
| substate | Completed |
The following table describes the values provided by the CEASE_BILLING NotificationItem elements.
| VALUE | DESCRIPTION |
|---|---|
| description | We have received a request to transfer ${product_offer} Product ID ${product_instance}. Billing for this connection will cease from ${rfs_date}. |
The following table provides the OrderItem state and substate associated with the CreateOrderNotification - Notification - type - INTENT_TO_DISCONNECT_ABANDONMENT.
| ORDERITEM | VALUE |
|---|---|
| state | Held |
| substate | Provider To Advise |
The following table describes the values provided by the INTENT_TO_DISCONNECT_ABANDONMENT NotificationItem elements.
| VALUE | DESCRIPTION |
|---|---|
| description | Chorus has created a customer order on your behalf to disconnect a primary customer product instance |
| reference | /CreateOrderNotification/Order/id[text()='ORDER_ID'] |
| description | Your primary product instance is scheduled for disconnection |
| reference | /CreateOrderNotification/Order/OrderItem/Product/id |
| description | State transition |
| reference | /CreateOrderNotification/Order/OrderItem/state |
| description | Sub-state transition |
| reference | /CreateOrderNotification/Order/OrderItem/substate |
| description | Please refer to the following customer order question |
| reference | /CreateOrderNotification/Order/OrderItem/Question/questionValue |
| description | A response is required by |
| reference | /CreateOrderNotification/Order/OrderItem/Question/validFor/endDateTime |
Service Name
CreateOrderNotification
Service Outputs
Notifications contain the notification values, Order details.
This B2B service allows you to query a location and determine if a product offer can be provisioned or if changes can be made to existing product(s).
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 order elements contain Order header information. The following table describes the Order elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | O | Identifier for the order (this value will be reused as the Order id). | |
| type | Mandatory | I/O | Type of order. |
| OrderItem | Mandatory | I/O | Details of the order items. |
The following table describes the values provided by the type element.
| VALUE | DESCRIPTION |
|---|---|
| Connect Primary | New connection for a primary product offer, where there is no existing primary product offer at the location. |
| Connect Additional ONT | New connection for a primary product offer, where there is an existing or pending primary product offer at the location. |
| Connect Secondary | New connection for a secondary product offer, where there is an existing primary product offer at the location. |
| Connect and Replace |
New Connection for a primary product offer, where there is an existing primary product offer at this location, which must be disconnected, and replaced by your incoming order. This order type is used when your end-customer is moving in to a property and assuming ownership. |
| Disconnect Primary | Disconnect of a primary product offer, where there is an active product instance. |
| Disconnect Secondary | Disconnect of a secondary product offer, where there is an active product instance. |
| Change Offer | Change of an existing product offer for an existing product instance – for the same RSP, end customer andlocation. |
| Modify Attribute | Modification of product attributes of an existing product instance. |
| Modify Attribute | Order a CSE for an existing product instance. |
| Move Primary |
Move your existing offer to a property where there is no existing primary product offer at the location. Note: If consent is required at the new address you will need to complete Disconnect and Connect orders instead of a Move. |
| Move Additional ONT | Add an additional ONT as part of the move. |
| Move and Replace |
New Connection for a primary product offer and disconnection of an existing customer product offer at a different location. Where there is an existing primary product offer at this location, which must be disconnected, and replaced by your incoming order. This order type is used when your end-customer is moving in to a property and assuming ownership. |
| Transfer Primary | Transfer of an existing primary product offerfrom another RSP to the Gaining (requesting) Service provider – for the same end customer and location. |
| Transfer Secondary | Transfer of an existing secondary product offerfrom another RSPto the Gaining (requesting) Service provider – for the same end customer and location. |
The OrderItem elements contain details of the Order items. The following table describes the OrderItem elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | O | Order item identifier. | |
| action | Mandatory | I/O | Type of action to be performed. |
| Place | Mandatory | I/O | Location details. |
| Timing | O | Timing information for order items. | |
| ExistingProviderDetail | Conditional | I/O | Existing provider and product details. |
| ProductOffering | Conditional | I/O | Chorus catalogue product offering details. |
| Product | Conditional | I/O | Product details. |
The following table describes the values provided by the action element.
| VALUE | DESCRIPTION |
|---|---|
| new |
Creates or connects a new product for the customer. Note: this includes moves and transfers. |
| modify | Modify or change the characteristics of an existing product. |
| relinquish | Relinquish or disconnect an existing product. |
The following table describes the Place element.
| VALUE | DESCRIPTION |
|---|---|
| id |
Primary key for address or location. The Place id is commonly referred to as:
or
|
The following table describes the Timing elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| name | O | Description of the dateTime value. | |
| dateTime | O | Date and time value. |
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 values provided by the name element.
| VALUE | DESCRIPTION |
|---|---|
| ORDER_DATE | Date and time of the order feasibility request. |
The ExistingProviderDetail elements contain details of the existing provider (RSP) and product being replaced. The following table describes the values provided by the ExistingProviderDetail element.
| VALUE | DESCRIPTION |
|---|---|
| productId | Product identifier for the product being replaced by the successful completion of the order. |
| existingProviderName | Chorus system name for the customer who owns of the product that is being replaced. |
The following table describes the values provided by the ProductOffering element.
| VALUE | DESCRIPTION |
|---|---|
| id | Chorus catalogue product offering identifier. |
| name | Chorus catalogue product offering name. |
The following table describes the values provided by the Product element.
| VALUE | DESCRIPTION |
|---|---|
| id | Product identifier. |
The following table describes the OrderFeasibilityResult elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | O | Identifier for OrderFeasibilityResult. | |
| ValidFor | O | Start and end dates for the period the order feasibility is valid. |
The following table describes the values provided by the ValidFor element.
| VALUE | DESCRIPTION |
|---|---|
| startDateTime | Start date and time of the period that order feasiblity is valid. |
| endDateTime | End date and time of the period that order feasiblity is valid. |
Date and time values use the xsd:dateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00].
The ValidFor period calculation is based on the classification of the order contents shown in the following table.
| CLASSIFICATION | VALIDFOR |
|---|---|
| Family Type == Bitstream | 5 days. |
| Family Type == CSE | 30 days. |
Note: Where there are multiple classifications within a single order feasibility request, the shortest period will be applied.
The following table describes the OrderFeasibilityResultItem elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | O | Identifier for the OrderFeasibilityResultItem. | |
| FEASIBILITY_CODE | O | Feasibility reason code. | |
| FEASIBILITY_REASON | O | Describes why the order is or is not feasible. | |
| DEMAND_POINT_TYPE | O | Describesthedwellingorsituation at the address. | |
| INSTALL_TYPE | O | Type of installation expected to be required. | |
| CONSENT_REQUIRED | O | Flag to indicate if consent is required. | |
| DESIGN_REQUIRED | O | Flag to indicate if design is required. | |
| BUILD_REQUIRED | O | Flag to indicate if a build is required. | |
| AVAILABILITY_STATUS | O | Describes the fibre avaiability status at the address. | |
| DATA_HANDOVER_ID | O |
Data handover ID(s) for this location. All available handover IDs are returned. This applies to all order types except Disconnect Primary and Disconnect Secondary. |
|
| VOICE_HANDOVER_ID | O |
ATA Voice handover ID(s) for this location. All available handover IDs are returned. This applies to all order types except Disconnect Primary and Disconnect Secondary. |
|
| AVAILABLE_RFS_DATES | O | An array of RFS Dates available for completion of the order. Returned for orders that do not require a site visit. |
The following table describes the values provided by the FEASIBILITY_CODE element.
| VALUE | DESCRIPTION |
|---|---|
| 999 | Placing the order will require manual activity by Chorus, it is not feasible in its current state. |
| 998 | The order is feasible and can be submitted to initiate provisioning. |
| 997 | Closed, the feasibility check shows that placing the order is not possible. |
| 996 | This reason code would not be returned by the web service. |
The following table describes the values provided by the FEASIBILITY_REASON element.
Note: as shown in the table, not all FEASIBILITY_CODE values have a corresponding FEASIBILITY_REASON.
| VALUE | FEASIBILITY_CODE |
|---|---|
| Order Not feasible (default reason when no specific reason exists) | 999 |
| Consentdeclined in the location.RequestManualFeasibility to proceed if required. | 999 |
| Fibre is not available in the location. Request Manual Feasibility to proceed if required. | 999 |
| Feasibility request requires manual investigation. | 999 |
| Feasible to Order (default reason when no specific reason exists) | 998 |
| Design and Build is required if Customer Order is submitted for this location. | 998 |
| Consent is required if Customer Order is submitted. | 998 |
| Feasible to Provide Service at Location.Select an appointment to proceed to Customer Order. | 998 |
| Your order is feasible at the given location, please select an RFS date | 998 |
| Hyperfibre Design and Build is required before appointment selection if Customer Order is submitted for this location. | 998 |
| Order Not Feasible (default reason when no specific reason exists) | 997 |
| Product Instance has inflight order, you will need to cancel any inflight orders against the product and try again | 997 |
| The same ONT has inflight product order, you will need to cancel any inflight orders first and then try again. | 997 |
| Replace Product Instance has inflight order, you will need to cancel any inflight orders against product and try again | 997 |
| Insufficient resources available | 997 |
| Product Instance does not exist at specified location | 997 |
| Invalid address or location | 997 |
| Customer not onboarded for requested Product Offer | 997 |
| The Product Instance provided belongs to a different customer | 997 |
| Unbundled services are not available at this location | 997 |
| Cannot transfer a Product Instance ID that already belongs to customer placing order | 997 |
| No existing instances, try Move Primary Offer | 997 |
| Aim requires an offering | 997 |
| Unknown aim / order type combination | 997 |
| Aim requires a product offering | 997 |
| Aim requires a Product Instance | 997 |
| Unknown location | 997 |
| No existing instances, try Connect Primary Offer | 997 |
| There are available ONT's or no ONT exists, try Connect Primary | 997 |
| No suitable ONT is available | 997 |
| Supplied ONT ID is not valid | 997 |
| ONT ID and TLC combination is not valid | 997 |
| Request validation failed: Primary Product Instance is not supplied or incompatible with supplied ONT ID | 997 |
| Product characteristic <Characteristic name> does not belong to product offer | 997 |
| Request validation failed: Characteristic [name: X, value: Y] out of range | 997 |
| No existing primary instance for Connect Secondary | 997 |
| Voice is not supported as a separate service when the ONT is in RGW mode, as the ATA ports are configured through the RGW service | 997 |
| Request validation failed: Primary Product Instance is not supplied | 997 |
| Contact details incorrect | 997 |
| Existing open order | 997 |
| Invalid order type | 997 |
| Invalid Product ID | 997 |
| Invalid Provider name given for Transfer | 997 |
| Invalid address or location | 997 |
| Fibre not yet available at this location | 997 |
| Invalid or non existing POI | 997 |
| Resources not available | 997 |
| Your order is not feasible. Please try again later. | 997 |
| Losing Service Provider Name is invalid. | 997 |
| Handover Connection not available | 997 |
| The current ONT mode does not support this | 997 |
| No free suitable ports are available to support this request | 997 |
| No existing primary instance for Connect Secondary | 997 |
| Feasibility has Expired. Please submit another one for this Location. | 996 |
The following table describes the values provided by the demand point type element.
| VALUE | DESCRIPTION |
|---|---|
| MDU | Multiple Dwelling Unit. |
| Unknown | Not able to determined 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 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 consent required element.
| VALUE | DESCRIPTION |
|---|---|
| Y | Location is an MDU or SDU on a Right of Way that does not already have consent. |
| N | Location either does not require consent, or already has consent. |
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 additional build. |
The following table describes the values provided by the AVAILABLE_RFS_DATES element.
Note: we intend to change this functionality, it is documented here for completeness only in it's current form. We will stop providing the list of dates and only return the AVAILABLE_RFS_DATES element.
Use Query Appointment Availability to retrieve a list of RFS dates and times.
| VALUE | DESCRIPTION |
|---|---|
| AVAILABLE_CONNECT_RFS_DATE_TIME | Available RFS date and time for a connection. |
| AVAILABLE_DISCONNECT_RFS_DATE_TIME | Available RFS date and time for a disconnection. |
Date and time values use the xsd:dateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00].
TheSiteVisit ids will be listed against theirrelativeOrderItem(s) using the structure OrderItem -SiteVisitidandagainunderOrderwiththedetailsofthesitevisiti.e.Order-SiteVisit-id-type,bookable,etc.
The following table describes the SiteVisit elements.
| NAME | CARDINALITY I | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | O | SiteVisit identifier. Unique id used forthe site visit required by the feasibility request. It is used in subsequent Appointmentscenarios. | |
| bookable | O | Indicates if the site visit is bookable. | |
| type | O | Purpose of the site visit. |
The bookable indicator setting is determined by the order feasibility result, the following table describes the values provided by the SiteVisit - bookable element.
| VALUE | DESCRIPTION |
|---|---|
| true |
Site visit appointment can be booked. If this value is returned indicated prior to CreateOrder, it indicates that the appointment must be in a reserved condition at the time we receive the CreateOrder request. |
| false |
Site visit appointment cannot be booked at this time. If this value is returned prior to CreateOrder, it indicates that an appointment cannot be reserved before CreateOrder is submitted. We will use the Notification touchpoint after the order submission to request that you book appointments when required. |
The following table describes the values provided by the type element.
| VALUE | DESCRIPTION |
|---|---|
| Scope | Site visit for scoping. |
| Install | Site visit for Installation. |
| Install/CSE | Site visit for Installation and Customer Service Experience. |
| CSE | Site visit for Customer Service Experience. |
| CONNECT_RFS_DATE_TIME | Service connection dates. |
| DISCONNECT_RFS_DATE_TIME | Service disconnection dates. |
QueryOrderFeasibilityRequest
The Order - type and OrderItem - Action fields are mandatory for requesting this service.
Thefollowingtableshowsthepossibleorderscenarios,thevaluesofOrder-typeandOrderItem-action fields, and the associated mandatory input criteria / fields.
| SCENARIO | ORDER-TYPEVALUE | ORDERITEM-ACTION VALUE | INPUT CRITERIA | NOTES |
|---|---|---|---|---|
| Connect | Connect Primary | new |
|
Required for each new product offering. |
| Connect Additional ONT | new |
|
Required for each new product offering. | |
| Connect Secondary | new |
|
Required for each new product offering. | |
| Connect and Replace | new |
|
Required for each new product offering. | |
| Move | Move Primary | new |
|
Required for each new product offering. |
| relinquish |
|
|||
| Move Additional ONT | new |
|
Required for each new product offering. | |
| relinquish |
|
|||
| Move and Replace | new |
|
Existing provider's productId, must match an active product id in our product inventory for this location. | |
| relinquish |
|
|||
| Modify | Change Offer | new |
|
|
| relinquish |
|
|||
| Modify Attribute | modify |
|
Used for modifying an existing product instance. | |
| Modify Attribute | modify |
|
Used for ordering CSE by itself. | |
| new |
|
|||
| Disconnect | Disconnect Primary | relinquish |
|
|
| Disconnect Secondary | relinquish |
|
||
| Transfer | Transfer Primary | new |
|
Existing Provider ProductId, must match an active product id in our product inventory for this location. ExistingProviderName must match a value in the Chorus Customer managed list. |
| Transfer Secondary | new |
|
Existing Provider ProductId, must match an active product id in our product inventory for this location. ExistingProviderName must match a value in the Chorus Customer managed list. |
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Query order feasibility for a location. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes. |
| Description | Initiates a transaction to query order feasibility. |
QueryOrderFeasibilityResponse
If valid input was provided, the response will contain the results of an order feasibility request. It will include the relevant fields from the following list:
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Response to your query of order feasibility for a location. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes. |
| Description | Query order feasibility is processed or has an exception. |
ThisB2B service allows you to request changes to selected details in your order, or respond to a question from us.
Related Business Process
Related Product
This service is available for fibre products.
The data elements and attributes that may be used by this service are described below
AmendOrderType identifies the type of amendment request and defines the list of elements that can be included.
The following table describes the AmendOrderType element.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| INTERACTION | Conditional | I/O | Send us a message, e.g. withdraw an order escalation. |
| ESCALATE | Conditional | I/O | Request a higher priority for processing of an order. |
| CHARACTERISTIC | Conditional | I/O | Request a change to product characteristics |
| APPOINTMENT | Conditional | I/O | Request a change to appointment or RFS date details. |
| ANSWER | Conditional | I/O | Answer a question from us or confirm that you have completed all the tasks we requested. |
| ORDER_DETAILS | Conditional | I/O | Request a change to order information, e.g. notification email address or equipment location. |
| CONTACT_DETAILS | Conditional | I/O | Request a change to the site contact details. |
The order elements contain Order header information. The following table describes the Order elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Mandatory | I/O | Order identifier provided in the CreateOrderResponse. |
| customerReferenceId | Optional | I/O | Your order reference. |
| BillingInformation | O | Order billing details. | |
| type | O | Type of order. | |
| retainCopper | Optional | I/O | Flag to specify if copper should be retained. |
| CBSDocumentReference | Optional | I/O | Document reference provided the Chorus Solutions team. |
| EscalateOrder | Conditional | I/O | Provide details of the escalation reason. |
| interactionText | Conditional | I/O | Send questions or provide information to us. |
| OrderEmailNotification | Optional | I/O | Email details for order notifications. |
| OrderItem | Conditional | I/O | Details of the order items. |
The following table describes the BillingInformation element.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| billingAccount | O | Your billing account value. This value cannot be changed once the order has been submitted. | |
| billingEffectiveDate | O | Date of billing for recurring charges. | |
| cancellationFBN | O | On cancelling an order, if no service is given, the Fictitious Billing Number (FBN) is used to replace the Product ID value. | |
| Charge | O | Charges for the order. |
The following table describes the values provided by the Charge element.
| VALUE | DESCRIPTION |
|---|---|
| category | Category of the charge. |
| description |
Description of the charge, e.g. Business 1, Standard CSE. For quotes the description will contain the quote number, e.g. Quote #: 134. |
| productId |
Product ID for a product, e.g. ASID if it exists, or FBN if it exists for the order. This will not be populated for quotes or variable charges. |
| chargeType | Type of charge for the category, e.g. Recurring, One Time. |
| billingCode | |
| unitCost |
Unit cost in dollars ($)forthe category selected. This can be based on hours, quantity etc. Data type = decimal |
| quantity |
Quantity of category selected based on unit cost. Data type =decimal |
| value |
Total value in dollars ($) of the category selected. Data type =decimal |
-- Order - BillingInformation - Charge - ChargeType
The following table describes the values provided by the ChargeType element.
| VALUE | DESCRIPTION |
|---|---|
| Recurring | |
| One Time |
-- Order - type
The following table describes the values provided by the type element.
| VALUE | DESCRIPTION |
|---|---|
| Connect Primary | New connection for a primary product offer, where there is no existing primary product offer at the location. |
| Connect Additional ONT | New connection for a primary product offer, where there is an existing or pending primary product offer at the location. |
| Connect Secondary | New connection for a secondary product offer, where there is an existing primary product offer at the location. |
| Connect and Replace |
New Connection for a primary product offer, where there is an existing primary product offer at this location, which must be disconnected, and replaced by your incoming order. This order type is used when your end-customer is moving in to a property and assuming ownership. |
| Disconnect Primary | Disconnect of a primary product offer, where there is an active product instance. |
| Disconnect Secondary | Disconnect of a secondary product offer, where there is an active product instance. |
| Change Offer | Change of an existing product offer for an existing product instance – for the same RSP, end customer and location. |
| Modify Attribute | Modification of product attributes of an existing product instance. |
| Modify Attribute | Order a CSE for an existing product instance. |
| Move Primary |
Move your existing offer to a property where there is no existing primary product offer at the location. Note: If consent is required at the new address you will need to complete Disconnect and Connect orders instead of a Move. |
| Move Additional ONT | Add an additional ONT as part of the move. |
| Move and Replace |
New Connection for a primary product offer and disconnection of an existing customer product offer at a different location. Where there is an existing primary product offer at this location, which must be disconnected, and replaced by your incoming order. This order type is used when your end-customer is moving in to a property and assuming ownership. |
| Transfer Primary | Transfer of an existing primary product offerfrom another RSP to the Gaining (requesting) Service provider – for the same end customer and location. |
| Transfer Secondary | Transfer of an existing secondary product offerfrom another RSPto the Gaining (requesting) Service provider – for the same end customer and location. |
-- Order - retainCopper
The following table describes the values provided by the retainCopper element.
| VALUE | DESCRIPTION |
|---|---|
| true | Copper is to be retained, e.g. alarm monitoring or voice over copper. |
| false | Copper is not to be retained |
The following table describes the OrderRole element.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| name | Optional | I/O | PartyRole description. |
| Party | Optional | I/O | Party fulfilling the role. |
-- Order - OrderRole - name
The following table describes the values provided by the name element.
| VALUE | DESCRIPTION |
|---|---|
| End Customer | The role name for the end customer who is requesting service from you. |
-- Order - OrderRole - Party
The following table describes the values provided by the Party element.
| VALUE | DESCRIPTION |
|---|---|
| name | Name of the individual or organisation. |
The following table describes the EscalateOrder element.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| escalated | Mandatory | I/O | Boolean flag indicating if the order has been escalated. |
| escalationReason | Mandatory | I/O | Reason for the escalation. |
| escalationComment | Mandatory | I/O | Explanation of the escalation reason. |
-- Order - EscalateOrder - escalationReason
The following table describes the values provided by the escalationReason element.
| VALUE | DESCRIPTION |
|---|---|
| Medical Emergency | A situation exists whereby the end customer may experience a life or death situation if service is not provided. |
| Civil Defence or Essential Services | The Chorus technician has not arrived at the site to complete the scheduled job, andtheReadyForServicedateandtimehavepassed,andtheChorustechnician has not contacted the end customer. |
| Missed Commitment | The service is not working as expected, or is not working at all, due to an error made by a Chorus representative or a failure within a Chorus system, impacting the overall customer service experience. |
| Provisioning Error |
An emergency event has occurred resulting in the critical need to enable a new service or restore a disabled service, for use by emergency services, Civil Defence, or applicable government agencies. Emergency services include, but may not be limited to: Fire Service; Police; Ambulance Service; Medical facilities (e.g. hospitals, medical centres, welfare centres). |
The following table describes the OrderEmailNotification element.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| Conditional | I/O | Email details for order notifications. | |
| requestNotify | Optional | I/O | Flag to specify if you would like to receive notifications by email. |
-- Order - OrderEmailNotification - email
The following table describes the values provided by the emailAddress element.
| VALUE | DESCRIPTION |
|---|---|
| emailAddress | Email address to receive order notifications. |
-- Order - OrderEmailNotification - requestNotify
The following table describes the values provided by the requestNotify element.
| VALUE | DESCRIPTION |
|---|---|
| true | You want to received email notifications. |
| false | You do not want to received email notifications. |
The OrderItem elements contain details of the Order items. The following table describes the OrderItem elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Conditional | I/O | Order identifier provided in the CreateOrderResponse. |
| action | Conditional | I/O | Type of action to be performed. |
| Timing | Conditional | I/O | Date and time for service connection or disconnection. |
| ProductOffering | Conditional | I/O | Chorus catalogue product offering details |
| SiteVisit | Conditional | I/O | Appointment details for site visits. |
| Question | Conditional | I/O | Respond to a question from us. |
| Place | Conditional | I/O | Provide site access details. |
-- Order - OrderItem - action
The following table describes the values provided by the action element.
| VALUE | DESCRIPTION |
|---|---|
| new |
Creates or connects a new product for the customer. Note: this includes moves and transfers. |
| modify | Modify or change the characteristics of an existing product. |
| relinquish | Relinquish or disconnect an existing product. |
The following table describes the ProductOffering element.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Conditional | I/O | Chorus product specification catalogue product offering identifier. |
| name | Conditional | I/O | Chorus product name from the catalogue. |
| Product id | Conditional | I/O | Chorus product identifier from the catalogue. |
| ProductCharacteristic | Conditional | I/O | Chorus product specifications from the catalogue. |
The following table describes the Product elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Conditional | I/O | Product identifier. |
-- Order - OrderItem - ProductOffering - Product - ProductCharacteristic
The following table describes the values provided by the ProductCharacteristic element.
| NAME | DESCRIPTION |
|---|---|
| name | Chorus catalogue product characteristic name (Sheet:Chr Lists; Title: Value). |
| value | Chorus catalogue value or inventory identifier. |
The following table describes the Timing elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| name | Mandatory | I/O | Description of the dateTime value. |
| dateTime | Mandatory | I/O | Date and time value. |
Date and time values use the xsd:dateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00].
-- Order - OrderItem - Timing - name
RFS dates and times are sourced from BIC004: Query Appointment Availability.
The following table describes the values provided by the name element.
| VALUE | DESCRIPTION |
|---|---|
| CONNECT_RFS_DATE_TIME | Service connection dates |
| DISCONNECT_RFS_DATE_TIME | Service disconnection dates |
| ORDER_DATE | Date and time of the order feasibility request. |
The following table describes the SiteVisit elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Mandatory | I/O | Site Visit identifier. |
| bookable | O | Indicates if the site visit is bookable. | |
| type | O | Purpose of the site visit. | |
| acceptCharges | Mandatory | I/O | Flag to accept any costs relating to rescheduling theappointment. |
| AppointmentSlot | Mandatory | I/O | Date and time of the site visit. |
-- Order - OrderItem - SiteVisit - bookable
The following table describes the values provided by the bookable element.
| VALUE | DESCRIPTION |
|---|---|
| true | Site visit appointment can be booked |
| false |
Site visit appointment cannot be booked at this time. We will use the Notification touchpoint to request that you book an appointment once the order reaches to correctstate. |
-- Order - OrderItem - SiteVisit - type
The following table describes the values provided by the type element.
| VALUE | DESCRIPTION |
|---|---|
| Scope | Site visit for scoping. |
| Install | Site visit for Installation |
| Install/CSE | Site visit for Installation and Customer Service Experience. |
| CSE | Site visit for Customer Service Experience. |
-- Order - OrderItem - SiteVisit - acceptCharges
The following table describes the values provided by the acceptCharges element.
| VALUE | DESCRIPTION |
|---|---|
| TRUE | You accept the costs of rescheduling the site visit. |
| FALSE |
You do not accept the charges of rescheduling the site visit. Note: this is the default value for this field. |
The following table describes the AppointmentSlot element.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| dateTime | Mandatory | I/O |
Anarrayofappointment startandenddatesand times. The start dates and times must be provided exactly as they were returned by Query Appointment Availability |
-- Order - OrderItem - SiteVisit - AppointmentSlot - dateTime
The following table describes the values provided by the dateTime element.
| VALUE | DESCRIPTION |
|---|---|
| startDateTime | Start date and time. |
| endDateTime | End date and time. |
The following table describes the Question element.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Mandatory | I/O | Question identifier. |
| questionValue | O | Question text. | |
| reference | O | XPATH reference for the questionValue. | |
| answerValue | Mandatory | I/O | Answer to the question. |
-- Order - OrderItem - Question - questionValue
The following table describes the values provided by the questionValue element.
| NAME | VALUE |
|---|---|
| questionValue | A quote has been added to this order - Please confirm if you APPROVE or REJECT the supplied quote. |
| reference | /AmendOrderNotification/Order/OrderItem/Quote/id/text() |
| questionValue | A request has been made to cancel this order - Please confirm if you ACCEPT or REJECT this request. |
| reference | /AmendOrderNotification/Order/id/text() |
| questionValue | PleasecheckwithyourendcustomerandeitherACCEPTorREJECTthisrequest (Note: We will not proceed without confirmation). |
| reference | /CreateOrderNotification/Order/id[text() |
| questionValue | Please confirm if you ACCEPT or REJECT this request. |
| reference | /CreateOrderNotification/Order/id[text() |
| questionValue | Please confirm if you ACKNOWLEDGE or REJECT this request. |
| reference | /CreateOrderNotification/Order/id[text() |
| questionValue | Please confirm if you ACKNOWLEDGE this request. |
-- Order - OrderItem - Question - answerValue
The following table describes the values provided by the answerValue element.
| VALUE | DESCRIPTION |
|---|---|
| APPROVE | |
| REJECT | |
| ACCEPT | |
| ACKNOWLEDGE |
ThePlace elements provide the location and equipment access information.The following table describes the Place element.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | O | Location identifier. | |
| Access | Optional | I/O |
Free text field to enter site access information. Note: this field is restricted to 2000 characters. |
| EquipmentLocation | Optional | I/O |
Free text field to guidance on the location for the equipment installation. Note: this field is restricted to 2000 characters. |
| PlaceRole | Conditional | I/O | Order contact information. |
-- Order - OrderItem - Place - Access
The following table describes the values provided by the Access element.
| VALUE | DESCRIPTION |
|---|---|
| description | Provide any specific site information for the technician, e.g. dog on site, rear building, check in at reception, specific sign in process at data centres, health and safety procedures and certificates required on site. |
-- Order - OrderItem - Place - EquipmentLocation
The following table describes the values provided by the EquipmentLocation element.
| VALUE | DESCRIPTION |
|---|---|
| description | Guidance for the technician on where the equipment is to be installed on site, e.g. install ONT to the wall in the garage. |
The PlaceRole elements provide contact details for the location. The following table describes the PlaceRole element.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| name | Mandatory | I/O | Used to add the contact type/role of the order contacts. |
| ContactMedium | Mandatory | I/O | Medium for contacting the party fulfilling the PlaceRole. |
| Party | Mandatory | I/O | Party fulfilling the role. |
-- Order - OrderItem - Place - PlaceRole - Party
The following table describes the values provided by the Party element.
| VALUE | DESCRIPTION |
|---|---|
| name | Name of the individual or organisation. |
> Order - OrderItem - Place - PlaceRole - name Elements
The Place Role elements are used to add role types for the order contacts. The following table describes the name element.
Note: Market Segment codes and Consent requirement values are provided by Query Product Offer.
| VALUE | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| Site Contact | Mandatory | I/O | Contact type for the primary contact on site and familiar with the order. This person must be aware that a site visit has been booked. |
| Additional Contact | Optional | I/O | Contact type for used if the order requires a contact person not covered by the other contact types. |
| Order Contact | Mandatory for orders for Business and Education market segments. | I/O | Contact type for the administrative person for the order. |
| IT Contact | Mandatory for orders for Business and Education market segments. | I/O | Contact type for the IT contact person for the order. |
| Legal Owner | Optional | I/O | Contact type for the Legal Owner of the location. |
| Body Corporate | Optional | I/O | Contact type for the Body Corporate contact person for the order. |
| Property Manager | Optional | I/O | Contact type for the Property Manager contact person for the order. |
The Contact Medium element is used to add contact details for each of contact types you defined using the PlaceRole - name element.
The following table provides details of the ContactMedium element.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| preference | Mandatory | I/O | An integer greater than zero used to specify a preference against the telephone numbers. |
| Telephone | Mandatory | I/O | A telephone number for contacting the party fulfilling this PlaceRole. |
| Mandatory | I/O | An email address for contacting the party fulfilling this PlaceRole. | |
| Name | Mandatory | I/O | The name of an individual or organisation. |
-- Order - OrderItem - Place - PlaceRole - ContactMedium - preference
The following table describes the values provided by the preference element.
| VALUE | DESCRIPTION |
|---|---|
| 1 |
The main phone number to use when calling the contact person. Use this value if you are only providing one phone number. |
| 2 | Alternative phone number for the contact person. |
-- Service Name
-- Service Inputs
The order state determines the type of amendment that can be made to the order details. Each request must include the following mandatory fields:
The following table showsAmendOrderTypes the state the order can be in and the additional mandatory input criteria /fields.
| AMENDORDERTYPE | INPUT CRITERIA | NOTES |
|---|---|---|
| Escalate |
|
|
| Interaction |
|
|
| Characteristic |
|
Provide the paired ProductCharacteristic name and the new value to be applied. |
| Appointment - RFS date change |
|
|
| Appointment - Site Visit change |
|
|
| Answer |
|
|
| Order Details |
|
|
| Contact Details |
|
The omission of a PlaceRole or any of its child elements implies a removal/deletion of those values. All changes using this AmendOrderType should include all of the PlaceRole elements and the intended target values for the Order being acted on. |
-- Message Handling Specifications
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Request to amend an order that has passed the state and substate of Acknowledged/Received. |
| Outputs | Synchronous Acknowledgement. |
| Nonrepudiation | Yes. |
| Description | Initiates a transaction to amend an order. |
-- Service Name
AmendOrderResponse
-- Service Outputs
If valid input was provided, your order will be amended and the response will contain the order and the amendment details.
-- Message Handling Specifications
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Response to your amend order request. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes. |
| Description | Amend order is processed or has an exception. |
This B2Bservice allows you to request the cancellation of an inflight order and any associated site visit appointments.
Related Business Process
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 order elements contain Order header information. The following table describes the Order elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Mandatory | I/O | Order identifier. |
| Reason | Mandatory | I/O | Describes why you are requesting the order cancellation. |
> Order - Reason Elements
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| code | Mandatory | I/O | Order cancellation code. |
| description | Mandatory | I/O | Description of the order cancellation reason. |
-- Order - Reason - description
The following table describes the new values provided by the code and description elements released on the 14th February 2018.
| CODE | DESCRIPTION |
|---|---|
| CUSTOMER_CANCEL_16 | Order Acceptance - Duplicate order removed |
| CUSTOMER_CANCEL_18 | Order Acceptance - Incorrect Address – New order submitted |
| CUSTOMER_CANCEL_17 | OrderAcceptance-IncorrectAddress–Nonewordersubmitted |
| CUSTOMER_CANCEL_14 | Order Acceptance - Incorrect pre-qual information |
| CUSTOMER_CANCEL_15 | OrderAcceptance - Missing orderinformation |
| CUSTOMER_CANCEL_13 | OrderAcceptance -Primary fibre service already on site (an primary requested) |
| CUSTOMER_CANCEL_26 | Customer Cancelled - AccessDenied |
| CUSTOMER_CANCEL_29 | Customer Cancelled - Customer did not accept contribution cost |
| CUSTOMER_CANCEL_19 | Customer Cancelled - Excessive delay for RFS |
| CUSTOMER_CANCEL_21 | Customer Cancelled - Fibre not requested |
| CUSTOMER_CANCEL_25 | Customer Cancelled - Landlord declined permission |
| CUSTOMER_CANCEL_22 | Customer Cancelled - Now moving address |
| CUSTOMER_CANCEL_20 | Customer Cancelled - Premise not ready for fibre installation |
| CUSTOMER_CANCEL_28 | CustomerCancelled -Unhappy with external scoping options (installation) |
| CUSTOMER_CANCEL_27 | Customer Cancelled - Unhappy with internal scoping options (installation) |
| CUSTOMER_CANCEL_32 | RSP Cancelled - Feasibility/Quote rejected by customer |
| CUSTOMER_CANCEL_30 | RSP Cancelled - Incorrect Details |
| CUSTOMER_CANCEL_31 | RSP Cancelled - Submitted in Error |
| CUSTOMER_CANCEL_33 | Customer Cancelled - Competitive offer taken up by customer (same RSP) |
| CUSTOMER_CANCEL_34 | Customer Cancelled - Health and Safety |
| CHORUS_CANCEL_55 | Customer Cancelled - Competitive offer taken up by customer (same RSP) |
| CHORUS_CANCEL_56 | Customer Cancelled - Health and Safety |
-- Service Name
CancelOrderRequest
-- Service Inputs
The following fields are mandatory for requesting this service:
-- Message Handling Specifications
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | The order must be in a state that allows cancellation. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes. |
| Description | Initiates a transaction to cancel an order. |
CancelOrderResponse
-- Service Outputs
If valid input was provided and the order state allows for cancellation, your order will be changed to the state and substate of In Progress/Intent to Cancel.
We will review your request and send our response using an AmendOrderNotification.
-- Message Handling Specifications
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Response to your cancel order request. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes |
This B2B service allows you to retrieve a snapshot of an order belonging to you.
Related Business Process
Related Product
This service is available for fibre products.
The order elements contain Order header information. The following table describes the Order elements
The order elements contain Order header information. The following table describes the Order elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | Conditional | I/O | Order identifier. |
| CustomerReferenceId | Conditional | I/O | Youruniqueorderreferencenumber for matching this order to your records. |
The following table provides details of the Notification elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| id | O | Notification identifier. | |
| type | O | Type of information contained in the notification. | |
| dateTime | O | Date and time values using the xsd:dateTime format: YYYY-MMDDTHH:MM:SS+[UTC offset, e.g. 12:00]. | |
| NotificationItem | O | Details of the notification. | |
| notificationMessage | O | Base 64 encoded zip containing the message body of the original notification, i.e. all content including the Touchpoint tags. |
-- Notification - type
The following table describes the values provided by the type element in InformOrderNotification messages.
| VALUE | DESCRIPTION |
|---|---|
| STATUS | Advise you of a status update that has been given to your customer. |
| STATUS_WITH_NOTE |
Free-textupdatesfromtheChorusProvisioningteam,corresponding to: progress in obtaining consents management of an escalation miscellaneous information. |
| MANUAL_INTERACTION |
Free-textupdatesfromtheChorusProvisioningteam,corresponding to: progress in obtaining consents management of an escalation miscellaneous information. |
| REJECT_CANCEL | Confirms that you have rejected our request to cancel your order. |
The following table describes the values provided by the type element inAmendOrderNotification messages.
| VALUE | DESCRIPTION |
|---|---|
| ACKNOWLEDGED_ACCEPTED | Your order has been validated and accepted. |
| RFS_CONFIRMED | Yourorderready for servicedatehasbeen confirmed. |
| CONSENT_REQUIRED | Consent is required for your order. |
| CONSENT_REQUESTED | Consent has been requested for your order. |
| CONSENT_GAINED | Consent has been gained for your order. |
| CONSENT_DECLINED | Consent has been declined for your order. |
| GENERATE_QUOTATION | A quote is being generated for your order. |
| INTENT_TO_CANCEL | A request has been made to cancel your order. |
| NETWORK_DESIGN | The network design is in progress. |
| NETWORK_BUILD | The network build is in progress. |
| SCOPING_SCHEDULED | Scoping for this order has been scheduled. |
| SCHEDULED | The order has been scheduled. |
| INVESTIGATION_REQUIRED | Your order requires investigation. |
| QUOTE_ACCEPTANCE | We are waiting on your acceptance of our quote. |
| HELD_SCHEDULE_SCOPING | You need to schedule scoping for this order. |
| HELD_SCHEDULE_INSTALL | You need to schedule the install for this order. |
| HELD_PROVIDER_TO_ADVISE | You need to provide information to Chorus before the order can progress. |
| HELD_PENDING_DISCONNECT_ACCEPTANCE | We are waiting for a response from the losing customer to our CreateOrderNotification disconnect product before we complete your replace order. |
| SERVICE_GIVEN | The installation work is now complete. The end user should now be able to use the service at their location. |
| COMPLETED_BILLING | Network activities are complete and Billing activities are under action. |
| CLOSED_CANCELLED | Your order has been cancelled and closed. |
| CLOSED_COMPLETED | Your order has been completed and closed. |
| SVM_EVENT | Your order site visit has been updated. |
| ESCALATION_ACCEPTED | We have accepted your order escalation. |
| ESCALATION_COMPLETED | Your order escalation has been completed. |
| ESCALATION_DECLINED | We have declined your order escalation. |
| AMEND_ORDER_COMPLETED | We have made an amendment to your order that is not covered by a response or another notification. E.g. Where you have made an amendment via the Chorus Portal. |
-- Notification - NotificationItem
The following table provides details of the NotificationItem elements.
| VALUE | DESCRIPTION |
|---|---|
| id |
Notification item identifier. A unique id will be returned with each notification item. |
| description | Description of the notification item. |
| reference | XPath reference of the notification item. |
The following table provides details of the OrderEventHistory elements.
| NAME | CARDINALITY | INPUT/OUTPUT | DESCRIPTION |
|---|---|---|---|
| documentName | O | Notification identifier. | |
| fileAttachment | O |
Base 64 encoded zip containing the history of the order as tracked in the Chorus OrderManager. Information is provided using XML tags. |
-- OrderEventHistory - documentName
The following table describes the values provided by the documentName element.
| VALUE | DESCRIPTION |
|---|---|
| ORDER_EVENT_HISTORY | File attachment name. |
-- OrderEventHistory - XML tags
The following table provides the XML tags and descriptions.
Note: some naming conventions and visibility may differ from that contained within the regularB2B messaging.
| XML TAG | DESCRIPTION |
|---|---|
| ns2:customerOrderEventID | Event ID |
| ns2:eventActivity | Event Activity |
| ns2:eventType | Portal Order History: Type |
| ns2:eventAction | Portal Order History: Action |
| ns2:eventDate | Portal Order History: Event Date |
| ns2:sourceApplication | Portal Order History: Source |
| ns2:activityCustomerName | Portal Order History: |
| ns2:description | Portal Order History: Expanded description of the event |
-- Service Name
QueryOrderRequest
-- Service Inputs
One of the following fields must be used requesting this service:
Note: we recommend using the Order id to request this service.
-- Message Handling Specifications
| NAME | DESCRIPTION |
|---|---|
| MEP | Synchronous call with Acknowledgement. |
| Inputs | Query for order and notification details. |
| Outputs | Synchronous Acknowledgement. |
| Non-repudiation | Yes. |
| Description | Initiates a transaction to query an order. |
QueryOrderResponse
-- Service Outputs
If valid input was provided the response will contain the current order details and notification history.
Details of the elements and values that may be provided in the response are listed in following web services:
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. |
Name
Supplier Notifies of Order Cost Variation
Description
This process provides us with the ability to notify you of a variation in the cost of your order, and for you to respond to the notification.
We suggest that you implement controls so that only an authorised user can accept an order quote.
Related B2B Services
Preceded by
Pre-conditions
We have identified a variation in the cost of your order. The order state will be either In Progress or Held.
Post-Conditions
You respond to our quote within the required timeframe. If you accept, your order will continue through the fulfilment process, otherwise you may reject the quote and change or cancel your order.
| STEP | DESCRIPTION | ROLE |
|---|---|---|
| 1 | Identify a variation to the original cost of the order. | Chorus |
| 2 | Update the state and substate of the order, send a notification to advise the customer that a quote is being generated. | Chorus |
| 3 | Update the state and substate of the order, send a notification to advise the customer of the quote details. | Chorus |
| 4 | Receive the notification and respond using an Amend Order Request. | Chorus |
The following use cases support this business process.
Click on the links to view the XML samples.
> Advise of Cost Variation
In this example, we need to send a technician to gather more information about the location. We advise you by sending:
You respond using the Amend Order Request type:
We advise you that the order requires scheduling by sending:
| REQUEST | NOTIFICATION / RESPONSE |
|---|---|
|
AmendOrderNotification: INVESTIGATION_REQUIRED
|
|
|
AmendOrderNotification: SVM_EVENT
|
|
|
AmendOrderNotification: GENERATE_QUOTATION
|
|
|
AmendOrderNotification: QUOTE_ACCEPTANCE
|
|
| Customer Amends Order: ANSWER | |
|
AmendOrderRequest: ANSWER
|
AmendOrderResponse: ANSWER
|
|
AmendOrderNotification: HELD_SCHEDULE_SCOPING
|
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 |
|---|---|
| US39 | As a Service Provider I want standardised service order notifications from the LFCs so I can have consistent order management procedures across LFCs. |
| SC39.01 | The LFCs agree a common set of service order notifications which are captured in the business interaction framework. |
| SC39.09 | The Order Reference Number is included on all order notifications. |
| SC39.10 | The Service Provider Order Reference number is included on all order notifications. |
| SC39.11 | The date and time is included on all order notifications. |
| SC39.12 | LFC uses a formatted template for the notifications. |
| US49 | As a Service Provider I want to know if amending or cancelling an order is going to incur a cost so I can advise my Customer and charge them accordingly for any Customer initiated change. |
| SC49.02 | Service Provider is told when amending the order of the charge incurred. |
| US63 | As the LFC I want to be able to raise a service request on behalf of the Service Provider for “while you were here” work completed so that the Service Provider is kept informed. |
| SC63.01 | The LFC has an approved process for raising a service request on behalf of the Service Provider. |
Name
Supplier Notifies Losing Customer of Transfer (Relinquish)
Description
This process provides us with the ability to notify you that your customer has transferred to another service provider.
Related B2B Services
Preceded by
Succeeded by
Pre-conditions
Your end customer has chosen to transfer to another service provider, who has created a transfer order.
The transfer order has been completed.
Post-Conditions
You receive our notification to confirm that the end customer has transferred.
|
STEP |
DESCRIPTION | ROLE |
|---|---|---|
| 1 | Send a create order notification to advise losing service provider that billing will cease. | Chorus |
| 2 | Receive the notification and action asappropriate using theProduct ID or TLC to correlate with yourrecords | Customer |
The following table describes the use cases that support this business process.
Click on the scenario link to view the XML sample.
| SCENARIO | DESCRIPTION | NOTIFICATION |
|---|---|---|
| Create Order Notification: CEASE_BILLING |
Create Order Notification: CEASE_BILLING message is sent to advise you that your end customer has been transferred to another RSP. The notification will not contain an Order ID. For this reason you will have to use the product ID or TLC to correlate the notification. |
|
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 |
|---|---|
| US411 | As a Service Provider I want to know whenever a customer is transferring away from me so I do not impede or stop the transfer process or disconnect before time AND so that the end customer doesn’t inadvertently lose services as a result of the transfer. |
| SC411.01 | Losing Service Provider is notified by the LFC of the Product Instance ID(s) that is/are to be relinquished as part of the transfer request. |
| SC411.02 | The Losing Service Provider will not use the notification as a trigger to contact the LFC directly in an attempt to stop the Transfer request. |
| US412 | As a Service Provider I want to be able to ensure that any solution for transfer notification can be automated so that I can make the process more efficient and effective. |
| US417 | As a Losing Service Provider I want to be able to approve or reject a transfer so that I can prevent erroneous Transfers. |
| SC417.01 | In the pre-transfer notification, the Gaining Service Provider provides a Unique Identifierthat the Losing Service Provider can relate to a service that they provide to their Customer. |
| SC417.02 | In the pre-transfer notification, the Gaining Service Provider provides the End CustomerAccount Numberthat the LosingServiceProvider can use to identify their End Customer. |
| US419 | As a Gaining Service Provider I want a deadline to apply to Transfer notifications so that a Losing Service Provider cannot hold up a Transfer order by not responding. |
| SC419.01 | The notification to the Losing Service Provider includes the deadline date and time before which they may warn the Gaining Service Provider that the Transfer details are incorrect. |
| US422 | As a LosingServiceProviderI want the Transfer notification to include agreed detail of information to enable me to determine if the Transfer request is valid so that erroneous Transfers areminimised. |
| SC422.01 | The Transfer notification to the Losing Service Provider specifies the Product Instance ID of each Product Instance to be relinquished as part of the Transfer. |
| SC422.02 | The Transfer notification to the Losing Service Provider specifies the RFS date and time requested by the Gaining Service Provider. |
| SC422.03 | The Transfer notification to the Losing Service Provider includes billing account ID that the Losing Service Provider bills the End Customer for the Product Instance that is to be transferred. |
Name
Customer Requests Order Information
Description
This process provides you with the ability to retrieve a snapshot of an order belonging to you.
Related B2B Services
Preceded by
Succeeded by
Pre-conditions
You have created an order using BIC101: Customer Creates Order. The order can be in any state.
Post-Conditions
You receive our response containing the order details.
| STEP | DESCRIPTION | ROLE |
|---|---|---|
| 1,2 | Submit a query order request. | Customer |
| 3 |
Receive and validate the request. If the request is invalid refer to alternate flow. |
Chorus |
| 4 | Provide response containing order details and history. | Chorus |
| 5 | Receive the Query Order response and action as appropriate. | Customer |
| STEP | DESCRIPTION | ROLE |
|---|---|---|
| 3.1 | If the query order request information is invalid, return an error response. | Chorus |
| 3.2 | Return an error response explaining why the order information cannot be created. | Chorus |
Refer to the Exception Codes table for error details.
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.
| CODE | DESCRIPTION |
|---|---|
| 000 | Backendprocessingerrorencountered-IfproblempersistspleasecontactChorusadmin |
| 019 | Customer Order ID or Customer Reference ID not found |
| 026 | Request validation failed: {%s} |
| 033 | Multiple results found for Customer Reference entered |
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 Order |
Query Order Request is executed to retrieve a snapshot of an order. Order details and history is returned. |
|
|
The following table describes the use case exceptions that support this business process.
Click on the scenario link to view the XML sample.
Use Case Exceptions
| SCENARIO | DESCRIPTION | REQUEST | RESPONSE |
|---|---|---|---|
| Customer Requests Order Information -Orderid does not exist |
Query Order Request is executed to retrieve a snapshot of an order. The order id is incorrect. |
|
|
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 |
|---|---|
| US57 | As a Service Provider I want to view and monitor any of my service orders so that I can manage my Customer expectations throughout the service order lifecycle. |
| SC57.04 | Closed service orders will be held in and accessible by the system for 6 months. |
| SC57.05 | Closed service orders will be held in and accessible by the system for a minimum of 12 months. |
| SC57.06 | Service Provider can only view service orders placed by them. |
Response Success Criteria
| ID | DESCRIPTION |
|---|---|
| US35 | As a Service Provider I want to be able to add my own reference ID to a Service Request order so that I can easily match the order with orders in my own systems. |
| SC35.03 | ServiceProviderreferenceisprovidedonallnotificationsregardingtheservicerequest order. |
| US57 | As a Service Provider I want to view and monitor any of my service orders so that I can manage my Customer expectations throughout the service order lifecycle. |
| SC57.04 | Closed service orders will be held in and accessible by the system for 6 months. |
| SC57.05 | Closed service orders will be held in and accessible by the system for a minimum of 12 months. |
| SC57.06 | Service Provider can only view service orders placed by them. |