Fibre Ordering

B2B Exception Codes

Getting Started Architecture Processes Web services Help & support FAQs

Back

If the B2B Web Service encounters a problem it will return an exception message containing the fields:

generated id
code
description
reference (XPath).

B2B exception messages

CODE	DESCRIPTION	MEANING	TOUCHPOINT	REFERENCE
000	Backend processing error encountered - If problem persists please contact Chorus admin	General exception returned for errors that do not have a specific exception code.	ALL	/
001	Supplier Location ID not found	The Place id cannot be found.	TP001 TP002 TP005	//Place/id
002	Address not found	The Address cannot be found.	TP005	//Address
003	Product Instance ID not found	The Product id could not be found.	TP002	/QueryOrderFeasibility/QueryOrderFeasibilityInteraction/ QueryOrderFeasibilityInteractionItem/Order/OrderItem/ ProductOffering/Product/id
004	Required field PLSAM not valid - Please enter valid PLSAM (1 to 7 digits)	The AddressKey value for the PLSAM is invalid.	TP005	//Address/AddressKey/type[text()='PLSAM']/../value/text()
005	Supplier Location ID is not valid	The value entered against Place id is invalid.	TP001 TP002 TP005 TP025	//Place/id
006	Element ‘streetAlphaNumeric’ contains an invalid value	The value entered against streetAlphaNumeric is invalid.	TP005	//Address/stAlphaNumeric
007	Customer is not onboarded for any Product Offers for this Location ID	You are not onboarded for product offers at the location (Place id)	TP001	//Address/Place/id
008	Element ‘streetName’ contains an invalid value	The value entered against streetName is invalid.	TP005	//Address/streetName
009	TUI Address Key is not valid	The AddressKey value for the TUI id is invalid	TP005	//Address/AddressKey/name[text()='TUI']/../value/text()
010	TUI Address Key is not found	The AddressKey value for the TUI is not found.	TP005	//Address/AddressKey/name[text()='TUI']/../value/text()
011	Unknown filter criteria specified {%s}	The supplied filter criteria is not supported.	TP001	//Filter/FilterCriteria/name[text()='']../value/text()
012	Order decomposition error: {%s}	Order decomposition failed for the specified reason.	TP002	/QueryOrderFeasibility/QueryOrderFeasibilityInteraction/ QueryOrderFeasibilityInteractionItem/Order/OrderItem
014	Customer not onboarded for requested Product Offer	You are not onboarded for the Product Offer	TP002	//Order/OrderItem/ProductOffering/id[text()=’{%s}’]
015	Site Visit ID not found	The SiteVisit id is not found.	TP003 TP011 TP012	//SiteVisit/id[text(
016	DateTime Range not valid	The date and time range is not within a valid appointment or RFS availability timeframe	TP003 TP011 TP012	//SiteVisit/id[text()
017	RFS validation failed: {%s}	The RFS date failed validation for the specified reason.	TP003 TP004 TP011	/
018	Question Answer Failed: {%s}	The AmendOrderType ANSWER request failed for the specified reason.	TP004	//Order/orderItem/question/questionId[text()=’{%s}’]
019	Customer Order ID or Customer Reference ID not found	The value entered against Order id or customerReferenceId is not found	TP003 TP004 TP007 TP011 TP012	//Order/id
020	Appointment reschedules failed as charges may apply - Please resubmit & accept charges.	Charges may apply for requested reschedule, resubmit with acceptCharges TRUE to proceed.	TP004	/
021	EXCHANGE_CODE Address Key is not valid	The address key should be 2-5 alpha (a-z) characters.	TP005	//Address/AddressKey/type[text()='EXCHANGE_CODE']/../value/text()
022	Specified Address Key ‘type’ is not valid	Valid values for AddressKey type are PLSAM or TUI.	TP005	//Address/AddressKey/type[text()=’{%s}’]../value/text()
023	PLSAM Address Key is not found	The AddressKey value for the PLSAM is not found.	TP005	//Address/AddressKey/type[text()='PLSAM']/../value/text()
024	EXCHANGE_CODE Address Key is not found	The AddressKey value for the EXCHANGE_CODE is not found.	TP005	//Address/AddressKey/type[text()='EXCHANGE_CODE']/../value/text()
025	The attribute {%s} in the request does not exist or does not match the corresponding attribute in the Order record	There is a mismatch between the Order Feasibility attributes and values in the corresponding Create Order request.	TP003 TP004	//*[contains(node(), %s)]
026	Request validation failed: {%s}	Request validation failed for the specified reason.	TP002 TP003 TP004 TP006 TP007	//*[contains(node(), %s)]
027	Order Feasibility has expired.	The order cannot be created as order feasibility has expired	TP003	QueryOrderFeasibilityResponse/xsl:choose/xsl:otherwise/ OrderFeasibilityInteraction/OrderFeasibilityInteractionItem/ OrderFeasibilityResult/validFor/endDateTime
028	Multiple results for Exact Match details entered	Multiple results found for the ExactMatch search criteria.	TP005	//Address
029	The Order State of the specified Customer Order does not support the selected action	The operation called is invalid, e.g. the order type used in the Create Order request does not match the order type used in the Query Order Feasibility request.	TP003 TP004 TP006 TP011 TP012	//Order/OrderItem/state
030	The Order ID provided belongs to a different customer	The Order id belongs to another Customer.	TP003 TP011 TP012 TP007 TP004 TP006	//Order/id
031	Site Visit request failed: {%s}	The Site Visit request failed for the specified reason.	TP011 TP012	//Order/SiteVisit/id
032	Appointments cannot currently be queried or booked for this Site visit ID. Please check the order state.	Appointment is not bookable in the current order state	TP003 TP011 TP012	//Order/SiteVisit/AppointmentSlot/dateTime
033	Multiple results found for Customer Reference entered	Multiple results found, please enter a unique CustomerReferenceId or query using Order id.	TP007	//Order/customerReferenceId
034	No timeslots available for a provided date range	There are no timeslots available within the date and time range	TP012	//Order/SiteVisit/AppointmentSlot/dateTime
035	Requested timeslot not available, please try a different timeslot.	Requested appointment is not available.	TP003 TP011 TP012	//Order/SiteVisit/AppointmentSlot/dateTime
036	The replaced product instance must be owned by a different RSP	For the order types move and replace and connect and replace the ProductId being replaced must belong to another RSP.	TP002	/QueryOrderFeasibility/QueryOrderFeasibilityInteraction/ QueryOrderFeasibilityInteractionItem/Order/OrderItem/ ProductOffering/Product/id
040	Request for RFS date contains sitevisitID	If the request includes Order type, i.e. query for RFS dates, it must not contain a SiteVisit id.	TP011	/
041	Request for RFS date contains invalid RFS date type	If SiteVisit type is RFS date connect or disconnect, a SiteVisit id cannot be included in the request	TP011	/
044	Internal WSDL Validation error. Outbound schema validation failed, please refer to process documentation	The payload of the response message we are trying to send does not comply with the WSDL	TP003 TP005 TP025 TP002 TP011 TP012 TP007 TP006 TP004 TP001	/
045	Request processed. Timed out awaiting the result. Please refer to process documentation	When a back-end component does not respond within the set time-out period; a message time-out error is thrown	TP003 TP004 TP006	/
046	Request processed. Timed out awaiting the result. Please retry.	When a back-end component does not respond within the set time-out period; a message time-out error is thrown	TP007 TP002 TP025	/
050	ONT Serial Number is not valid	ONT Serial Number entered is not : -12 characters long -Alphanumeric (i.e no wild characters are allowed in the serial number)
051	ONT Serial Number not found	ONT Serial Number can not be found in our Inventory
060	Notification Email is mandatory when Notification Preference is true	The OrderEmailNotification value is true but the emailAddress is not included in the request.	TP003	/
072	Incorrect 'reason' information supplied: %s	Supplied reason code is not valid		//Order/Reason/code
080	CSE Validation Failure: {%s}	The CSE selected on the Order Feasibility request has failed validation for the specified reason Where {%s} is a variable to be replaced by the description value returned by the createOrder response – “CSE Validation Failure: The selected CSE is not compatible with the Product Offer ordered."	TP002	//Order/OrderItem/ProductOfferring/id
081	CSE Validation Failure: {%s}	The CSE selected on the Order Feasibility request has failed validation for the specified reason Where {%s} is a variable to be replaced by the description value returned by the createOrder response – “CSE Validation Failure: Disconnect Primary PONFAS Distribution Orders must include a CSE Offer.”	TP002	//Order/OrderItem/ProductOfferring/id

