Feedback

We use this B2B notification service to advise you of changes to order details or attributes.

This information provides allows you to maintain accurate records regarding the state and substate of your order, and enables us to advise you when we require an action or information from you.

Related Business Process

Related Product

This service is available for fibre products.


> Order - BillingInformation Elements

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.

 


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

The following table describes the values provided by the category element.

VALUE DESCRIPTION
Product  
Install  
CSE  
INCIDENTAL  

-- Order - BillingInformation - Charge - ChargeType

The following table describes the values provided by the ChargeType element.

VALUE DESCRIPTION
Recurring  
One Time  

 


> Order - EscalateOrder Elements

The following table describes the EscalateOrder elements.

VALUE OUTPUT DESCRIPTION
escalated Always Boolean flag indicating if the order has been escalated.
escalationReason Always Returns the escalation reason that you provided.
escalationComment Always Returns the escalation comments that you provided.

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

The following table describes the values provided by the Reason element.

VALUE DESCRIPTION
code Cancellation reason identifier.
description Description of the cancellation reason.

The following table provides the mapping for the new code and description values released on the 15th of August 2016.

CODE DESCRIPTION
CHORUS_CANCEL_27 Order Acceptance - Duplicate order removed
CHORUS_CANCEL_29 Order Acceptance - Incorrect Address – New order submitted
CHORUS_CANCEL_28 Order Acceptance - Incorrect Address – No new order submitted
CHORUS_CANCEL_25 Order Acceptance - Incorrect pre-qual information
CHORUS_CANCEL_26 Order Acceptance - Missing order information
CHORUS_CANCEL_24 OrderAcceptance-Primary fibreservicealreadyonsite(anprimary requested)
CHORUS_CANCEL_44 Consent Not Gained - Building owner decline consent due to contribution costs
CHORUS_CANCEL_41 Consent Not Gained - Building owner didn’t respond
CHORUS_CANCEL_46 Consent Not Gained - Building owner rejected design
CHORUS_CANCEL_45 Consent Not Gained - Building/premises under renovation
CHORUS_CANCEL_42 Consent Not Gained - Neighbour declined ROW consent
CHORUS_CANCEL_43 Consent Not Gained - Neighbour didn’t respond
CHORUS_CANCEL_37 Customer Cancelled - Access Denied
CHORUS_CANCEL_34 Customer Cancelled - Changed to VDSL/ADSL
CHORUS_CANCEL_40 Customer Cancelled - Customer did not accept contribution cost
CHORUS_CANCEL_30 Customer Cancelled - Excessive delay for RFS
CHORUS_CANCEL_32 Customer Cancelled - Fibre not requested
CHORUS_CANCEL_36 Customer Cancelled - Landlord declined permission
CHORUS_CANCEL_33 Customer Cancelled - Now moving address
CHORUS_CANCEL_35 Customer Cancelled - Opted to remain on DSL
CHORUS_CANCEL_31 Customer Cancelled - Premise not ready for fibre installation
CHORUS_CANCEL_39 CustomerCancelled -Unhappy with external scoping options (installation)
CHORUS_CANCEL_38 Customer Cancelled - Unhappy with internal scoping options (installation)
CHORUS_CANCEL_49 LFC Cancelled - Chorus error
CHORUS_CANCEL_48 LFC Cancelled - Incorrect pre-qual – service not available
CHORUS_CANCEL_51 LFC Cancelled - Medical dependency issue e.g. customer hasn’t checked with alarm company
CHORUS_CANCEL_50 LFC Cancelled - Security alarm not compatible
CHORUS_CANCEL_47 LFC Cancelled - Unable to contact customer
CHORUS_CANCEL_53 RSP Cancelled - Feasibility/Quote rejected by customer
CHORUS_CANCEL_52 RSP Cancelled - Incorrect Details
CHORUS_CANCEL_54 RSP Cancelled - Submitted in Error

 


> Order - OrderItem Elements

In addition to the current Order - OrderItem elements and values the inform and amend order notifications will include the following OrderItem elements where appropriate.

