Feedback

Fibre Ordering

Customer Amends Order

Getting Started Architecture Processes Web services Help & support FAQs
  1. Tools
  2. Fibre Ordering
  3. B2B
  4. Web services
  5. Customer Amends Order
Back

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 Elements

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.

> Order Elements

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.

> Order - BillingInformation Elements

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.

> Order - BillingInformation - Charge Elements

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

> Order - OrderRole Elements

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.

> Order - EscalateOrder Elements

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).

> Order - OrderEmailNotification Elements

The following table describes the OrderEmailNotification element.

NAME CARDINALITY INPUT/OUTPUT DESCRIPTION
email 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.

> Order - OrderItem Elements

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.

> Order - OrderItem - ProductOffering Elements

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.

> Order - OrderItem - ProductOffering - Product Elements

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.

> Order - OrderItem - Timing Elements

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.

> Order - OrderItem - SiteVisit Elements

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.

> Order - OrderItem - SiteVisit - AppointmentSlot Elements

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.

> Order - OrderItem - Question Elements

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  

> Order - OrderItem - Place Elements

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.

> Order - OrderItem - Place - PlaceRole Elements

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.

> Order - OrderItem - Place - PlaceRole - ContactMedium Elements

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.
Email 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.

Amend Order Request Details

-- Service Name

  • AmendOrderRequest

-- 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:

  • AmendOrderType
  • Order id.

The following table showsAmendOrderTypes the state the order can be in and the additional mandatory input criteria /fields.

AMENDORDERTYPE INPUT CRITERIA NOTES
Escalate
  • Escalated (True)
  • Escalation reason
  • Escalation comment
  
Interaction
  • Interaction Text
  
Characteristic
  • OrderItem id
  • OrderItem action
  • Product Offering id
  • Product
  • Characteristic name
  • Product
  • Characteristic value
 Provide the paired ProductCharacteristic name and the new value to be applied.
Appointment - RFS date change
  • OrderItem id
  • OrderItem action
  • Timing name
  • Timing date and time
  
Appointment - Site Visit change
  • Site Visit id
  • Site Visit type
  • Site Visit accept charge (if required)
  • AppointmentSlot start and end times
  
Answer
  • OrderItem id
  • OrderItem action
  • Question id
  • Question value
  • Answer value
  
Order Details
  • OrderItem id
  • Order Role Party name (end customer)
  • CustomerReferenceId
  • Order retain copper
  • Order emailAddress
  • Order email notification requestNotify
  • Access description
  • Equipment Location description
  
Contact Details
  • OrderItem id
  • OrderItem action
  • Order Item Place
  • Place Role name
  • Place Role Party name
  • Contact Medium preference
  • Telephone number
  • Email emailAddress.

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.

Amend Order Result Details

-- 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.

Fibre Ordering

Customer Cancels Order

Getting Started Architecture Processes Web services Help & support FAQs
  1. Tools
  2. Fibre Ordering
  3. B2B
  4. Web services
  5. Customer Cancels Order
Back

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

Order Elements

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

Cancel Order Request Details

-- Service Name

CancelOrderRequest

-- Service Inputs

The following fields are mandatory for requesting this service:

  • Order id
  • Reason

-- 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.

Cancel Order Response Details

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

Fibre Ordering

Query Order

Getting Started Architecture Processes Web services Help & support FAQs
  1. Tools
  2. Fibre Ordering
  3. B2B
  4. Web services
  5. Query Order
Back

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

> 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.

> Notification Elements

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.

> OrderEventHistory Elements

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

Query Order Request Details

-- Service Name

QueryOrderRequest

-- Service Inputs

One of the following fields must be used requesting this service:

  • Order id
  • customerReferenceId

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.

Query Order Response Details

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:

  • Customer Creates Order
  • Supplier Amends Order

Fibre Ordering

Query Product Offer Availability

Getting Started Architecture Processes Web services Help & support FAQs
  1. Tools
  2. Fibre Ordering
  3. B2B
  4. Web services
  5. Query Product Offer Availability
Back

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.

Place Element

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 Supplier Location ID or
  • The Location Code (TLC).

FilterParameter Elements

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
FilterParameter - FAMILY_TYPE