Fibre Ordering

Reserve Appointment

Getting Started Architecture Processes Web services Help & support FAQs

Back

This B2B service allows you reserve or change an appointment against an order.

Related Business Process

BIC005: Reserve Appointment

Related Products

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.
type		O	Type of order.
SiteVisit	Mandatory	O	Appointment details for site visits.

Order - SiteVisit Elements

The following table provides details of the SiteVisit elements.

NAME	CARDINALITY	INPUT/OUTPUT	DESCRIPTION
id	Mandatory	I/O	Unique identifier for the site visit.
type		O	Type of appointment.
AppointmentSlot	Mandatory	I/O	Appointment Slot selected from the range provided by the Query Appointment Availability.

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

The following table describes the AppointmentSlot elements.

NAME	CARDINALITY I	INPUT/OUTPUT	DESCRIPTION
id		O	Appointment slot identifier.
dateTime	Mandatory	I/O	Anarrayofappointment startandenddatesand times. The start dates and times must be provided exactly as they were returned by the Query Appointment Availability Response.

NAME

CARDINALITY I

INPUT/OUTPUT

DESCRIPTION

Appointment slot identifier.

dateTime

Mandatory

I/O

Anarrayofappointment startandenddatesand times.

The start dates and times must be provided exactly as they were returned by the Query Appointment Availability Response.

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

Date and time values use the xsd:dateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00].

Reserve Appointment Request Details

Service Name

ReserveAppointmentRequest

Service Inputs

The following criteria is mandatory for requesting this service.

INPUT	DESCRIPTION
Order id	Identifier of the related order
SiteVisit id	Identifier for the site visit returned by the Order Feasibility query.
SiteVisit type	Type of site visit that is required.
SiteVisit AppointmentSlot	The exact startDateTime and endDateTime returned by BIC004 Query Appointment Availability.

Message Handling Specifications

NAME	DESCRIPTION
MEP	Synchronous call with Acknowledgement.
Inputs	Request appointment reservation for a location.
Outputs	Synchronous Acknowledgement.
Non-repudiation	Yes.
Description	Initiates a transaction to reservation an appointment.

Reserve Appointment Response Details

Service Name

ReserveAppointmentResponse

Service Outputs

If valid Order and Site Visit ids were provided, the response will contain the values used in the request and the following SiteVisit elements:

AppointmentSlot id type
startDateTime
endDateTime.

Message Handling Specifications

NAME	DESCRIPTION
MEP	Synchronous call with Acknowledgment.
Inputs	Response to your appointment reservation request.
Outputs	Synchronous Acknowledgement.
Non-repudiation	Yes.
Description	Request appointment reservation is processed or has an exception.

Fibre Ordering

Query Appointment Availability

Getting Started Architecture Processes Web services Help & support FAQs

Back

This B2B service allows you to check the available of Appointment Time Slots for an order.

Related Business Process

BIC004: Query Appointment Availability

Related Products

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.
type		O	Type of order.
SiteVisit	Mandatory	I/O	Appointment details.

Order - SiteVisit Elements

The following table describes the SiteVisit elements.

NAME	CARDINALITY	INPUT/OUTPUT	DESCRIPTION
id	Conditional	I/O	Unique identifier for a site visit
type	Conditional	I/O	Type of appointment.
AppointmentSlot	Optional	I/O	An array of appointment start and end dates and times.

Order - 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.
CONNECT_RFS_DATE_TIME	Service connection dates.
DISCONNECT_RFS_DATE_TIME	Service disconnection dates.

Order - SiteVisit - AppointmentSlot Elements

The following table describes the AppointmentSlot elements.

NAME	CARDINALITY	INPUT/OUTPUT	DESCRIPTION
dateTime		O	Anarrayofappointment startandenddatesand times.
Filter	Optional	I/O	Allows you to restrict your search criteria to range of appointment time slots. The search criteria is not saved, and will apply only to the requesting instance.