NAME OUTPUT DESCRIPTION
Timing Conditional Date and time for service connection or disconnection.
SiteVisit Conditional Appointment details for site visits.
Question Conditional Request a decision from you regarding the next steps for the order.
Quote Conditional Provide you with quote details.
ClosureCode Conditional  

 


> Order - OrderItem - Timing Elements

The following table describes the Timing elements.

NAME OUTPUT DESCRIPTION
name Always Type of RFS date
dateTime Always Date and time value.

-- Order - OrderItem - Timing - name

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.
SERVICE_GIVEN_DATE Date and time service was provided.

 


> Order - OrderItem - Site Visit Elements

The following table describes the SiteVisit elements.

NAME OUTPUT DESCRIPTION
id Always Site Visit identifier.
bookable Always Indicates if the site visit is bookable.
type Always Purpose of the site visit.
AppointmentSlot Always Date and time of the site visit.

-- 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 - AppointmentSlot Elements

NAME OUTPUT DESCRIPTION
dateTime Conditional Appointment start and end dates and times.

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

The following table describes the values provided by the Question element.

VALUE DESCRIPTION
id  
questionValue  
reference  
validFor  

-- 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 - Quote Elements

The following table describes the values provided by the Quote element.

VALUE DESCRIPTION
number Quote identifier
description Description of the quote.
value The quote amount

 


> Notification Elements

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.

-- 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-text updates from the Chorus Provisioning team, 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.

 


Inform Order NotificationItem Details

Details of the notification items provided by the Inform Order Notifications the are described here.

Note: this type of notification is not used to notify you of an order state or substate change.


> Notification - type - STATUS

-- Notification - NotificationItem

The following table describes the values provided by the STATUS NotificationItem elements.

NOTIFICATIONITEM VALUE
description A status update has been given for your customer order
reference //Order/id[text()='ORDER_ID']
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate

 


> Notification - type - STATUS_WITH_NOTE

-- Notification - NotificationItem

The following table describes the values provided by the STATUS_WITH_NOTE NotificationItem elements.

NOTIFICATIONITEM VALUE
description A status update has been given for your customer order
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description NOTIFICATION_TEXT
reference Note

 


> Notification - type - MANUAL_INTERACTION

-- Notification - NotificationItem

The following table describes the values provided by the MANUAL_INTERACTION NotificationItem elements.

NOTIFICATIONITEM VALUE
description A status update has been given for your customer order
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description Notification Text
reference NOTIFICATION_BODY

 


> Notification - type - REJECT_CANCEL

-- Notification - NotificationItem

The following table describes the values provided by the REJECT_CANCEL NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order cancellation has been rejected
reference //Order/id[text()='ORDER_ID']
description State transition
reference //Order/OrderItem/state[text()='Current state']
description Sub-state transition
reference //Order/OrderItem/substate[text()='Current substate']
description Rejection Reason
reference [Rejection Reason]

 


Amend Order NotificationItem Details

Details of the state and substate changes and the notification items provided byAmendOrder Notifications the are describedhere.


> Notification - type - ACKNOWLEDGED_ACCEPTED

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - ACKNOWLEDGED_ACCEPTED.

ORDERITEM VALUE
state Acknowledged
substate Accepted

-- Notification - NotificationItem

The following table describes the values provided by the ACKNOWLEDGED_ACCEPTED NotificationItem elements.

NOTIFICATIONITEM VALUE
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description Resource configuration information is available
reference //Order/OrderItem/Product/id

 


> Notification - type - RFS_CONFIRMED

-- Notification - NotificationItem

The following table describes the values provided by the RFS_CONFIRMED NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order RFS datetime is confirmed
reference //Order/id

 


> Notification - type - GENERATE_QUOTATION

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - GENERATE_QUOTATION.

ORDERITEM VALUE
state In Progress
substate Generate Quotation

-- Notification - NotificationItem

The following table describes the values provided by the GENERATE_QUOTATION NotificationItem elements.

NOTIFICATIONITEM VALUE
description A quote is being generated for your customer order
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate

 


> Notification - type - INTENT_TO_CANCEL

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - INTENT_TO_CANCEL.

ORDERITEM VALUE
state Held
substate Intent To Cancel