The following table describes the values provided by the family type element

VALUE DESCRIPTION
BITSTREAM Fibre to the premises.
CSE Customer Service Experience
FilterParameter - MARKET_SEGMENT_CODE

The following table describes the values provided by the market segment code element.

VALUE DESCRIPTION
BUSINESS  
RESIDENTIAL  
EDUCATION  
Filter Parameter - OFFER_TYPE

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.

Product Offering Interaction Item Detail Elements

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.

> Product Offering Interaction Item Detail - MDU_Class

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.

> Product Offering Interaction Item Detail - Fibre_Available

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.

> Product Offering Interaction Item Detail - Demand_Point_Type

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

> Product Offering Interaction Item Detail - Right_Of_Way

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

> Product Offering Interaction Item Detail - Zone _Type

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

> Product Offering Interaction Item Detail - Availability_Status

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.

> Product Offering Interaction Item Detail - Point_Of_Interconnect

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  

>Product Offering Interaction Item Detail - Install_Type

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:

  • four days residential
  • six days business.
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.

> Product Offering Interaction Item Detail - Service_Lead_Type

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

> Product Offering Interaction Item Detail - Coverage_Area

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.

> Product Offering Interaction Item Detail - LFC_Area

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  

> Product Offering Interaction Item Detail - Design_Required

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.

> Product Offering Interaction Item Detail - Build_Required

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.

> Product Offering Interaction Item Detail - MDU_Build_Status

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.

> Product Offering Interaction Item Detail - Availability_Status - Availability_Date

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].

Product Offering Elements

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.

Product Offering - Product Characteristics Elements

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.

> Product Offering - Product Characteristics - Family_Type

The following table describes the values provided by the family type element.

VALUE DESCRIPTION
BITSTREAM Fibre to the premises
CSE Customer Service Experience.

> Product Offering - Product Characteristics - Market_Segment_Code

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.

Query Product Offer Request Details

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:

  • Family_Type
  • Market_Segment_Code
  • Offer_Type.

The filters behave as follows:

  • If multiple filters are selected, the query searches using AND behaviour
  • If a filter is not selected a wild card search is implied.

Note: the filter option only restricts the results returned to you, it does not affect the underlying availability of products we offer you.

Message Handling Specifications
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

Query Product Offer Response Details

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:

  • MDU_Class
  • Fibre_Available
  • Demand_Point_Type
  • Right_Of_Way
  • Zone _Type
  • Availability_Status
  • Central_Office
  • Point_Of_Interconnect
  • Install_Type
  • Install_Distance
  • Service_Lead_Type
  • Consent_Required
  • Consent_Status
  • Coverage_Area
  • LFC_Area
  • Design_Required
  • Build_Required
  • MDU_Build_Status
  • Availability_Date
  • ProductOffering
    • id
    • name
    • ProductCharacteristics.
Message Handling Specifications
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.

Fibre Ordering

BIC116: Supplier Notifies of Order Cost Variation

Getting Started Architecture Processes Web services Help & support FAQs
  1. Tools
  2. Fibre Ordering
  3. B2B
  4. Processes
  5. BIC116: Supplier Notifies of Order Cost Variation
Back

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

Flow - Supplier Notifies of Order Cost Variation

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.

Basic Path

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

Use Cases

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:

  • AmendOrderNotification: INVESTIGATION_REQUIRED
  • AmendOrderNotification: SVM_EVENT to show that a change has been made to an appointment
  • AmendOrderNotification: GENERATE_QUOTE to advise you that we are generating a quote for your order
  • AmendOrderNotification: QUOTE_ACCEPTANCE to advise you of the quote details.

You respond using the Amend Order Request type:

  • ANSWER - to APPROVE our quote.

We advise you that the order requires scheduling by sending:

  • AmendOrderNotification: HELD_SCHEDULE_SCOPING.
REQUEST NOTIFICATION / RESPONSE
 

AmendOrderNotification: INVESTIGATION_REQUIRED

  • Order details
  • State & Substatus: In Progress/Investigation Required
 

AmendOrderNotification: SVM_EVENT

  • Order details
  • State & Substatus: In Progress/Investigation Required
 