NAME

CARDINALITY

INPUT/OUTPUT

DESCRIPTION

dateTime

Anarrayofappointment startandenddatesand times.

Filter

Optional

I/O

Allows you to restrict your search criteria to range of appointment time slots.

The search criteria is not saved, and will apply only to the requesting instance.

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

Date and time values use the xsd:dateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00].

Order - SiteVisit - AppointmentSlot - Filter - FilterParameter Elements

The following table describes the Filter - FilterParameter elements.

NAME	CARDINALITY I	INPUT/OUTPUT	DESCRIPTION
TimeSlot	Optional	I/O	Allows you to select a date range to limit returned appointment dates and times.
VALIDATE_INTER_APPOINTMENT_LEADTIME	Optional	I/O	Flag allowing you to limit the appointment time slots returned for SiteVisits to those with a valid interappointment lead time.

Order - SiteVisit - AppointmentSlot - Filter - FilterParameter - TimeSlot

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

Note: at least one TimeSlot value must be selected to enact this filter.

VALUE	DESCRIPTION
startDateTime	Start date for available appointment search. Note: if a date is not specified, the current date will be used.
endDateTime	Enddateforavailableappointmentsearch. Note: if a date is not specified, the current date plus Default Advance Schedule Duration days will be used. The current setting for Default Advance Schedule Duration is 89 days.

VALUE

DESCRIPTION

startDateTime

Start date for available appointment search.

Note: if a date is not specified, the current date will be used.

endDateTime

Enddateforavailableappointmentsearch.

Note: if a date is not specified, the current date plus Default Advance Schedule Duration days will be used. The current setting for Default Advance Schedule Duration is 89 days.

Date and time values use the xsd:dateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00].

Order-SiteVisit-AppointmentSlot-Filter-FilterParameterVALIDATE_INTER_APPOINTMENT_LEADTIME

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

If this filter is not included in the request, the service will ignore the Inter-Appointment Leadtime rules and return all available appointments (this is the equivalent of selecting 'No').

VALUE	DESCRIPTION
Yes	AppointmentSlots returned will comply with inter-appointment lead time rules.
No	AppointmentSlots returned ignore inter-appointment lead time rules.

Query Appointment Availability Request Details

Service Name

QueryAppointmentRequest

Service Inputs

The following criteria is mandatory for requesting this:

APPOINTMENT TYPE	INPUT CRITERIA	NOTE
SiteVisit	Order id SiteVisit id	TheSiteVisit type must not be included in requests for site visit appointments.
RFS date	Order id SiteVisit id	Valid SiteVisit type values are: CONNECT_RFS_DATE_TIME DISCONNECT_RFS_DATE_TIME

APPOINTMENT TYPE

INPUT CRITERIA

NOTE

SiteVisit

Order id
SiteVisit id

TheSiteVisit type must not be included in requests for site visit appointments.

RFS date

Order id
SiteVisit id

Valid SiteVisit type values are:

CONNECT_RFS_DATE_TIME
DISCONNECT_RFS_DATE_TIME

You may restrict the search criteria to a date range using the following the FilterParameter elements:

TimeSlot
VALIDATE_INTER_APPOINTMENT_LEADTIME (for SiteVisit appointments only).

Note: if the filter is not selected the maximum range of available appointment slots will be returned using current date plus Default Advance Schedule Duration number of days.

Message Handling Specifications

NAME	DESCRIPTION
MEP	Synchronous call with Acknowledgement.
Inputs	Query appointment availability for a location.
Outputs	Synchronous Acknowledgement.
Non-repudiation	Yes.
Description	Initiates a transaction to query appointment availability.

Query Appointment Availability Response Details

Service Name

QueryAppointmentResponse

Service Outputs

If valid Order and SiteVisit details were provided, the response will contain the values used in the request and the range of available time slots using the SiteVisit elements:

startDateTime
endDateTime.

Appointments are either dates and times a site visit can be performed, e.g. Scope, Install, Install/CSE or CSE or as available RFS dates.

Site visit appointments are returned as morning slots from 08:00 - 12:00 and afternoon slots from 13:00 - 17:00, RFS dates are returned on the hour.

The following tables provide examples of the values.

Morning Site Visit:

ELEMENT	VALUE
startDateTime	2015-09-29T08:00:00+13:00
endDateTime	2015-09-29T12:00:00+13:00

Afternoon Site Visit:

ELEMENT	VALUE
startDateTime	2015-09-29T13:00:00+13:00
endDateTime	2015-09-29T17:00:00+13:00

RFS dates:

ELEMENT	VALUE	EXAMPLE
startDateTime	[Time on the hour]	2015-12-15T10:00:00.000+13:00
endDateTime	[Start time + 59M.59S]	2015-12-15T10:59:59.000+13:00

Message Handling Specifications

NAME	DESCRIPTION
MEP	Synchronous call with Acknowledgement.
Inputs	Response to your query of appointment availability for a location.
Outputs	Synchronous Acknowledgement
Non-repudiation	Yes.
Description	Query appointment availability is processed or has an exception.

Fibre Ordering

Order Notifications

Getting Started Architecture Processes Web services Help & support FAQs

Back

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

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

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

ORDERITEM	VALUE
state	In Progress
substate	Consent Required

-- Notification - NotificationItem

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

NOTIFICATIONITEM	VALUE
description	Consent is required for your customer order
reference	//Order/id
description	State transition
reference	//Order/OrderItem/state
description	Sub-state transition
reference	//Order/OrderItem/substate

> Notification - type - CONSENT_REQUESTED

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

ORDERITEM	VALUE
state	In Progress
substate	Consent Requested

-- Notification - NotificationItem

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

NOTIFICATIONITEM	VALUE
description	Consent has been requested 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	//Order/OrderItem

> Notification - type - CONSENT_GAINED

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

ORDERITEM	VALUE
state	In Progress
substate	Consent Gained

-- Notification - NotificationItem

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

NOTIFICATIONITEM	VALUE
description	Consent has been gained for your customer order
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 - CONSENT_DECLINED

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

ORDERITEM	VALUE
state	In Progress
substate	Consent Declined

-- Notification - NotificationItem

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

NOTIFICATIONITEM	VALUE
description	Consent has been declined 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	//Order/OrderItem

> 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