-- Notification - NotificationItem

The following table describes the values provided by the INTENT_TO_CANCEL NotificationItem elements.

NOTIFICATIONITEM VALUE
description A request has been made to cancel your customer order
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description Cancellation code
reference //Order/Reason/code
description Cancellation reason
reference //Order/Reason/description
description NOTIFICATION_TEXT
reference //Order/OrderItem
description Please refer to the following customer order question
reference //Order/OrderItem/Question//questionValue
description A response is required by
reference //Order/OrderItem/Question/validFor/endDateTime/text()

 


> Notification - type - IN_PROGRESS_INTENT_TO_CANCEL

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - IN_PROGRESS_INTENT_TO_CANCEL.

ORDERITEM VALUE
state In Progress
substate Intent To Cancel

 


-- Notification - NotificationItem

The following table describes the values provided by the IN_PROGRESS_INTENT_TO_CANCEL NotificationItem elements.

NOTIFICATIONITEM VALUE
description Cancellation has been initiated for your customer order
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description Cancellation code
reference //Order/Reason/code
description Cancellation reason
reference //Order/Reason/description

 


> Notification - type - NETWORK_DESIGN

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - NETWORK_DESIGN.

ORDERITEM VALUE
state In Progress
substate Network Design

-- Notification - NotificationItem

The following table describes the values provided by the NETWORK_DESIGN NotificationItem elements.

NOTIFICATIONITEM VALUE
description Chorus has put your customer order into network design
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description Note
reference NOTIFICATION_TEXT

 


> Notification - type - NETWORK_BUILD

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - NETWORK_BUILD.

ORDERITEM VALUE
state In Progress
substate Network Build

-- Notification - NotificationItem

The following table describes the values provided by the NETWORK_BUILD NotificationItem elements.

NOTIFICATIONITEM VALUE
description Chorus has placed your customer order into network build
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description NOTIFICATION_TEXT
reference //Order/OrderItem

 


> Notification - type - SCOPING_SCHEDULED

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - SCOPING_SCHEDULED.

ORDERITEM VALUE
state In Progress
substate Scoping Scheduled

-- Notification - NotificationItem

The following table describes the values provided by the SCOPING_SCHEDULED NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your scope appointment has been scheduled
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description Scoping site visit
reference //Order/SiteVisit[type='Scope']/id

 


> Notification - type - SCHEDULED

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - SCHEDULED.

ORDERITEM VALUE
state In Progress
substate Scheduled

-- Notification - NotificationItem

The following table describes the values provided by the SCHEDULED NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order is scheduled for network activation
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
The following NotificationItem will be returned for a SiteVisit appointment description Install site visit
reference //Order/SiteVisit[type='Install' or type='Install/CSE']
The following NotificationItem will be returned for a RFS appointment  
description RFS Date
reference //Order/OrderItem/timing[name='CONNECT_RFS_DATE_TIME' or name='DISCONNECT_RFS_DATE_TIME']

 


> Notification - type - INVESTIGATION_REQUIRED

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - INVESTIGATION_REQUIRED.

ORDERITEM VALUE
state In Progress
substate Investigation Required

-- Notification - NotificationItem

The following table describes the values provided by the INVESTIGATION_REQUIRED NotificationItem elements.

NOTIFICATIONITEM VALUE
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate

 


> Notification - type - QUOTE_ACCEPTANCE

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - QUOTE_ACCEPTANCE.

ORDERITEM VALUE
state Held
substate Waiting on Quote Acceptance

-- Notification - NotificationItem

The following table describes the values provided by the QUOTE_ACCEPTANCE NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order requires quote acceptance
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description Quote detail
reference //Order/OrderItem/Quote/description
description Please refer to the following customer order question
reference //Order/OrderItem/Question/questionValue
description A response is required by
reference //Order/OrderItem/Question/validFor/endDateTime

 


> Notification - type - HELD_SCHEDULE_SCOPING

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - HELD_SCHEDULE_SCOPING.

ORDERITEM VALUE
state Held
substate Schedule Scoping

-- Notification - NotificationItem