AmendOrderNotification: GENERATE_QUOTATION

  • Order details
  • State & Substatus: In Progress/Generate Quotation
  • Question id
  • QuestionValue
 

AmendOrderNotification: QUOTE_ACCEPTANCE

  • Order details
  • State & Substatus: Held/Quote Acceptance
  • Question id
  • QuestionValue
Customer Amends Order: ANSWER  

AmendOrderRequest: ANSWER

  • Question id
  • QuestionValue
  • AnswerValue
  • QuestionReference

AmendOrderResponse: ANSWER

  • Order details
  • State & Substatus: Held/Quote Acceptance
 

AmendOrderNotification: HELD_SCHEDULE_SCOPING

  • Order details
  • State & Substatus: Held/Scheduled_Scoping

Success Criteria

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

The document is available from:

Refer to the TCF website for documentation.

ID DESCRIPTION
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.

Fibre Ordering

BIC114: Supplier Notifies Losing Customer of Transfer (Relinquish)

Getting Started Architecture Processes Web services Help & support FAQs
  1. Tools
  2. Fibre Ordering
  3. B2B
  4. Processes
  5. BIC114: Supplier Notifies Losing Customer of Transfer (Relinquish)
Back

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

  • Supplier Amends Order

Preceded by

  • Customer Creates Order

Succeeded by

  • N/A

Flow - Supplier Notifies Losing Customer of Transfer (Relinquish)

Flow - Supplier Notifies Losing Customer of Transfer (Relinquish)

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.

Basic Path

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

 

Use Cases

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

Click on the scenario link to view the XML sample.

SCENARIO DESCRIPTION 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.
  • Existing provider details
  • productid location
  • Notification details

 

Success Criteria

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

The document is available from:

Refer to the TCF website for documentation.

ID DESCRIPTION
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.

 

Fibre Ordering

BIC113: Customer Requests Order Information

Getting Started Architecture Processes Web services Help & support FAQs
  1. Tools
  2. Fibre Ordering
  3. B2B
  4. Processes
  5. BIC113: Customer Requests Order Information
Back

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

Flow - Customer Requests Order Information

bic113

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.

Basic Path

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

Alternate Flow 1

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.

Exception Codes

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

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

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

Use Cases

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

Click on the scenario link to view the XML sample.

SCENARIO DESCRIPTION REQUEST RESPONSE
Customer Queries Order

Query Order Request is executed to retrieve a snapshot of an order.

Order details and history is returned.
  • Order id
  • Order details
  • Notifications

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.
  • Order id
  • Order id
  • Exception message

Success Criteria

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

The document is available from:

Refer to the TCF website for documentation.

Request Success Criteria

ID DESCRIPTION
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.

Fibre Ordering

BIC109: Customer Reschedules Order Appointment

Getting Started Architecture Processes Web services Help & support FAQs
  1. Tools
  2. Fibre Ordering
  3. B2B
  4. Processes
  5. BIC109: Customer Reschedules Order Appointment
Back

Name

Customer Reschedules Order Appointment

Description

This process provides you with the ability to reschedule a site visit appointment or RFS date, against an order.

Related B2B Services

  • Customer Amends Order

Preceded by

  • Customer Creates Order

Succeeded by

  • Supplier Amends Order

Flow - Customer Reschedules Order Appointment

Pre-conditions

You have created an order using BIC101:CustomerCreatesOrderandtheappointmentdates fortheorder are in the future.

You have retrieved a list of site visit appointment times or RFS dates using BIC004: Query Appointment Availability.

Post-Conditions

You receive our response confirming that the appointment has been rescheduled.

Basic Path

STEP DESCRIPTION ROLE
1 Submit request to reschedule an order appointment. Customer
2 Receiveandvalidatetherequest,rescheduletheappointment. If the request is invalid refer to alternate flow. Chorus
3 Provide response containing details of the order and new appointment. Chorus
4 Receive the response and action as required. Customer

 

Alternate Flow 1

STEP DESCRIPTION ROLE
2.1 If the query order request information is invalid, return an error response. Chorus
2.2 Return an error response explaining why the appointment cannot be rescheduled. Chorus

Refer to the Exception Codes table for error details.