Fibre Ordering

Query Site Information

Getting Started Architecture Processes Web services Help & support FAQs

Back

This B2B service allows you to query a location to review active product instances and open orders.

Related Product

This service is available for fibre products

The data elements and attributes that may be used by this service are described below.

Place Element

The following table describes the Place element

NAME

CARDINALITY

INPUT/OUTPUT

DESCRIPTION

Mandatory

I/O

The primary key for address or location searches.

The Place id is commonly referred to as:

The Supplier Location ID

The Location Code (TLC).

Product Elements

The following table describes the Product elements.

Note: if an Order/OrderItem is acting on a product instance, the product id will also be included. A common example is where an in-flight order exists to disconnect(relinquish) a product. In these cases, it is important that you can identify which product is being relinquished, particularly where multiple products exist at a location.

NAME	INPUT/OUTPUT	DESCRIPTION
id	O	Product identifier.
ProductCharacteristic	O	Lists the product characteristics.
Order	O	Orders are included if the order has reached the state and substate Acknowledged/Received, and has not passed the state Service Given.
SiteInformationInteractionItemDetails	O	Site inventory items.

Product - ProductCharacteristic Elements

The following table describes the ProductCharacteristic elements

NAME	INPUT/OUTPUT	DESCRIPTION
ONT_ID	O	Identifier of the ONT that the product is using.
ATA_PORT	O	ATA port.
PORT_NUMBER	O	Port Number of the ATA port that the product is using.
UNI_PORT	O	UNI port
PORT_NUMBER	O	Port Number of the UNI port the product is using.
FAMILY_TYPE	O	Family of related products.
OFFER_TYPE	O	Type of offer.
OWNED_BY_RSP	O	Flag to indicate if the requesting customer owns the product.

Product - ProductCharacteristic - FAMILY_TYPE

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

VALUE	DESCRIPTION
BITSTREAM	Fibre to the premises
CSE	Customer Servic

Product - ProductCharacteristic - 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 - ProductCharacteristic - OWNED_BY_RSP

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

VALUE	DESCRIPTION
Y	Product is owned by the requesting customer.
N	Product is NOT owned by the requesting customer.

Order Elements

The order elements contain Order header information. The following table describes the Order elements

NAME	INPUT/OUTPUT	DESCRIPTION
id	O	Order identifier.
type	O	Type of order.
OrderItem	O	Contains details of the order items.

Order - OrderItem Elements

The OrderItem elements contain details of the Order items. The following table describes the OrderItem elements.

NAME	INPUT/OUTPUT	DESCRIPTION
id	O	Order item identifier.
action	O	Type of action to be performed.
state	O	Used to manage the order progress.
substate	O	Used to manage the order progress against each state.
Timing	O	Timing information for order items.

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 - state and substate

Orders are managed using status and sub-status. The status changes as the order progresses and when scoping and installation work is carried out. Not all statuses apply to all orders.

The following table describes the values provided by the state and associated substate elements.

STATEVALUE	SUBSTATEVALUE	DESCRIPTION
Acknowledged	Received	The order has been received by Chorus.
	Accepted	The order has been checked and is accepted for provisioning.
In Progress	Consent Required	Consent is required before this order can be progressed.
	Consent Requested	Consent has been requested.
	Consent Not Required	It has been determined that consent is not required for this order
	Consent Gained	Consent has been gained.
	Consent Declined	The consent request has been declined, or it was not obtained within the required time.
	Generate Quotation	A quote is being generated for the order.
	Intent to Cancel	Chorus has advised the intent to cancel the order and provided a reason for the cancellation.
	Network Design	The network design is currently in progress.
	Network Build	The network build is currently in progress.
	Scoping Scheduled	Scoping for this order has been scheduled.
	Scheduled	The order install has been scheduled.
	Investigation Required	Identified as a potential multi-dwelling unit (MDU) or right of way (ROW). Investigation is required.
Held	Waiting on Quote Acceptance	A quote has been created and is ready for your acceptance.
	Schedule Scoping	Scoping for this order is to be scheduled.
	Schedule Install	You now need to schedule the required installation date
	Intent to Cancel	Chorus has advised the intent to cancel the order and provided a reason for the cancellation.
	Provider to Advise	You need to provide information to Chorus before the order can progress.
	Pending Disconnect Acceptance
Service Given	Service Given	Installation work is now complete. The end-user should now be able to use the service at their location.
Completed	Billing	Billing is now complete
Closed	Rejected	The order has been rejected.
	Cancelled	The order has been cancelled and closed.
	Completed	The order has been completed and closed.

Note: An order is placed in the Held stage when we are waiting for an action to be completed by you

Order - OrderItem - Timing Elements

The timing details are provided where they are available. In most cases, this is once the values have been set, it may also be dependent on other order lifecycle scenarios.

The following table describes the Timing elements.

NAME	CARDINALITY	INPUT/OUTPUT	DESCRIPTION
name		o	Description of the dateTime value.
dateTime		o	Date and time value.

Date and time values use the xsd:dateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00]

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.

SiteInformationInteractionItemDetail Elements

The following table describes the SiteInformationInteractionItemDetail elements.

NAME	CARDINALITY	INPUT/OUTPUT	DESCRIPTION
ONT_ID		O	ONT Identifier.
ONT_STATUS		O	Status of the ONT.

SiteInformationInteractionItemDetail - ONT_STATUS

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

Note: if an ONT is not installed, the ONT_STATUS value is NULL, and the element is not returned in the response.

VALUE	DESCRIPTION
INTACT	ONT is installed at the location.

Query Site Information Request Details

Service Name

QuerySiteInformationRequest

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

Message Handling Specifications

NAME	QUERYSITEINFORMATIONREQUEST
MEP	Synchronous call with Acknowledgement.
Inputs	Query site information for a location
Outputs	Synchronous Acknowledgement
Non-Repudiation	Yes.
Description	Initiates a transaction to query site information.

Query Site Information Response Details

Service Name

QuerySiteInformationResponse

Service Outputs

If a valid Place id was provided, the response will contain the Place id and the site information, as shown in the following table.

FOR EACH

INFORMATION RETURNED

Active product

Product Details

Product id

Family type

Offer type

UNI port configuration

ATA port configuration

RSP Owned

ONT Details