The following table describes the values provided by the HELD_SCHEDULE_SCOPING NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order required scheduling of an scope appointment site visit
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description Customer to schedule scope site visit
reference //Order/SiteVisit[type='Scope']/id

 


> Notification - type - HELD_SCHEDULE_INSTALL

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - HELD_SCHEDULE_INSTALL.

ORDERITEM VALUE
state Held
substate Schedule Install

-- Notification - NotificationItem

The following table describes the values provided by the HELD_SCHEDULE_INSTALL NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order required scheduling of an install appointment site visit
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description Customer to schedule install site visit
reference //Order/SiteVisit[type='Install' or type='Install/CSE']/id

 


> Notification - type - HELD_PROVIDER_TO_ADVISE

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - HELD_PROVIDER_TO_ADVISE.

ORDERITEM VALUE
state Held
substate Provider To Advise

-- Notification - NotificationItem

The following table describes the values provided by the HELD_PROVIDER_TO_ADVISE NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order requires advisement
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description NOTIFICATION_TEXT
reference //Order/OrderItem
description Please refer to the following customer order question
reference //Order/OrderItem/Question/id[text='QUESTION_ID']../questionValue/text()
description A response is required by
reference //Order/OrderItem/Question/id[text='QUESTION_ID']/validFor/endDateTime/text()

 


> Notification - type - HELD_PENDING_DISCONNECT_ACCEPTANCE

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - HELD_PENDING_DISCONNECT_ACCEPTANCE.

ORDERITEM VALUE
state Held
substate Pending Disconnect Acceptance

-- Notification - NotificationItem

The following table describes the values provided by the HELD_PENDING_DISCONNECT_ACCEPTANCE NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order is awaiting disconnect acceptance of a linked replace order
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description A customer product instance is awaiting disconnect acceptance
reference //Order/OrderItem/Product/id

 


> Notification - type - SERVICE_GIVEN

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - SERVICE_GIVEN.

ORDERITEM VALUE
state Service Given
substate Service Given

-- Notification - NotificationItem

The following table describes the values provided by the SERVICE_GIVEN NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order has been fulfilled
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate

 


> Notification - type - COMPLETED_BILLING

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - COMPLETED_BILLING.

ORDERITEM VALUE
state Completed
substate Billing

-- Notification - NotificationItem

The following table describes the values provided by the COMPLETED_BILLING NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order billing is being processed
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate

 


> Notification - type - CLOSED_CANCELLED

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - CLOSED_CANCELLED.

ORDERITEM VALUE
state Closed
substate Cancelled

-- Notification - NotificationItem

The following table describes the values provided by the CLOSED_CANCELLED NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order has been cancelled
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description Cancellation code
reference //Order/Reason/code
description Cancellation reason
reference //Order/Reason/description

 


> Notification - type - CLOSED_COMPLETED

The following table provides the OrderItem state and substate associated with the AmendOrderNotification - Notification - type - CLOSED_COMPLETED.

ORDERITEM VALUE
state Closed
substate Completed

-- Notification - NotificationItem

The following table describes the values provided by the CLOSED_COMPLETED NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order has been completed
reference //Order/id
description State transition
reference //Order/OrderItem/state
description Sub-state transition
reference //Order/OrderItem/substate
description Billing total
reference BILLING_TOTAL

 


> Notification - type - SVM_EVENT

-- Notification - NotificationItem

The following table describes the values provided by the SVM_EVENT NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order site visit has been updated
reference //Order/id
description Site visit
reference //Order/SiteVisit[id='SITE_VISIT_ID']
description Description
reference notification_text
description Site Visit Type
reference //Order/SiteVisit[type='Scope'ortype='Install'ortype='Install/CSE'or type='CSE']
description Event Description
reference notification_verb
description Timestamp
reference notification_timestamp
description Reason
reference notification_reason

> SVM Event Description

The following descriptions are used to describe the result of changes to the site visit scoping and/or install appointments.

DESCRIPTION REFERENCE
Site Visit Type

The Site Visit Type will be one of the following:

  • //Order/SiteVisit[type='Scope']
  • //Order/SiteVisit[type='Install']
  • //Order/SiteVisit[type='Install/CSE']
  • //Order/SiteVisit[type='CSE']