Business Rules

  • Wewillnot changeanappointmentthatincursaddtional charges,unless youacceptany charges.
  • We will validate RFS date changes against the lead times for the products in the order.

Exception Codes

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

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

CODE DESCRIPTION
000 Backendprocessingerrorencountered-Ifproblem persistspleasecontactChorusadmin
017 RFS validation failed: {%s}
018 Question Answer Failed: {%s}
019 Customer Order ID or Customer Reference ID not found
020 Appointment reschedule failed as charges may apply - Please resubmit & accept charges.
025 The attribute {%s} in the request does not exist or does not match the corresponding attribute in the Orderrecord.
026 Request validation failed: {%s}
029 The Order State of the specified Customer Order does not support the selected action
030 The Order ID provided belongs to a different customer

 

Use Cases

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

Click on the scenario link to view the XML sample.

> Reschedule Site Visit Appointment

In this example, you have and order that is in the state and substatus: In Progress/Network Design. We advise you that your order is ready to be progressed by sending:

  • AmendOrderNotification: HELD_SCHEDULE_SCOPE to request that you schedule the site visits.

You use:

  • QueryAppointmentAvailability to retrieve a list of available appointments
  • AmendOrderRequest: APPOINTMENT to request an appointment for each appointment type, e.g. Scope, Install, CSE, etc.

Note: you may choose to reschedule the Install appointment first, due to the inter-appointment leadtime validation rules.

REQUEST NOTIFICATION / RESPONSE
 

AmendOrderNotification: HELD_SCHEDULE_SCOPING

  • Order details
  • State & Substatus: Held/Schedule Scoping
Customer Queries Appointment Availability - retrieve SCOPE appointments  
Customer Amends Order: APPOINTMENT  

AmendOrderRequest: APPOINTMENT

  • Site Visit id
  • AcceptCharges
  • AppointmentSlot
  • StartDateTime
  • EndDateTime

AmendOrderResponse: APPOINTMENT

  • Order details
  • Site Visit id
  • AcceptCharges
  • AppointmentSlot
  • StartDateTime
  • EndDateTime
  • State & Substatus: In Progress/Scheduled
Customer Queries Appointment Availability - retrieve INSTALL appointments  

AmendOrderRequest: APPOINTMENT

  • Site Visit id
  • AcceptCharges
  • AppointmentSlot
  • StartDateTime
  • EndDateTime

AmendOrderResponse: APPOINTMENT

  • Order details
  • Site Visit id
  • AcceptCharges
  • AppointmentSlot
  • StartDateTime
  • EndDateTime
  • State & Substatus: In Progress/Scoping Scheduled
 

AmendOrderNotification: SCOPING_SCHEDULED

  • Order details
  • State & Substatus: In Process/Scoping Scheduled
 

AmendOrderNotification: SCHEDULED

  • Order details
  • State & Substatus: In Process/Scheduled
 

AmendOrderNotification: SERVICE_GIVEN

  • Order details
  • State & Substatus: Service Given/Service Given

> Reschedule RFS date

In this example, your customer has requested that you reschedule the RFS date for their order.

You use:

  • QueryAppointmentAvailabilitytoretrievealistofavailableappointments
  • AmendOrderRequest:APPOINTMENTto reschedule theRFSdate.
REQUEST RESPONSE
 

AmendOrderNotification: SCHEDULED

  • Order details
  • State & Substatus: In Progress/Scheduled
Customer Queries Appointment Availability - retrieve RFS appointments  
Customer Amends Order: APPOINTMENT  

AmendOrderRequest: APPOINTMENT

  • Timing name
  • Timing Date and Time

AmendOrderResponse: APPOINTMENT

  • Order details
  • Timing name
  • Timing Date and Time
 

AmendOrderNotification: SERVICE_GIVEN

  • Order details
  • State & Substatus: Service Given/Service Given

> Use Case Exceptions

Use case exception examples showing AmendOrderRequest: APPOINTMENT exceptions are provided by:

  • BIC105 - Customer Amends Order

Success Criteria

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

The document is available from:

Refer to the TCF website for documentation.

Request Success Criteria