ONT ID
ONT Status

In-flight Orders

Order Details

Order type
Order status
Order scheduling details
Order action
Product id

ONT Details

ONT ID
UNI port configuration
ATA port configuration

The ONT ID is included if the order has reached the state and substate of Acknowledged/Accepted, and has not been closed.

ONT installed with no active products and no inflight orders

ONT Details

ONT ID
ONT Status

Message Handling Specifications

NAME	QUERYSITEINFORMATIONRESPONSE
MEP	Synchronous call with Acknowledgement.
Inputs	Response to your query of site information for a location.
Outputs	Synchronous Acknowledgement.
Non-Repudiation	Yes.
Description	Query site information is processed or has an exception.

Fibre Ordering

Create Order Notification

Getting Started Architecture Processes Web services Help & support FAQs

Back

We use this B2B notification to advise you that we have created an order on your behalf.

Related Business Process

Related Product

This service is available for fibre products.

Order Elements

The order elements contain Order header information. The following table describes the Order elements.

NAME	OUTPUT	DESCRIPTION
id	Always	Order identifier returned by Query Order Feasibility.
BillingInformation	Conditional	Order billing details.
customerReferenceId	Conditional	Your unique orderreference number for matching this order to yourrecords.
type	Always	Type of order
OrderItem	Always	Details of the order items.

Order - OrderItem Elements

The OrderItem elements contain details of the Order items. The following table describes the OrderItem elements.

NAME	OUTPUT	DESCRIPTION
id	Always	Order item identifier.
action	Conditional	Type of action to be performed.
ExistingProviderDetail	Conditional	Existing provider and product details.
Timing	Conditional	Date for service activity.
Place	Conditional	Provide site access details.Order - OrderItem - action

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

VALUE

DESCRIPTION

new

Creates or connects a new product for the customer.

Note: this includes moves and transfers.

modify

Modify or change the characteristics of an existing product.

relinquish

Relinquish or disconnect an existing product.

Order - OrderItem - ExistingProviderDetail

The ExistingProviderDetail elements contain details of the existing provider (RSP) and the product being replaced. The following table describes the values provided by the ExistingProviderDetail element.

VALUE	DESCRIPTION
productId	The product identifier for the product being replaced by the successful completion of the order.
existingProviderName	Chorus system name for the customer who owns the product that is being replaced.

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 - 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 andlocation.
Modify Attribute	Modification of product attributes of an existing product instance.
Modify Attribute	Order a CSE for an existing product instance.
Move Primary	Move your existing offer to a property where there is no existing primary product offer at the location. Note: If consent is required at the new address you will need to complete Disconnect and Connect orders instead of a Move.
Move Additional ONT	Add an additional ONT as part of the move.
Move and Replace	New Connection for a primary product offer and disconnection of an existing customer product offer at a different location. Where there is an existing primary product offer at this location, which must be disconnected, and replaced by your incoming order. This order type is used when your end-customer is moving in to a property and assuming ownership.
Transfer Primary	Transfer of an existing primary product offerfrom another RSP to the Gaining (requesting) Service provider – for the same end customer and location.
Transfer Secondary	Transfer of an existing secondary product offerfrom another RSPto the Gaining (requesting) Service provider – for the same end customer and location.

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 - OrderItem - Place Elements

The Place elements provide the location and equipment access information. The following table describes the Place element.

NAME	OUTPUT	DESCRIPTION
id	Always	Location identifier.
Access	Conditional	Free text field to enter site access information.
EquipmentLocation	Conditional	Free text field to guidance on the location for the equipment installation.

Notification Element

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 that may be returned by the CreateOrderNotification Notification - type element.

VALUE	DESCRIPTION
INTENT_TO_DISCONNECT_SECONDARY	Theprimaryproducthasbeendisconnected, we provide you with the option of promoting your secondary product or accepting the disconnection.
CEASE_BILLING	Your end customer has transferred their product to another RSP. We advise your product disconnection.
INTENT_TO_DISCONNECT_ABANDONMENT	A new end customer is moving the location. We advise you of the intent to disconnection your product.

Notification - NotificationItem

The following table provides details of the NotificationItem elements.

VALUE

DESCRIPTION

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.

INTENT_TO_DISCONNECT_SECONDARY

Order Item State and Substate

The following table provides the OrderItem state and substate associated with the CreateOrderNotification - Notification - type - INTENT_TO_DISCONNECT_SECONDARY.

ORDERITEM	VALUE
state	Held
substate	Provider To Advise

NotificationItem

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

VALUE	DESCRIPTION
description	Chorus has created a customer order on your behalf to disconnect a secondary product instance
reference	/CreateOrderNotification/Order/id[text()='ORDER_ID']
description	Your secondary product instance is scheduled for disconnection
reference	/CreateOrderNotification/Order/OrderItem/ProductOffering/Product/id[text='*************']
description	State transition
reference	/CreateOrderNotification/Order/OrderItem/state[text()='Current state']
description	Sub-state transition
reference	/CreateOrderNotification/Order/OrderItem/substate[text()='Current substate']
description	Please refer to the following customer order question
reference	/CreateOrderNotification/Order/OrderItem/Question/id[text='QUESTION_ID']../questionValue/text()
description	A response is required by
reference	/CreateOrderNotification/Order/OrderItem/Question/id[text='QUESTION_ID']/validFor/endDateTime/text()

CEASE_BILLING

The following table provides the OrderItem state and substate associated with the CreateOrderNotification - Notification - type - CEASE_BILLING.

ORDERITEM	VALUE
state	Closed
substate	Completed

Notification Item

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

VALUE	DESCRIPTION
description	We have received a request to transfer ${product_offer} Product ID ${product_instance}. Billing for this connection will cease from ${rfs_date}.

INTENT_TO_DISCONNECT_ABANDONMENT

The following table provides the OrderItem state and substate associated with the CreateOrderNotification - Notification - type - INTENT_TO_DISCONNECT_ABANDONMENT.

ORDERITEM	VALUE
state	Held
substate	Provider To Advise

Notification Item

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