Event Description

Note: Not to be confused with state/substates. These descriptions relate to the site visit.

TheEventdescriptionnotificationverb will be one of the following:

  • Rescheduled to
  • On-Hold
  • Service Given
  • Completed

Timestamp

The date and time of the reschedule. e.g. 26-08-2016 08.00 AM.
Reason The reason description returned from the Site visit activity

 


> Notification - type - ESCALATION_ACCEPTED

-- Notification - NotificationItem

The following table describes the values provided by the ESCALATION_ACCEPTED NotificationItem elements.

NOTIFICATIONITEM VALUE
description Chorus has accepted escalation of your customer order
reference //Order/id
description Escalation Accepted and updates will be provided as they become available
reference //Order/EscalateOrder

 


> Notification - type - ESCALATION_COMPLETED

-- Notification - NotificationItem

The following table describes the values provided by the ESCALATION_COMPLETED NotificationItem elements.

NOTIFICATIONITEM VALUE
description Chorus has completed escalation of your customer order
reference //Order/id
description ESCALATION_COMPLETION_COMMENT
reference //Order/EscalateOrder/escalationCompletionNote/text()

 


> Notification - type - ESCALATION_DECLINED

-- Notification - NotificationItem

The following table describes the values provided by the ESCALATION_DECLINED NotificationItem elements.

NOTIFICATIONITEM VALUE
description Chorus has declined escalation of your customer order
reference //Order/id
description Escalation Declined as it does not meet the standard escalation criteria
reference //Order/EscalateOrder/escalated/text()

 


> Notification - type - AMEND_ORDER_COMPLETED

-- Notification - NotificationItem

The following table describes the values provided by the AMEND_ORDER_COMPLETED NotificationItem elements.

NOTIFICATIONITEM VALUE
description Your customer order amendment has been completed
reference //Order/id

 


> Reason Not Complete Codes

The following codes are used to describe the result of appointments, and are sent using the relevant Notifications message, e.g. SVM_EVENT includes this along with other descriptive information in the NOTIFICATION_TEXT.

NOTIFICATION_TEXT NOTES
End customer requested booking date change  
Endcustomernotavailable,appointment reschedule required Inform (Service Company will reschedule)
No access to location  
Endcustomernotavailable,appointment reschedule required Action (Service Company does NOT have permission to reschedule)
Resources not available  
Civil or network build required  
Third party permission required  
Quote generation in progress  
Civil or network build required  
MDU investigation required  
Right-of-way investigation required  
Service Provider to Advise An Interaction will follow
Non-standard installation required  
Resources not available  
Chorus Change Service Company reschedule appointment due to Chorus issue
Hazardous conditions  
Civil or network build required  
Quote generation in progress  

 


Order Notification Details

Service Name

  • InformOrderNotification
  • AmendOrderNotification

-- Service Outputs

Notifications contain the current order details and notification values. The following tables lists key information that is included with some notification types.

NOTIFICATION TYPE KEY INFORMATION
  • SCHEDULED
  • SCOPING_SCHEDULED
  • HELD_SCHEDULE_SCOPING
  • HELD_SCHEDULE_INSTALL
  • SiteVisit details
  • CONSENT_REQUESTED
  • CONSENT_GAINED
  • CONSENT_DECLINED
  • GroupedOrderInformation
  • ESCALATION_ACCEPTED
  • ESCALATION_COMPLETED

ESCALATION_DECLINED

  • EscalateOrder
  • QUOTE_ACCEPTANCE
  • HELD_PROVIDER_TO_ADVISE
  • Question
  • QUOTE_ACCEPTANCE
  • Quote
  • SVM_EVENT
  • Site Visit Type
  • Event Description
  • Timestamp
  • Reason
  • SERVICE_GIVEN
  • Timing (including SERVICE_GIVEN_DATE)
  • BillingInformation (including billingEffectiveDate)
  • INTENT_TO_CANCEL
  • Reason
  • Question
  • CLOSED_CANCELLED
  • Reason
  • BillingInformation
  • CLOSED_COMPLETE
  • BillingInformation