ID DESCRIPTION
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.01 Service Provider can enter a Service Provider Order Reference ID when submitting a service request via the B2B and/or SSP.
SC35.02 Service Provider can enter any letter, number or punctuation key.
US46 As a Service Provider I want to amend a service order via the OSS/BSS so I can save cost.
SC46.01 Service Provider can amend a service order via the SSP.
SC46.02 Service Provider can amend a service order via the B2B.
SC46.05 Service Provider can amend the Business Name of the End Customer of the service order. This field is optional.
SC46.06 Service Provider can amend the contact name of the End Customer of the service order. This field is optional.
SC46.07 Service Provider can amend the phone number of the End Customer of the service order. This field is optional.
SC46.08 Service Provider can amend the alternate phone number of the End of the service order. This field is optional.
SC46.09 Service Provider can amend the Site Contact Name for the service order. This field is optional.
SC46.10 Service Provider can amend the Site Contact Number for the service. This field is optional.
SC46.11 Service Provider can amend the preferred connection date.
SC46.12 Service Provider can amend a preferred installation time for the connection date.
SC46.13 Service Provider can amend the product required.
SC46.14 Service Provider can amend any additional products required.
SC46.15 Service Provider can amend the preferred ETP installation location.
SC46.16 Service Provider can amend the preferred ONT installation location.
SC46.17 Service Provider can amend alarms or other relevant products in use.
SC46.18 Service Provider can complete an additional notes field (additional installer instructions / health and safety information) if required. This field is optional.
SC46.19 Service Provider can amend the IP address(es) (for VoIP service).
SC46.20 Service Provider can amend the phone number(s) (for VoIP service).
SC46.21 Service Provider can amend the UNI VLAN.
SC46.22 ServiceProvider can amend the name and contact details of the nominated primary contact person(s) to be contacted about the service request.
SC46.23 ServiceProvider can amend the name and contact details of the nominated person within their organisation to be contacted about escalations regarding the service request.
US47 As a Service Provider I want to be able to amend an order at any time so that I can meet my Customer’s need. 
SC47.01 Service Provider can amend the service order up to and including the RFS date.
US62 As the Service Provider I want to amend the “Relinquish” service order so I can manage the order effectively.
SC62.01 Service Provider provides the name of the staff member amending the service request. This field is mandatory.
SC62.02 Service Provider provides the phone number of the staff member amending the service request. This field is mandatory.
SC62.03 Service Provider can amend the Business Name of the End Customer of the service order.
SC62.04 Service Provider can amend the contact name of the End Customer of the service order.
SC62.05 Service Provider can amend the phone number of the End Customer of the service order.
SC62.06 Service Provider can amend an alternate phone number of the End Customer of the service order.
SC62.07 Service Provider can amend the Site Contact Name for the service order.
SC62.08 Service Provider can amend the Site Contact Number for the service.
SC62.09 Service Provider can amend the preferred relinquishment date.
SC62.10 ServiceProvider can amendAM orPM as the preferred relinquishment time on the connection date.
SC62.11 Service Provider can amend a preferred relinquishment time on the connection date.
SC62.12 Service Provider can complete an additional notes field if required to alert to site specific requirements and health and safety issues.
SC62.13 Service Provider must enter the Service ID.
SC62.14 ServiceProvider can amend the name and contact details of the nominated primary contact person within their organisation to be contacted about the service request.
SC62.15 ServiceProvider can amend the name and contact details of the nominated person within their organisation to be contacted about escalations regarding the service request.
US69 As a service provider I want to be able to amend details about an existing appointment so that the LFC has the right information to deliver the desired End Customer outcomes.
SC69.01 Service Provider can amend or add a nominated person (or persons) to be contacted when an appointment is to be scheduled or rescheduled.

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.
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.
US40 As an LFC I want to validate the information entered within the service request on the OSS/BSS before the order is submitted so I can be assured of quality.
SC40.04 When a Service Request submitted via the SSP has failed the validation check, The LFC can highlight the fields which failed the validation check.
SC40.05 When a Service Request submitted via the B2B has failed the validation check, The LFC can send information on which fields failed the validation check.
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.
US50 As a Service Provider I want to receive a notification confirming that the service order amendment has been accepted or rejected so that I can manage Customer expectation.
SC50.01 ServiceProviderreceivesconfirmationthattheserviceorderamendmenthasbeen accepted, or rejected, including the reason for rejection.
SC50.05 The notification contains the details of the service order asamended by theService Provider. Key Non-FunctionalReferences

 