VALUE	DESCRIPTION
description	Chorus has created a customer order on your behalf to disconnect a primary customer product instance
reference	/CreateOrderNotification/Order/id[text()='ORDER_ID']
description	Your primary product instance is scheduled for disconnection
reference	/CreateOrderNotification/Order/OrderItem/Product/id
description	State transition
reference	/CreateOrderNotification/Order/OrderItem/state
description	Sub-state transition
reference	/CreateOrderNotification/Order/OrderItem/substate
description	Please refer to the following customer order question
reference	/CreateOrderNotification/Order/OrderItem/Question/questionValue
description	A response is required by
reference	/CreateOrderNotification/Order/OrderItem/Question/validFor/endDateTime

Create Order Notification Details

Service Name

CreateOrderNotification

Service Outputs

Notifications contain the notification values, Order details.

Fibre Ordering

Query Order Feasibility

Getting Started Architecture Processes Web services Help & support FAQs

Back

This B2B service allows you to query a location and determine if a product offer can be provisioned or if changes can be made to existing product(s).

Related Product

This service is available for fibre products.

The data elements and attributes that may be used by this service are described below.

Order Elements

The order elements contain Order header information. The following table describes the Order elements.

NAME	CARDINALITY	INPUT/OUTPUT	DESCRIPTION
id		O	Identifier for the order (this value will be reused as the Order id).
type	Mandatory	I/O	Type of order.
OrderItem	Mandatory	I/O	Details of the order items.

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 andlocation.
Modify Attribute	Modification of product attributes of an existing product instance.
Modify Attribute	Order a CSE for an existing product instance.
Move Primary	Move your existing offer to a property where there is no existing primary product offer at the location. Note: If consent is required at the new address you will need to complete Disconnect and Connect orders instead of a Move.
Move Additional ONT	Add an additional ONT as part of the move.
Move and Replace	New Connection for a primary product offer and disconnection of an existing customer product offer at a different location. Where there is an existing primary product offer at this location, which must be disconnected, and replaced by your incoming order. This order type is used when your end-customer is moving in to a property and assuming ownership.
Transfer Primary	Transfer of an existing primary product offerfrom another RSP to the Gaining (requesting) Service provider – for the same end customer and location.
Transfer Secondary	Transfer of an existing secondary product offerfrom another RSPto the Gaining (requesting) Service provider – for the same end customer and location.

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		O	Order item identifier.
action	Mandatory	I/O	Type of action to be performed.
Place	Mandatory	I/O	Location details.
Timing		O	Timing information for order items.
ExistingProviderDetail	Conditional	I/O	Existing provider and product details.
ProductOffering	Conditional	I/O	Chorus catalogue product offering details.
Product	Conditional	I/O	Product details.

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

The following table describes the Place element.

VALUE	DESCRIPTION
id	Primary key for address or location. The Place id is commonly referred to as: The Supplier Location ID or The Location Code (TLC).

Order - OrderItem - Timing Elements

The following table describes the Timing elements.

NAME	CARDINALITY	INPUT/OUTPUT	DESCRIPTION
name		O	Description of the dateTime value.
dateTime		O	Date and time value.

Date and time values use the xsd:dateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00].

Order - OrderItem - Timing - name

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

VALUE	DESCRIPTION
ORDER_DATE	Date and time of the order feasibility request.

Order - OrderItem - ExistingProviderDetail

The ExistingProviderDetail elements contain details of the existing provider (RSP) and product being replaced. The following table describes the values provided by the ExistingProviderDetail element.

VALUE	DESCRIPTION
productId	Product identifier for the product being replaced by the successful completion of the order.
existingProviderName	Chorus system name for the customer who owns of the product that is being replaced.

Order - OrderItem - ProductOffering

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

VALUE	DESCRIPTION
id	Chorus catalogue product offering identifier.
name	Chorus catalogue product offering name.

Order - OrderItem - Product

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

VALUE	DESCRIPTION
id	Product identifier.

OrderFeasibilityResult Elements

The following table describes the OrderFeasibilityResult elements.

NAME	CARDINALITY	INPUT/OUTPUT	DESCRIPTION
id		O	Identifier for OrderFeasibilityResult.
ValidFor		O	Start and end dates for the period the order feasibility is valid.

OrderFeasibilityResult - ValidFor

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

VALUE	DESCRIPTION
startDateTime	Start date and time of the period that order feasiblity is valid.
endDateTime	End date and time of the period that order feasiblity is valid.

Date and time values use the xsd:dateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00].

The ValidFor period calculation is based on the classification of the order contents shown in the following table.

CLASSIFICATION	VALIDFOR
Family Type == Bitstream	5 days.
Family Type == CSE	30 days.

Note: Where there are multiple classifications within a single order feasibility request, the shortest period will be applied.

OrderFeasibilityResult - OrderFeasibilityResultItem Elements

The following table describes the OrderFeasibilityResultItem elements.

NAME	INPUT/OUTPUT	DESCRIPTION
id	O	Identifier for the OrderFeasibilityResultItem.
FEASIBILITY_CODE	O	Feasibility reason code.
FEASIBILITY_REASON	O	Describes why the order is or is not feasible.
DEMAND_POINT_TYPE	O	Describesthedwellingorsituation at the address.
INSTALL_TYPE	O	Type of installation expected to be required.
CONSENT_REQUIRED	O	Flag to indicate if consent is required.
DESIGN_REQUIRED	O	Flag to indicate if design is required.
BUILD_REQUIRED	O	Flag to indicate if a build is required.
AVAILABILITY_STATUS	O	Describes the fibre avaiability status at the address.
DATA_HANDOVER_ID	O	Data handover ID(s) for this location. All available handover IDs are returned. This applies to all order types except Disconnect Primary and Disconnect Secondary.
VOICE_HANDOVER_ID	O	ATA Voice handover ID(s) for this location. All available handover IDs are returned. This applies to all order types except Disconnect Primary and Disconnect Secondary.
AVAILABLE_RFS_DATES	O	An array of RFS Dates available for completion of the order. Returned for orders that do not require a site visit.

OrderFeasibilityResultItem - OrderFeasibilityResultItemDetail - FEASIBILITY_CODE

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

VALUE	DESCRIPTION
999	Placing the order will require manual activity by Chorus, it is not feasible in its current state.
998	The order is feasible and can be submitted to initiate provisioning.
997	Closed, the feasibility check shows that placing the order is not possible.
996	This reason code would not be returned by the web service.