Fibre Ordering

BIC108: Supplier Notifies Customer Order Information Required

Getting Started Architecture Processes Web services Help & support FAQs
  1. Tools
  2. Fibre Ordering
  3. B2B
  4. Processes
  5. BIC108: Supplier Notifies Customer Order Information Required
Back

Name

Supplier Notifies Customer Order Information Required

Description

This process provides us with the ability to ask you for a decision or an update to an order belonging to you.

Related B2B Services

Preceded by

Flow - Supplier Notifies Customer Order Information Required

Pre-conditions

You have created an order using BIC101: Customer Creates Order, it has passed the state and substate of Acknowledged/Received but has not reached the state of Closed.

Post-Conditions

Based on your response, we update the order and it continues through the fulfilment process.

Basic Path

STEP DESCRIPTION ROLE
1 Identify an update or decision required from the customer. Chorus
2 Change the state and substate of the order, send a notification to advise the customer of the steps required. Chorus
3 Receive the notification and determine the appropriate action. Send updates or answers questions using an Amend Order Request Customer

Use Cases

The following use cases support this business process.

Click on the links to view the XML samples.

> Provider to Advise Response

In this example we ask you to update the customer and site contact details in your order by sending:

Amend Order Notification: HELD_PROVIDER_TO_ADVISE message to advise you that we have put your order into held provider to advise while we wait for more information.

You respond using the following Amend Order Request types:

  • CONTACT_DETAILS- to update the customer contact details
  • ORDER_DETAILS - to update the site contact details
  • ANSWER - to advise that you have completed your response.
REQUEST NOTIFICATION / RESPONSE
 

AmendOrderNotification: HELD_PROVIDER_TO_ADVISE

  • Order details
  • State&Substatus: Held/ProvidertoAdvise
  • Question id
  • QuestionValue

AmendOrderRequest: CONTACT_DETAILS

  • End Customer name
  • Contact medium
  • Contact details

Customer Amends Order: CONTACT_DETAILS

  • End Customer name
  • Contact medium
  • Contact details

AmendOrderRequest: ORDER_DETAILS

  • BillingInformation
  • Order Email
  • Access and Equipment location

Customer Amends Order: ORDER_DETAILS

  • BillingInformation
  • Order Email
  • Access and Equipment location

AmendOrderRequest: ANSWER

  • Question id
  • QuestionValue
  • AnswerValue

Customer Amends Order: ANSWER

  • Question id
  • QuestionValue
  • AnswerValue

Success Criteria

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

The document is available from:

Refer to the TCF website for documentation.

ID DESCRIPTION
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 Service Provider reference is provided on all notifications regarding the service request order.
SC38.01 The LFCs agree on a common set of service states which are captured in the business interaction framework.
SC39.09 The Order Reference Number is included on all order notifications.
SC39.11 The date and time are included on all order notifications.
SC39.12 LFC uses a formatted template for the notifications.

Fibre Ordering

BIC106-BIC110: SupplierReschedulesOrder Appointment

Getting Started Architecture Processes Web services Help & support FAQs
  1. Tools
  2. Fibre Ordering
  3. B2B
  4. Processes
  5. BIC106-BIC110: SupplierReschedulesOrder Appointment
Back

Name

Supplier Changes Appointment or RFS Date

Description

This process provides us with the ability to change a site visit appointment or RFS date against an order belonging to you.

Related B2B Services

Preceded by

Flow - Supplier Changes Appointment or RFS Date

bic106

Pre-conditions

We reschedule a site visit appointment or RFS date in your order.

Post-conditions

You receive our amend order notification advising you of the updated appointment date and time.

Basic Path

STEP DESCRIPTION ROLE
1 Identify a site visit appointment or RFS date that require rescheduling. Chorus
2 UpdatethesitevisitappointmentorRFSdate,sendanamendorder notification to the customer. Chorus
3,4 Receive the notification and action as required. Customer

Use Cases

The following use cases support this business process.

Click on the links to view the XML samples.

> Reschedule Site Visit Appointment

In this example we have updated the Scope and Install appointments against your order. We advise you by sending:

  • AmendOrderNotification: SVM_EVENT to advise you that we have changed the Scope site visit.
  • AmendOrderNotification: SVM_EVENT to advise you that we have changed the Install site visit.
REQUEST RESPONSE
 

AmendOrderNotification: SVM_EVENT

  • Order details
  • State & Substatus: In Progress/Scoping Scheduled
 

AmendOrderNotification: SVM_EVENT

  • Order details
  • State & Substatus: In Progress/Scheduled
 

AmendOrderNotification: SCHEDULED

  • Order details
  • State & Substatus: In Progress/Scheduled

> Reschedule RFS Date

In this example, we have updated the RFS date against your order. We advise you by sending:

  • AmendOrderNotification: SVM_EVENT.
REQUEST RESPONSE
 

AmendOrderNotification: SCHEDULED

  • Order details
  • State & Substatus: In Progress/Scheduled
 

AmendOrderNotification: SVM_EVENT

  • Order details
  • State & Substatus: In Progress/Scheduled
 

AmendOrderNotification: SERVICE_GIVEN

  • Order details
  • State & Substatus: Service Given/Service Given

Success Criteria

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

The document is available from:

Refer to the TCF website for documentation.

ID DESCRIPTION
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.
US42 As theServiceProviderI want to receive a notification when my service request has been confirmed so I that can pre-configure the end-user service, and manage Customer expectation.
SC42.03 The notification contains the Service Provider Order Reference Number where supplied.
SC42.04 The notification contains a date and time stamp.
SC42.06 If the requested appointment date is unavailable, the notification shows that it is a revised appointment date.
SC42.07 The notification contains the Handover Point ID(s). POI ID; E-NNI ID; and Dark Fibre Service End-Points.
SC42.08 Notification contains confirmation of Service ID.
SC42.09 The notification contains the E-NNI Service VLAN ID(s).
SC42.10 The notification contains the E-NNI Customer VLAN ID(s) where applicable.
SC42.11 The notification contains the unique address identifier.
SC42.12 The notification contains the UNI Port identifier(s) where not defaulted in the Service Template.
SC42.13 The notification contains the UNI VLAN identifier(s) where applicable and not defaulted in the Service Template.
SC42.14 The notification contains all necessary information to enable the service provider to preconfigure the service. e.g. SVID, CVID and ONT port.
SC42.16 The notification contains the projected RFS date.
SC42.17 The notification can include the LFC’s parent ID that they have assigned to the service being activated and to related services that are to be joined to form an end-to-end service.
SC42.18 The notification can include the Service Providers parent ID that they have assigned to the service being activated and to related services that are to be joined to form an end-to-end service where supplied.
SC42.19 The notification contains the agreed option 82 value where relevant.
US53 As a Service Provider I want to be kept informed if an installation will not be completed on RFS date so I can ensure a contingency plan can be activated if necessary.
SC53.01 Service Provider will be notified if the installation will not be completed on RFS date.
SC53.02 Service Provider will be notified of the reason for delay.
SC53.03 Service Provider will be notified of a new appointment date as agreed with Customer.
US54 As a Service Provider I want to know if the Customer has aborted the site visit so that I can determine what my next action is.
SC54.01 Service Provider receives notification that the Customer has aborted the site visit.
SC54.02 Service Provider is notified of the reason the Customer gave for aborting the site visit.
SC54.03 Service Provider is notified of any costs incurred due to aborted site visit.
SC54.04 Service Provider is notified of any further action required, where relevant.
US67 As a Service Provider I want to be kept informed if an appointment has been cancelled or needs to be rescheduled so that I can determine what my next action is.
SC67.01 Service Provider will be notified of a new appointment date as agreed.
SC67.02 Service Provider will be notified who the contact person was who agreed the appointment time.
US188 As an LFC or Service Provider I need all interactions relating to contractual transactions to have guaranteed, verified delivery, so that commercial disputes can be resolved factually.
Subscribe to