OrderFeasibilityResultItem - OrderFeasibilityResultItemDetail - FEASIBILITY_REASON

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

Note: as shown in the table, not all FEASIBILITY_CODE values have a corresponding FEASIBILITY_REASON.

VALUE	FEASIBILITY_CODE
Order Not feasible (default reason when no specific reason exists)	999
Consentdeclined in the location.RequestManualFeasibility to proceed if required.	999
Fibre is not available in the location. Request Manual Feasibility to proceed if required.	999
Feasibility request requires manual investigation.	999
Feasible to Order (default reason when no specific reason exists)	998
Design and Build is required if Customer Order is submitted for this location.	998
Consent is required if Customer Order is submitted.	998
Feasible to Provide Service at Location.Select an appointment to proceed to Customer Order.	998
Your order is feasible at the given location, please select an RFS date	998
Hyperfibre Design and Build is required before appointment selection if Customer Order is submitted for this location.	998
Order Not Feasible (default reason when no specific reason exists)	997
Product Instance has inflight order, you will need to cancel any inflight orders against the product and try again	997
The same ONT has inflight product order, you will need to cancel any inflight orders first and then try again.	997
Replace Product Instance has inflight order, you will need to cancel any inflight orders against product and try again	997
Insufficient resources available	997
Product Instance does not exist at specified location	997
Invalid address or location	997
Customer not onboarded for requested Product Offer	997
The Product Instance provided belongs to a different customer	997
Unbundled services are not available at this location	997
Cannot transfer a Product Instance ID that already belongs to customer placing order	997
No existing instances, try Move Primary Offer	997
Aim requires an offering	997
Unknown aim / order type combination	997
Aim requires a product offering	997
Aim requires a Product Instance	997
Unknown location	997
No existing instances, try Connect Primary Offer	997
There are available ONT's or no ONT exists, try Connect Primary	997
No suitable ONT is available	997
Supplied ONT ID is not valid	997
ONT ID and TLC combination is not valid	997
Request validation failed: Primary Product Instance is not supplied or incompatible with supplied ONT ID	997
Product characteristic <Characteristic name> does not belong to product offer	997
Request validation failed: Characteristic [name: X, value: Y] out of range	997
No existing primary instance for Connect Secondary	997
Voice is not supported as a separate service when the ONT is in RGW mode, as the ATA ports are configured through the RGW service	997
Request validation failed: Primary Product Instance is not supplied	997
Contact details incorrect	997
Existing open order	997
Invalid order type	997
Invalid Product ID	997
Invalid Provider name given for Transfer	997
Invalid address or location	997
Fibre not yet available at this location	997
Invalid or non existing POI	997
Resources not available	997
Your order is not feasible. Please try again later.	997
Losing Service Provider Name is invalid.	997
Handover Connection not available	997
The current ONT mode does not support this	997
No free suitable ports are available to support this request	997
No existing primary instance for Connect Secondary	997
Feasibility has Expired. Please submit another one for this Location.	996

OrderFeasibilityResultItem - OrderFeasibilityResultItemDetail - 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 determined based on our inventory records.
SDU	Single Dwelling Unit.
Subdivision	Exists in an area of known development.
NBAP	Non-Building Access Point.

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

OrderFeasibilityResultItem - OrderFeasibilityResultItemDetail - CONSENT_REQUIRED

The following table describes the values provided by the consent required element.

VALUE	DESCRIPTION
Y	Location is an MDU or SDU on a Right of Way that does not already have consent.
N	Location either does not require consent, or already has consent.

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

OrderFeasibilityResultItem - OrderFeasibilityResultItemDetail - 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 additional build.

OrderFeasibilityResultItem - OrderFeasibilityResultItemDetail - AVAILABLE_RFS_DATES

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

Note: we intend to change this functionality, it is documented here for completeness only in it's current form. We will stop providing the list of dates and only return the AVAILABLE_RFS_DATES element.

Use Query Appointment Availability to retrieve a list of RFS dates and times.

VALUE	DESCRIPTION
AVAILABLE_CONNECT_RFS_DATE_TIME	Available RFS date and time for a connection.
AVAILABLE_DISCONNECT_RFS_DATE_TIME	Available RFS date and time for a disconnection.

Date and time values use the xsd:dateTime format: YYYY-MM-DDTHH:MM:SS+[UTC offset, e.g. 12:00].

SiteVisit Elements

TheSiteVisit ids will be listed against theirrelativeOrderItem(s) using the structure OrderItem -SiteVisitidandagainunderOrderwiththedetailsofthesitevisiti.e.Order-SiteVisit-id-type,bookable,etc.

The following table describes the SiteVisit elements.

NAME	INPUT/OUTPUT	DESCRIPTION
id	O	SiteVisit identifier. Unique id used forthe site visit required by the feasibility request. It is used in subsequent Appointmentscenarios.
bookable	O	Indicates if the site visit is bookable.
type	O	Purpose of the site visit.

SiteVisit - bookable

The bookable indicator setting is determined by the order feasibility result, the following table describes the values provided by the SiteVisit - bookable element.

VALUE

DESCRIPTION

true

Site visit appointment can be booked.

If this value is returned indicated prior to CreateOrder, it indicates that the appointment must be in a reserved condition at the time we receive the CreateOrder request.

false

Site visit appointment cannot be booked at this time.

If this value is returned prior to CreateOrder, it indicates that an appointment cannot be reserved before CreateOrder is submitted. We will use the Notification touchpoint after the order submission to request that you book appointments when required.

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.
CONNECT_RFS_DATE_TIME	Service connection dates.
DISCONNECT_RFS_DATE_TIME	Service disconnection dates.

Query Order Feasibility Request Details

Service Name

QueryOrderFeasibilityRequest

Service Inputs

The Order - type and OrderItem - Action fields are mandatory for requesting this service.

Thefollowingtableshowsthepossibleorderscenarios,thevaluesofOrder-typeandOrderItem-action fields, and the associated mandatory input criteria / fields.

SCENARIO	ORDER-TYPEVALUE	ORDERITEM-ACTION VALUE	INPUT CRITERIA	NOTES
Connect	Connect Primary	new	Product Offering id Place id	Required for each new product offering.
	Connect Additional ONT	new	Product Offering id Place id	Required for each new product offering.
	Connect Secondary	new	Product Offering id Place id	Required for each new product offering.
	Connect and Replace	new	Product Offering id Place id Existing Provider ProductId	Required for each new product offering.
Move	Move Primary	new	Product Offering id Place id	Required for each new product offering.
		relinquish	Product id
	Move Additional ONT	new	Product Offering id Place id	Required for each new product offering.
		relinquish	Product id
	Move and Replace	new	Product Offering id Place id Existing Provider ProductId	Existing provider's productId, must match an active product id in our product inventory for this location.
		relinquish	Product id
Modify	Change Offer	new	Product Offering id Place id
		relinquish	Product id
	Modify Attribute	modify	Product id	Used for modifying an existing product instance.
	Modify Attribute	modify	Product id	Used for ordering CSE by itself.
		new	Product Offering id Place id
Disconnect	Disconnect Primary	relinquish	Product id
	Disconnect Secondary	relinquish	Product id
Transfer	Transfer Primary	new	Product Offering id Existing Provider ProductId ExistingProviderName Place id	Existing Provider ProductId, must match an active product id in our product inventory for this location. ExistingProviderName must match a value in the Chorus Customer managed list.
	Transfer Secondary	new	Product Offering id Existing Provider ProductId, to be transferred ExistingProviderName Place id	Existing Provider ProductId, must match an active product id in our product inventory for this location. ExistingProviderName must match a value in the Chorus Customer managed list.

Message Handling Specifications

NAME	DESCRIPTION
MEP	Synchronous call with Acknowledgement.
Inputs	Query order feasibility for a location.
Outputs	Synchronous Acknowledgement.
Non-repudiation	Yes.
Description	Initiates a transaction to query order feasibility.

Query Order Feasibility Response Details

Service Name

QueryOrderFeasibilityResponse

Service Outputs

If valid input was provided, the response will contain the results of an order feasibility request. It will include the relevant fields from the following list:

Order ID Site
Visit information:

id
type
Bookable

Data and Voice Handover IDs
Consent status
MDU Design and Build status
Feasibility code
Feasibility reason
Demand Point Type
Available RFS Dates for selection
Expiry date and time.

Message Handling Specifications

NAME	DESCRIPTION
MEP	Synchronous call with Acknowledgement.
Inputs	Response to your query of order feasibility for a location.
Outputs	Synchronous Acknowledgement.
Non-repudiation	Yes.
Description	Query order feasibility is processed or has an exception.

Fibre Ordering

Customer Amends Order

Getting Started Architecture Processes Web services Help & support FAQs

Back

ThisB2B service allows you to request changes to selected details in your order, or respond to a question from us.

Related Business Process

BIC105: Customer Amends Order

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

The main phone number to use when calling the contact person.

Use this value if you are only providing one phone number.

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

Back

This B2Bservice allows you to request the cancellation of an inflight order and any associated site visit appointments.

Related Business Process

BIC103: Customer Cancels Order

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

Back

This B2B service allows you to retrieve a snapshot of an order belonging to you.

Related Business Process

BIC113: Customer Requests Order Information

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

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

Notification identifier.

fileAttachment

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

Subscribe to

We’ve Boosted! What this means for you

Help us improve

Fibre Ordering

B2B Exception Codes

B2B exception messages

Share

Fibre Ordering

Reserve Appointment

Order Elements

Order - SiteVisit Elements

Order - SiteVisit - type

Order - SiteVisit - AppointmentSlot Elements

Order - SiteVisit - AppointmentSlot - dateTime

Reserve Appointment Request Details

Service Name

Service Inputs

Message Handling Specifications

Reserve Appointment Response Details

Service Name

Service Outputs

Message Handling Specifications

Share

Fibre Ordering

Query Appointment Availability

Order Elements

Order - SiteVisit Elements

Order - SiteVisit - type

Order - SiteVisit - AppointmentSlot Elements

Order - SiteVisit - AppointmentSlot - dateTime

Order - SiteVisit - AppointmentSlot - Filter - FilterParameter Elements

Order - SiteVisit - AppointmentSlot - Filter - FilterParameter - TimeSlot

Order-SiteVisit-AppointmentSlot-Filter-FilterParameterVALIDATE_INTER_APPOINTMENT_LEADTIME

Query Appointment Availability Request Details

Service Name

Service Inputs

Message Handling Specifications

Query Appointment Availability Response Details

Service Name

Service Outputs

Message Handling Specifications

Share

Fibre Ordering

Order Notifications

> Order - BillingInformation Elements

> Order - BillingInformation - Charge Elements

> Order - EscalateOrder Elements

> Order - OrderItem Elements

> Order - OrderItem - Timing Elements

> Order - OrderItem - Site Visit Elements

> Notification Elements

Inform Order NotificationItem Details

> Notification - type - STATUS

> Notification - type - STATUS_WITH_NOTE

> Notification - type - MANUAL_INTERACTION

> Notification - type - REJECT_CANCEL

Amend Order NotificationItem Details

> Notification - type - ACKNOWLEDGED_ACCEPTED

> Notification - type - RFS_CONFIRMED

> Notification - type - CONSENT_REQUIRED

> Notification - type - CONSENT_REQUESTED

> Notification - type - CONSENT_GAINED

> Notification - type - CONSENT_DECLINED

> Notification - type - GENERATE_QUOTATION

> Notification - type - INTENT_TO_CANCEL

> Notification - type - IN_PROGRESS_INTENT_TO_CANCEL

-- Notification - NotificationItem

> Notification - type - NETWORK_DESIGN

> Notification - type - NETWORK_BUILD

> Notification - type - SCOPING_SCHEDULED

> Notification - type - SCHEDULED

> Notification - type - INVESTIGATION_REQUIRED

> Notification - type - QUOTE_ACCEPTANCE

> Notification - type - HELD_SCHEDULE_SCOPING

> Notification - type - HELD_SCHEDULE_INSTALL

> Notification - type - HELD_PROVIDER_TO_ADVISE

> Notification - type - HELD_PENDING_DISCONNECT_ACCEPTANCE

> Notification - type - SERVICE_GIVEN

> Notification - type - COMPLETED_BILLING

> Notification - type - CLOSED_CANCELLED

> Notification - type - CLOSED_COMPLETED