B2B Api

Level 3 Communications B2B API Spec – Order Services for Voice Products
B2B API Specification

Order Services for Voice Products
Version 4.1.0.0
Released February 16, 2008
© 2007 Level 3 Communications, LLC. All Rights Reserved. Level 3 Communications, Level 3, the
red 3D brackets and the Level 3 Communications logo are registered service marks of Level 3
Communications, LLC in the United States and/or other countries. Level 3 services are provided by
wholly owned subsidiaries of Level 3 Communications, Inc. Any other service, product or company
Page
names recited herein may be trademarks or service marks of their respective 1 of 350
owners
Foreword
This document describes the technical specifications through which Level 3 and its business
partners can conduct electronic commerce for the purpose of ordering voice products. It is
subordinate and supplemental to the Level 3 B2B Implementation Guide for Partners document.
Commercial organizations must join Level 3’s Partnership program prior to engaging in electronic
commerce, and must establish systems that conform to this specification prior to placing orders.
Thereafter, use of the electronic-commerce interface and facilities, and successful, complete
execution of specified services, creates a legally binding obligation on the part of both parties.
Due to the nature of electronic commerce and planned enhancements to products and ordering
capabilities, this document is subject to change. Level 3 reserves the right to make changes of
any nature at any time, and will distribute changes to partners as they occur.
Disclaimer
This document is intended to be a working document describing various e-commerce applications
that the parties may implement, and is subject to change by Level 3 at any time. In the event of a
conflict between the text of this document and any agreements between Partner and Level 3, the
terms set forth in the agreements shall control.
Revision History
Revision Release Date Description of Change Author

0.5 6/30/04 Draft Level 3
1.0 7/30/04 Revised to reflect stakeholder comments. Level 3
2.0 8/13/04 Added major new business transactions Level 3
and capabilities
2.1.0 9/17/2004 Revised to reflect stakeholder comments; Level 3
added incremental functionality
enhancements.
2.2.0 10/15/2004 Added incremental functionality Level 3
enhancements.
2.2.3.0 11/18/2004 Made documentation enhancements; Level 3
modified versioning notation
2.2.4.0 11/19/2004 Made WSDL and Spec changes Level 3
2.2.5.0 11/29/2004 Made changes to WSDL to ensure Level 3
backward compatibility with 2.2.3
2.2.5.1 12/17/2004 Made documentation enhancements. Level 3
2.2.5.2 12/20/2004 Made documentation enhancements. Level 3
3.0.0.0 12/20/2004 Added new functionality Level 3
Page 2 of 350
3.0.1.0 12/22/2004 Made minor WSDL and Spec changes Level 3

3.0.2.0 12/28/2004 Made minor WSDL changes Level 3
3.0.3.0 1/13/2005 Corrected WSDL error Level 3
3.1.0.0 5/1/2005 Added new functionality and Level 3
enhancements to existing capabilities
3.1.0.1 6/7/2005 Added incremental functionality Level 3
enhancements.
3.1.0.2 7/5/2005 Added transaction description for Reserve Level 3
TN and Release TN
3.1.0.3 8/22/2005 Added clarification to transaction Level 3
descriptions and attribute descriptions
3.3.0.0 6/17/2006 Added CSR Request transaction and new Laura Maxwell
attributes to existing transactions
3.3.0.1 7/10/2006 Added clarification to text Laura Maxwell
4.0.0.0 11/11/2006 Added multi-line LNP Install capability. Laura Maxwell
4.0.0.1 08/06/2007 Added product ID 2036 to enumeration Stephanie

values Thielen
4.1.0.0 12/03/2007 Added new functionality for 4.1 Stephanie
Thielen
Wireless LNP, Supp address
Changes by Revision
Revision Transaction / Message Change

Section
1.0 Various Various Minor updates (e.g., spelling) to achieve consistency between
WSDL, class diagrams, and attribute tables.
1.0 Various Various Enhanced attribute descriptions, defined enumerations where

appropriate, added specific datatypes, made datatypes
consistent with XSDs
1.0 Various Various Renamed businessTransactionHeader.B2BCustomerID to

businessTransactionHeader.B2BPartnerID to better describe the
attribute.
1.0 Pre-Submit Service validateSLServiceAvailability Added to validationResponseHeader the following attributes:

Availability Validation Response earliestCRD, latestCRD
(New TN)
1.0 Pre-Submit Service validateSLServiceAvailability Added to validationResponseHeader the following attributes:

Availability Validation Response earliestCRD, latestCRD
(Port-In)
1.0 Pre-Submit Portability validateSLServiceAvailability Added to validationResponseHeader the following attributes:

Validation Response earliestCRD, latestCRD
Page 3 of 350

Section
1.0 Pre-Submit Service validateSLServiceAvailability Added to portabilityAnalysisResult the following attributes:
Availability Validation Response fromLECCompanyCode, toLECCompanyCode
(Port-In)
1.0 Pre-Submit Portability validateSLServiceAvailability Added to portabilityAnalysisResult the following attributes:

Validation Response fromLECCompanyCode, toLECCompanyCode
1.0 Pre-Submit Service validateSLServiceAvailability Added rateCenter object within portabilityAnalysisResult, with
Availability Validation Response following attributes: rateCenterAbbreviation, LATA, stateCode
(Port-In)
1.0 Pre-Submit Portability validateSLServiceAvailability Added rateCenter object within portabilityAnalysisResult, with
Validation Response following attributes: rateCenterAbbreviation, LATA, stateCode
1.0 Submit New Install createSLOrder Removed from customerProfileDefaultOverrides the following
Order attributes: LNPNotificationEmail, OrderFullmentEmail,
customerRespForPIC
1.0 Submit New Install createSLOrder Removed from serviceOrderHeader the following attributes:
Order requestorName, requestorEmail
1.0 Submit Supplement of createSLOrder Removed from serviceOrderHeader the following attributes:
Install Order; requestorName, requestorEmail
1.0 Submit Cancel of Install createSLOrder Removed from serviceOrderHeader the following attributes:
1.0 Submit New Disconnect createSLOrder Removed from serviceOrderHeader the following attributes:
1.0 Submit Cancel of createSLOrder Removed from serviceOrderHeader the following attributes:
Disconnect Order requestorName, requestorEmail
1.0 Submit Cancel of Install createSLOrder Added to serviceOrderHeader the following attributes:
Order reasonCode, reasonComments.
1.0 Submit New Disconnect createSLOrder Added to serviceOrderHeader the following attributes:
Order reasonCode, reasonComments.
1.0 Submit Cancel of createSLOrder Added to serviceOrderHeader the following attributes:

Disconnect Order reasonCode, reasonComments.
1.0 Submit New Install postSLOrderStatus Added to subscriberLine the following attributes:
Order fromLECCompanyCode, toLECCompanyCode (LNP Orders only)
1.0 Submit New Install createSLOrder Modified subscriberLine such that CNAM attributes (CNAM,
Order blockCNAM, block3rdParty, blockCollect) are managed as a
separate object. These attributes are replaced by a reference
(CNAMInformation) to a new object containing those attributes
1.0 Submit New Install createSLOrder Removed object PICInformation and subscriberLine reference to
Order PICInformation.
1.0 Submit New Install createSLOrder Removed billingAddress object and subscriberSite reference to
Order billingAddress.
1.0 Submit Cancel of Install createSLOrder Removed from serviceOrderHeader attribute CRD
Order
1.0 Submit Cancel of createSLOrder Removed from serviceOrderHeader attribute CRD

Disconnect Order
1.0 Submit New Install postSLOrderStatus Added to subscriberLine the following attributes:
1.0 Submit Supplement of postSLOrderStatus Added to subscriberLine the following attributes:

Install Order; fromLECCompanyCode, toLECCompanyCode (LNP Orders only)
1.0 Submit Cancel of Install postSLOrderStatus Added to subscriberLine the following attributes:
1.0 Submit New Disconnect postSLOrderStatus Added to subscriberLine the following attributes:
1.0 Submit Cancel of postSLOrderStatus Added to subscriberLine the following attributes:

Disconnect Order fromLECCompanyCode, toLECCompanyCode (LNP Orders only)
Page 4 of 350

Section
1.0 Submit New Install postSLOrderStatus Added rateCenter object within portabilityAnalysisResult, with
Order following attributes: rateCenterAbbreviation, LATA, stateCode
1.0 Submit Supplement of postSLOrderStatus Added rateCenter object within portabilityAnalysisResult, with
Install Order; following attributes: rateCenterAbbreviation, LATA, stateCode
1.0 Submit Cancel of Install postSLOrderStatus Added rateCenter object within portabilityAnalysisResult, with
1.0 Submit New Disconnect postSLOrderStatus Added rateCenter object within portabilityAnalysisResult, with
1.0 Submit Cancel of postSLOrderStatus Added rateCenter object within portabilityAnalysisResult, with
Disconnect Order following attributes: rateCenterAbbreviation, LATA, stateCode
2.0 Reserve TN n/a Added new business transaction
2.0 Read Order n/a Added new business transaction
2.0 Read Service Image n/a Added new business transaction
2.0 Provide Status n/a Added new business transaction

Notification
2.0 Pre-Submit Service validateSLServiceAvailability Added new capability to specify quantity of TNs to return for
Availability Validation selection and hold. This is supported by the new attributes added
(New TN) to validationHeader object: returnTNQuantityForSelection and
externalOrderID.
2.0 Pre-Submit Service validateSLServiceAvailability Added new capability to return 0 or more TNs with related
Availability Validation Response rateCenter information to support requests for list of TNs for
(New TN) selection and hold. This is supported by the new attributes within
validationResponseHeader: listOfTNsHeldForSelection,
expirationDateTime, as well as the new objects TNResult,
RateCenter, and WTN may be conditionally returned by this
transaction.
2.0 Submit New Install createSLOrder Added new capability to Non-LNP order to install specified TN
Order after validating against reservations.
2.0 Pre-Submit Service validateSLServiceAvailability Removed redundant attribute LNPIndicator from

Availability Validation validationHeader.
(New TN)
2.0 Pre-Submit Service validateSLServiceAvailability Changed name of portabilityAnalysisResult object to TNResult to

Availability Validation Response better reflect its new generalized purpose.
(Port-In)
2.0 Pre-Submit Portability validateSLServiceAvailability Changed name of portabilityAnalysisResult object to TNResult to

Validation Response better reflect its new generalized purpose.
2.0 Pre-Submit Service validateSLServiceAvailability Added new class diagram

Availability Validation Response
(New TN)
2.0 Pre-Submit Service validateSLServiceAvailability Added new class diagram

(Port-In)
2.0 Pre-Submit Portability validateSLServiceAvailability Added new class diagram

Validation Response
2.0 Submit New Install postSLOrderStatus Added new class diagram

Order
2.0 Submit Supplement of postSLOrderStatus Added new class diagram

Install Order;
2.0 Submit Cancel of Install postSLOrderStatus Added new class diagram

Order
2.0 Submit New Disconnect postSLOrderStatus Added new class diagram

Order
2.0 Submit Cancel of postSLOrderStatus Added new class diagram

Disconnect Order
Page 5 of 350

Section
2.0 Various Various Added optional errorContext attribute to error object to clarify the
source of the error
2.0 Submit New Install postSLOrderStatus Added notificationHeader object with notificationType and
Order dateTime attributes to clarify context of status notification.
2.0 Submit Supplement of postSLOrderStatus Added notificationHeader object with notificationType and
Install Order; dateTime attributes to clarify context of status notification.
2.0 Submit Cancel of Install postSLOrderStatus Added notificationHeader object with notificationType and
2.0 Submit New Disconnect postSLOrderStatus Added notificationHeader object with notificationType and
2.0 Submit Cancel of postSLOrderStatus Added notificationHeader object with notificationType and
Disconnect Order dateTime attributes to clarify context of status notification.
2.0 WSDL Listing n/a Consolidated 3 separate WSDLs into one WSDL
2.0 Error Codes n/a Added several new error codes
2.0 Success Codes n/a Broke out success codes from error code section into new
success codes section
2.0 Schema Listings n/a Added new schemas to reflect addition of new transactions
2.0 Schema Listings n/a Consolidated separate request and response schemas into one.
2.1 Various requestMessageHeader Removed responseURL, since it is to be maintained in a new

Partner Management System. In a related change,
businessTransactionHeader.B2BPartnerID and
validationHeader.B2BPartnerID are to be redefined to
correspond to a partner profile within the Partner
ManagementSystem, where partner profile corresponds to a
target environment. This is where an environment-specific
responseURL will be maintained.
2.1 Provide CSR n/a Added new business transaction

Notification
2.1 Various Various Added externalBusinessTransactionID to all messages
2.1 Various Various Removed externalBusinessTransactionVersion from all

messages
2.1 Pre-Submit Service validateSLServiceAvailability Removed productID from TNResult

(New TN)
2.1 Pre-Submit Service validateSLServiceAvailability Removed productID from TNResult

(Port-In)
2.1 Pre-Submit Portability validateSLServiceAvailability Removed productID from TNResult

Validation Response
2.1 Submit New Install createSLOrder Removed endNum from WTN

Order
2.1 Reserve TN reserveTN Removed endNum from WTN
2.1 Various postSLOrderStatus Renamed rateCenter.stateCode to state
2.1 Various validateSLServiceAvailability Renamed rateCenter.stateCode to state

Response
2.1 Various Various Changed error.errorCode datatype from integer to string(20).
2.1 Various Various Changed requestStatusMessage.code datatype from number to

string(20).
2.1 Submit New Disconnect CreateSLOrder Removed directoryListingInformation class and

Order subscriberLine.directoryListingInformation attribute.
2.1 Submit New Install CreateSLOrder Removed directoryListingInformation.listingAddress

Order
Page 6 of 350

Section
2.1 Read Order ReadOrderResponse Removed directoryListingInformation.listingAddress
2.1 Read Service Image ReadServiceImageResponse Removed directoryListingInformation.listingAddress
2.1 Submit New Install CreateSLOrder Removed customerProfileDefaultOverrides and corresponding

Order attributes
2.1 n/a n/a Added order lifecycle state transition diagram to cover non-LNP /
new TN scenarios.
2.1 n/a n/a Added order lifecycle state transition diagram to cover LNP
scenarios.
2.1 n/a n/a Consolidated separated WSDL and XSD files into one WSDL file.
2.1 Various Various Replaced ErrorCode, RequestStatus, and

RequestStatusMessage objects with ResultCode in Output,
Input-callback and Output-callback messages
2.1 Various Various Replaced references to ErrorCode (e.g. listOfErrorCodes) with

references to ResultCode (e.g. listOfResultCodes)
2.1 Various Various Add originalMessageID attribute to responseMessageHeader for

all Input-callback messages. This will help ensure a consistent
means for partner to correlate async callbacks for all async
business transactions.
2.1 Submit New Install createSLOrder, Added externalOrderVersion to serviceOrderHeader

Order postSLOrderStatus
2.1 Submit Supplement of createSLOrder, Added externalOrderVersion to serviceOrderHeader

Install Order; postSLOrderStatus
2.1 Submit Cancel of Install createSLOrder, Added externalOrderVersion to serviceOrderHeader

2.1 Submit New Disconnect createSLOrder, Added externalOrderVersion to serviceOrderHeader

2.1 Submit Cancel of createSLOrder, Added externalOrderVersion to serviceOrderHeader

Disconnect Order postSLOrderStatus
2.1 Read Order readOrder Added externalOrderVersion to serviceOrderHeader
2.1 Read Order readOrderResponse Added externalOrderVersion to serviceOrderHeader
2.1 Various postSLOrderStatus Added externalOrderVersion to serviceOrderHeader
2.1 Pre-Submit Service validateSLServiceAvailability Removed externalOrderID

Availability Validation
(New TN)
2.1 Reserve TN reserveTN Removed externalOrderID
2.1 Release TN n/a Added new transaction

Reservation
2.1 n/a n/a Redefined correlation between list of TNs generated and held by
Service Availability Validation, Reserve TN, and Submit New
Install Order transactions to be performed using
externalBusinessTransactionID values, instead of
externalOrderID.
2.1.1 Submit New Install createSLOrder Changed parameter element name from createSLOrderRequest
Order to createSLOrder
2.1.1 Submit Supplement of createSLOrder Changed parameter element name from createSLOrderRequest
Install Order; to createSLOrder
2.1.1 Submit Cancel of Install createSLOrder Changed parameter element name from createSLOrderRequest
2.1.1 Submit New Disconnect createSLOrder Changed parameter element name from createSLOrderRequest
2.1.1 Submit Cancel of createSLOrder Changed parameter element name from createSLOrderRequest
Disconnect Order to createSLOrder
Page 7 of 350

Section
2.2 Create New Install createSLOrder Added TPVPVN attribute to LNPInformation
Order
2.2 Read Order readOrderResponse Added TPVPVN attribute to LNPInformation
2.2 Various Various Made responseMessageHeader.organization optional
2.2 Various Various Made responseMessageHeader.department optional
2.2 Various Various Made responseMessageHeader.application optional
2.2 Provide Customer postSLOrderStatus Moved CSRInformation from subscriberLine to

Service Record (CSR) serviceOrderHeader.
Notification
2.2.1 Provide Customer postSLOrderStatus Added WTN to CSRInformation

Service Record (CSR)
Notification
2.2.2 Provide Order Status postSLOrderStatus Documentation change: ResultCode only required for error
Notification notifications. Not applicable otherwise.
2.2.3.0 N/A N/A Added version attribute to <xsd:schema> element in WSDLs to

simplify sync-up with specification docs.
2.2.3.0 Title Page N/A Changed version to 4 levels: A.B.W.S, where A.B corresponds to
the namespace version, W denotes to the WSDL version (see
<xsd:schema version=”A.B.W”>), and S is the Specification
version.
2.2.3.0 Various Various Clarified resultCode class description to state how many
resultCode instances are expected upon success and error
conditions.
2.2.3.0 Error Codes N/A Updated error codes
2.2.3.0 Various Various Corrected case of orderAction and orderType enumeration

values. Should be Init-cap (e.g. Install, not install).
2.2.4.0 Pre-Submit Service validateSLServiceAvailability Removed userID from requestMessageHeader; No longer used,
Availability Validation but API will still accept value.
(New TN)
2.2.4.0 Pre-Submit Service validateSLServiceAvailability Removed userID from requestMessageHeader; No longer used,
Availability Validation but API will still accept value.
(Port-In)
2.2.4.0 Pre-Submit Portability validateSLServiceAvailability Removed userID from requestMessageHeader; No longer used,
Validation but API will still accept value.
2.2.4.0 Pre-Submit Service validateSLServiceAvailability Changed ExpirationDateTime to ReservationExpirationDateTime

(New TN)
2.2.4.0 Reserve TN reserveTN Changed name of ServiceOrderHeader object to

ReservationHeader
2.2.4.0 ReserveTN reserveTN Moved WTN reference from SubscriberLine to ListOfWTNs from
ReservationHeader
2.2.4.0 ReserveTN reserveTN Removed SubscriberLine object
2.2.4.0 ReserveTN reserveTNResponse Added ReservationHeader object (required, 1-1 with respect to
BusinessTransactionHeader)
2.2.4.0 ReserveTN reserveTNResponse Made ResultCode a child of ReservationHeader
2.2.4.0 ReserveTN reserveTNResponse Added ListOfWTNs as a child of ReservationHeader
2.2.4.0 Submit New Install createSLOrder Added BTN to ServiceOrderHeader

Order
2.2.4.0 Read Order readOrderResponse Added BTN to ServiceOrderHeader
2.2.4.0 Submit New Install createSLOrder Removed BTN from SubscriberLine; No longer used, but API will
Order still accept value.
Page 8 of 350

Section
2.2.4.0 Read Order readOrderResponse Removed BTN from SubscriberLine
2.2.4.0 Read Service Image readServiceImageResponse Removed BTN from SubscriberLine
2.2.4.0 Submit Supplement of createSLOrder Removed PartnerSubgroupID from ServiceOrderHeader; No

Install Order; longer used, but API will still accept value.
2.2.4.0 Submit Cancel of Install createSLOrder Removed PartnerSubgroupID from ServiceOrderHeader; No

Order longer used, but API will still accept value.
2.2.4.0 Submit New Disconnect createSLOrder Removed PartnerSubgroupID from ServiceOrderHeader; No

2.2.4.0 Submit Cancel of createSLOrder Removed PartnerSubgroupID from ServiceOrderHeader; No

Disconnect Order longer used, but API will still accept value.
2.2.4.0 Submit Supplement of createSLOrder Removed LEVEL3ParentOrderID from ServiceOrderHeader; No

Install Order; longer used, but API will still accept value.
2.2.4.0 Submit Cancel of Install createSLOrder Removed LEVEL 3ParentOrderID from ServiceOrderHeader; No
2.2.4.0 Submit Cancel of createSLOrder Removed LEVEL 3ParentOrderID from ServiceOrderHeader; No

Disconnect Order longer used, but API will still accept value.
2.2.5.0 Submit New Install createSLOrder Removed BTN from ServiceOrderHeader

Order
2.2.5.0 Read Order readOrderResponse Removed BTN from ServiceOrderHeader
2.2.5.0 Submit New Install createSLOrder Restored BTN to SubscriberLine.

Order
2.2.5.0 Read Order readOrderResponse Restored BTN to SubscriberLine
2.2.5.0 Read Service Image readServiceImageResponse Restored BTN to SubscriberLine
2.2.5.0 Pre-Submit Service validateSLServiceAvailability Changed ReservationExpirationDateTime to ExpirationDateTime

(New TN)
2.2.5.1 Submit New Install N/A Added clarification text to introduce Sample Usage diagram.
Order
2.2.5.1 Submit Supplement of N/A Added clarification text to introduce Sample Usage diagram.
Install Order;
2.2.5.1 Submit Cancel of Install N/A Added clarification text to introduce Sample Usage diagram.
Order
2.2.5.1 Submit New Disconnect N/A Added clarification text to introduce Sample Usage diagram.
Order
2.2.5.1 Submit Cancel of N/A Added clarification text to introduce Sample Usage diagram.
Disconnect Order
2.2.5.1 Result Codes N/A Updated result codes
2.2.5.1 Read Order N/A Updated description to note transaction only valid for B2B orders
2.2.5.1 Read Service Image N/A Updated description to note transaction only valid for B2B orders
2.2.5.1 Provide Customer N/A Updated description to note CSR Notification is only sent only if
Service Record (CSR) Donor LEC issues porting exception
Notification
2.2.5.1 N/A N/A Updated LNP state transition diagram to note CSR Notification is
only sent only if Donor LEC issues porting exception.
2.2.5.2 Submit New Install createSLOrder Removed Block3rdParty and BlockCollect from
Order CNAMInformation. Change should not impact existing partner
code, since submitted values for these attributes will be
unconditionally overwritten with Y by Level 3.
2.2.5.2 Submit New Disconnect createSLOrder Changed default ReasonCode valid value “Customer Initiated” to
Order “Channel Partner Init.” Added 2 new values: “CustInit Chg Srvc.”,
“MSAG ERROR”. These new values apply only to Submit New
Page 9 of 350

Section
Disconnect Order. “Channel Partner Init.” Is the only valid value
for ReasonCode in other transactions.
3.0.0.0 Submit New Change N/A Added new transaction

Order
3.0.0.0 Submit Cancel of N/A Added new transaction

Change Order
3.0.0.0 Submit New Install createSLOrder Moved LNPInformation reference from SubscriberLine to
Order ServiceOrderHeader
3.0.0.0 Read Order readOrderResponse Moved LNPInformation reference from SubscriberLine to

ServiceOrderHeader
3.0.0.0 Submit New Install createSLOrder Removed BTN from SubscriberLine

Order
3.0.0.0 Read Order readOrderResponse Removed BTN from SubscriberLine
3.0.0.0 Read Service Image readServiceImageResponse Removed BTN from SubscriberLine
3.0.0.0 Submit New Install createSLOrder Added BTNOldCarrier to LNPInformation

Order
3.0.0.0 Read Order readOrderResponse Added BTNOldCarrier to LNPInformation
3.0.0.0 Submit New Change postSLOrderStatus Added OrderSummary object and ListOfOrderSummary
Order reference to this object in SubscriberLine.
3.0.0.0 Read Order readOrderResponse Added OrderSummary object and ListOfOrderSummary

reference to this object in SubscriberLine.
3.0.0.0 Pre-Submit Service validateSLServiceAvailability Changed ExpirationDateTime to ReservationExpirationDateTime

(New TN)
3.0.0.0 Read Order readServiceImageResponse Removed Block3rdParty and BlockCollect from

CNAMInformation
3.0.0.0 Read Service Image readServiceImageResponse Removed Block3rdParty and BlockCollect from
CNAMInformation
3.0.1.0 Submit New Install postSLOrderStatus Renamed OrderSummary.text attribute to changeType

Order
3.0.1.0 Read Order readOrderResponse Renamed OrderSummary.text attribute to changeType
3.0.1.0 Reserve TN reserveTNResponse Changed resultCode cardinality to 1..1
3.0.1.0 Submit New Install createSLOrder Removed duplicate orderType attribute documentation from
Order message parameters section
3.0.1.0 Submit New Change createSLOrder Added orderType to message parameters section.
Order
3.0.1.0 Reserve TN reserveTN Added missing WTN attributes to message parameters section
3.0.1.0 Reserve TN reserveTNResponse Added missing WTN attributes to message parameters section
3.0.1.0 Reserve TN reserveTNResponse Added missing Result Code attributes to message parameters
section
3.0.1.0 WSDL Listings N/A Restructured to include references to annotated and non-
annotated WSDLs for both Level 3 and Partner-side WSDLs.
3.0.2.0 Release TN releaseTN Removed releaseTN.serviceOrderHeader from WSDL. Does not

Reservation impact documentation.
3.0.3.0 Submit Supplement of N/A Changed intro text. Level 3® VoIP Enhanced Local supps apply
Install Order; only to LNP (not New TN).
3.0.3.0 Read Order readOrderResponse orderSummary object contains object of type listOfChangeTypes,
not changeType
3.0.3.0 Submit New Change postSLOrderStatus orderSummary object contains object of type listOfChangeTypes,
Order not changeType
Page 10 of 350

Section
3.0.3.0 Reserve TN N/A Removed business transaction
3.0.3.0 Release TN N/A Removed business transaction

Reservation
3.0.3.0 Enumeration Values N/A ChangeType value “Service Package” applies only to certain
products.
3.0.3.0 Result Codes N/A Updated result codes
3.1.0.0 Pre-Submit Service validateSLServiceAvailability Added concatenatedAddress to address object and removed
Availability Validation notParsedAddressFlag.
(New TN)
3.1.0.0 Pre-Submit Service validateSLServiceAvailability Added concatenatedAddress to address object and removed
Availability Validation notParsedAddressFlag.
(Port-In)
3.1.0.0 Submit New Install createSLOrder Added concatenatedAddress to address object and removed
Order notParsedAddressFlag.
3.1.0.0 Submit New Install createSLOrder Updated servicePackage to be a required attribute for all
Order products.
3.1.0.0 Submit New Install createSLOrder Added customerServiceName to subscriberLine object.

Order
3.1.0.0 Submit Supplement of createSLOrder Added LNPInformation object

Install Order;
3.1.0.0 Submit Supplement of createSLOrder Added subscriberLine object

Install Order;
3.1.0.0 Submit Supplement of createSLOrder Added WTN object

Install Order;
3.1.0.0 Submit Supplement of createSLOrder Added CNAMInformation object

Install Order;
3.1.0.0 Submit Supplement of createSLOrder Added subscriber object

Install Order;
3.1.0.0 Submit Supplement of postSLOrderStatus Added orderSummary to subscriberLine object

Install Order;
3.1.0.0 Submit Supplement of postSLOrderStatus Added orderSummary object

Install Order;
3.1.0.0 Submit Supplement of postSLOrderStatus Added suppType object

Install Order;
3.1.0.0 Read Order readOrder Added flexibleAttribute object
3.1.0.0 Read Order readOrderResponse Added reasonCode to serviceOrderHeader object
3.1.0.0 Read Order readOrderResponse Added reasonComments to serviceOrderHeader object
3.1.0.0 Read Order readOrderResponse Added customerServiceName to subscribeLine object
3.1.0.0 Read Order readOrderResponse Added concatenatedAddress to address object
3.1.0.0 Read Order readOrderResponse Added orderSummary object
3.1.0.0 Read Order readOrderResponse Added suppType object
3.1.0.0 Read Order readOrderResponse Added jeopardyInformation object
3.1.0.0 Read Order readOrderResponse Added csrInformation object
3.1.0.0 Read Order readOrderResponse Added featureFlag object
3.1.0.0 Read Service Image readServiceImageResponse Added concatenatedAddress to address object
3.1.0.0 Provide Order Status postSLOrderStatus Added customerServiceName to subscribeLine object

Notification
Page 11 of 350

Section
3.1.0.0 Provide Order Status postSLOrderStatus Added orderSummary object
Notification
3.1.0.0 Provide Order Status postSLOrderStatus Added LNPInformation object

Notification
3.1.0.0 Provide Order Status postSLOrderStatus Added jeopardyInformation object

Notification
3.1.0.0 Provide Order Status postSLOrderStatus Added CSRInformation object

Notification
3.1.0.0 Provide Order Status postSLOrderStatus Added featureFlag object

Notification
3.1.0.0 Provide Order Status postSLOrderStatus Added changeType object

Notification
3.1.0.0 Provide Order Status postSLOrderStatus Added suppType object

Notification
3.1.0.0 Submit New Change createSLOrder Added directoryListingInformation object

Order
3.1.0.0 Submit New Change createSLOrder Added concatenatedAddress to address object and removed
Order notParsedAddressFlag.
3.1.0.0 Submit Real-Time Port N/A Added new business transaction

Request
3.1.0.0 Provide Level3 Action N/A Added new business transaction

Notification
3.1.0.1 Introduction N/A Added scope clarification in section 1.2.1
3.1.0.1 Pre-Submit Service validateSLServiceAvailability Added customerServiceName to validationHeader

(New TN)
3.1.0.1 Pre-Submit Service validateSLServiceAvailability Added customerServiceName to validationHeader

(Port-In)
3.1.0.1 Pre-Submit Portability validateSLServiceAvailability Added customerServiceName to validationHeader

Validation
3.1.0.2 Reserve TN reserveTN Added transaction description to document
reserveTNResponse
3.1.0.2 Release TN releaseTN Added transaction description to document
releaseTNResponse
3.1.0.3 All Transactions N/A Added expected results to transaction description.
3.1.0.3 Various Various Clarified messageID description to state partner is required to

keep this value unique
3.1.0.3 Various Various Clarified userID description to state that field is logged but not
returned to partner.
3.1.0.3 Various Various Clarified externalBusinessTransactionID description to state that

partner is required to keep this value unique per new order life-
cycle transaction.
3.1.0.3 Various Various Clarified returnTNQuantityforSelection description to state that

attribute is utilized for HomeTone only.
3.1.0.3 Various Various Clarified customerServiceName description.
3.1.0.3 Various Various Clarified serviceAvailable description to state when ‘Y’ will be
returned vs. ‘N.”
3.1.0.3 Various Various Clarified reservationExpirationDateTime description to state that

attribute is utilized for HomeToneSM only.
Page 12 of 350

Section
3.1.0.3 Various Various Clarified listOfResponseAddresses description to state when
Level 3 will return this list.
3.1.0.3 Various Various Changed portable description to state that this attribute is not
currently in use.
3.1.0.3 Various Various Clarified businessName description.
3.1.0.3 Various Various Clarified firstName description.
3.1.0.3 Various Various Changed middleInitial description to state that this attribute is
currently not in use.
3.1.0.3 Various Various Clarified lastName description.
3.1.0.3 Various Various Clarified CTI description.
3.1.0.3 Various Various Clarified LEVEL 3SubscriberLineID to state when attribute will be
returned to partner.
3.1.0.3 Submit New Install postSLOrderStatus Added missing attributes to attribute table: businessName,
Order firstName, lastName, CTI, CNAMInformation, and
directoryListingInformation.
3.1.0.3 Supplement of Install createSLOrder Added missing attribute to attribute table: LEVEL 3ParentOrderID
Order
Clarified CTI description to state it is required if supplementing
subscriber name.
3.1.0.3 Supplement of Install postSLOrderStatus Added missing attribute to attribute table: legalBinder,
Order serviceAddress, endNum, CNAMInformation, and
3.1.0.3 Submit Cancel of Install createSLOrder Added missing attribute to attribute table: LEVEL 3ParentOrderID
Order
3.1.0.3 Submit Cancel of Install postSLOrderStatus Added missing attributes to attribute table: legalBinder,
Order serviceAddress, endNum, CNAMInformation, and
3.1.0.3 Submit New Disconnect postSLOrderStatus Added missing attributes to attribute table: reasonCode,
Order FOCDate, billStopDate
3.1.0.3 Submit New Change createSLOrder Clarified descriptions for subscriber, businessName, firstName,
Order middleInitial, lastName, serviceAddress, servicePackage,
CNAMInformation, directoryListingInformation, and type to state
when they are required for change orders.
3.2.0.0 Pre-Submit Service validateSLServiceAvailability Added E911Option to ValidationHeader object.

(New TN) Added TNLocationInformation object.
3.2.0.0 Pre-Submit Service validateSLServiceAvailability Added E911CoverageIndicator, GITNIndicator, and

Availability Validation Response E911Disclaimer to ValidationResponseHeader object.
(New TN)
3.2.0.0 Pre-Submit Service validateSLServiceAvailability Added E911Option to ValidationHeader object.

(Port-In)
3.2.0.0 Pre-Submit Service validateSLServiceAvailability Added E911CoverageIndicator, GITNIndicator, and

Availability Validation Response E911Disclaimer to ValidationResponseHeader object.
(Port-In)
3.2.0.0 Pre-Submit Portability N/A This transaction will not be supported for this version or future
Validation versions, but will still be supported for previous versions.
3.2.0.0 Submit New Install createSLOrder Added E911Option to ServiceOrderHeader object.

Order
Added TNLocationInformation object.
3.2.0.0 Submit New Install postSLOrderStatus Added E911Disclaimer, E911Option, GITNIndicator, and
Order E911CoverageIndicator to ServiceOrderHeader object.
3.2.0.0 Provide Order Status postSLOrderStatus Added E911Disclaimer, E911Option, GITNIndicator, and
Notifications E911CoverageIndicator to ServiceOrderHeader object.
Page 13 of 350

Section
3.2.0.0 Read Order readOrderResponse Added E911Option to ServiceOrderHeader object.
3.2.0.0 Read Service Image readServiceImageResponse Added E911Option to ServiceOrderHeader object.
3.2.1.0 Pre-Submit Service validateSLServiceAvailability Added flexibleAttribute object.

(Port-In)
3.2.1.0 Submit New Change createSLOrder Added ability to change E911Option.

Order
3.2.1.0 Submit New Change createSLOrder Added ability to change serviceAddress to a different rate center.
Order
3.2.1.0 Submit New Change postSLOrderStatus Added text for a directory listing disclaimer within E911Disclaimer
Order attribute.
3.2.1.0 Read Order readOrderResponse Added new enumeration value for changeName attribute.
3.3.0.0 Request CSR requestCSR New transaction.
3.3.0.0 Pre-Submit Service validateSLServiceAvailability Added LNPOption object.

(Port-In) Added InternalPortFlag to TNResult object.
3.3.0.0 Read Order ReadOrderResponse Added InternalPortFlag and LECResponseDate attributes to

ServiceOrderHeaderObject.
Added LNPEvents object and LNPOption object.
3.3.0.1 Scope Text change only. Added text to clarify scope of Directory Listing
change functionality.
Submit New Change createSLOrder
Order
4.0.0.0 Install Order (LNP) createSLOrder Added the ability to port multiple WTNs associated with one BTN.
postSLOrderStatus
4.0.0.0 Install Order (LNP) createSLOrder Changed all attributes beginning with ‘L3’ to ‘Level3’.
Install Order (New TN) postSLOrderStatus
Supplement of Install readOrder

Order (LNP)
readOrderResponse
Cancel of Install Order
(LNP) readServiceImage
Change Order readServiceImageResponse
Cancel of Change portTN

Order
portTNResponse
Read Order
Read Service Image

Real-Time Port Request
4.0.0.0 Install Order (New TN) createSLOrder Changed required value format for
directoryListingInformation.firstName when dualNameListing = Y.
Change Order
Format changed from ‘John and Jane’ to ‘John & Jane’.
4.0.0.1 Various Added Product ID to Enumeration value table. Clarified Product

ID value description for various transactions
4.1.0.0 Various Release Date Feb 16, 2008
4.1.0.0 Install Order (LNP) createSLOrder Added Wireless LNP functionality description
4.1.0.0 Holidays Holiday listing Added list of observed holidays for 2008
4.1.0.0 Various Various Added Local Inbound service
4.1.0.0 Various Various Removed portDirection, as it is no longer required
Page 14 of 350
Contents
REFERENCED DOCUMENTATION ..................................................................................................................... 19
1 INTRODUCTION ....................................................................................................................................... 20
1.1 OVERVIEW ................................................................................................................................................................................................. 20
1.2 SCOPE ........................................................................................................................................................................................................ 20
1.2.1 Functionality included in this release..................................................................................................20
1.3 KEY TERMS ............................................................................................................................................................................................... 21
2 USAGE SCENARIOS AND IMPLEMENTATION .............................................................................................. 22
2.1 OVERVIEW OF SUPPORTED BUSINESS TRANSACTIONS ............................................................................................................................. 22
2.2 BUSINESS TRANSACTION DETAILS ........................................................................................................................................................... 28
2.2.1 Service Availability Validation (New TN)...................................................................................................29
2.2.1.1 Sample Usage................................................................................................................................................... 30
2.2.1.2 Class Diagrams ................................................................................................................................................ 31
2.2.1.2.1 validateSLServiceAvailability Element ..................................................................................................... 31
2.2.1.2.2 validateSLServiceAvailabilityResponse Element ...................................................................................... 32
2.2.1.3 Input Message Parameters - validateSLServiceAvailability ............................................................................ 33
2.2.1.4 Output Message Parameters - validateSLServiceAvailabilityResponse........................................................... 37
2.2.2 Service Availability Validation (LNP) .................................................................................................46
2.2.2.1 Sample Usage................................................................................................................................................... 47
2.2.2.2 Class Diagrams ................................................................................................................................................ 48
2.2.2.2.1 validateSLServiceAvailability Element ..................................................................................................... 48
2.2.2.2.2 validateSLServiceAvailabilityResponse Element ...................................................................................... 49
2.2.2.3 Input Message Parameters - validateSLServiceAvailability ............................................................................ 50
2.2.2.4 Output Message Parameters - validateSLServiceAvailabilityResponse........................................................... 54
2.2.3 Install Order (New TN)........................................................................................................................60
2.2.3.1 Sample Usage................................................................................................................................................... 62
2.2.3.1.1 Install Order – New TN.............................................................................................................................. 62
2.2.3.2 Class Diagrams ................................................................................................................................................ 63
2.2.3.2.1 createSLOrder Element .............................................................................................................................. 63
2.2.3.2.2 createSLOrderResponse Element............................................................................................................... 64
2.2.3.2.3 postSLOrderStatus Element ....................................................................................................................... 65
2.2.3.2.4 postSLOrderStatusResponse Element ........................................................................................................ 66
2.2.3.3 Input Message Parameters - createSLOrder ..................................................................................................... 67
2.2.3.4 Output Message Parameters - createSLOrderResponse ................................................................................... 77
2.2.3.5 Input Callback Message Parameters – postSLOrderStatus............................................................................... 78
2.2.3.6 Output Callback Message Parameters - postSLOrderStatusResponse ............................................................. 86
2.2.4 Install Order (LNP) .............................................................................................................................88
2.2.4.1 Sample Usage................................................................................................................................................... 90
2.2.4.1.1 Install Order - LNP .................................................................................................................................... 90
2.2.4.2 Class Diagrams ................................................................................................................................................ 91
2.2.4.2.1 createSLOrder Element .............................................................................................................................. 91
2.2.4.2.2 createSLOrderResponse Element............................................................................................................... 92
2.2.4.2.3 postSLOrderStatus Element ....................................................................................................................... 93
2.2.4.2.4 postSLOrderStatusResponse Element ........................................................................................................ 94
2.2.4.3 Input Message Parameters - createSLOrder ..................................................................................................... 95
2.2.4.4 Output Message Parameters - createSLOrderResponse ................................................................................. 104
2.2.4.5 Input Callback Message Parameters – postSLOrderStatus............................................................................. 104
2.2.4.6 Output Callback Message Parameters - postSLOrderStatusResponse ........................................................... 112
2.2.5 Supplement of Install Order (LNP)....................................................................................................113
2.2.5.1 Sample Usage................................................................................................................................................. 116
2.2.5.1.1 Supp – Scenario 1 .................................................................................................................................... 116
2.2.5.1.2 Supp – Scenario 2 .................................................................................................................................... 117
2.2.5.2 Class Diagrams .............................................................................................................................................. 118
2.2.5.2.1 createSLOrder Element ............................................................................................................................ 118
2.2.5.2.2 createSLOrderResponse Element............................................................................................................. 119
2.2.5.2.3 postSLOrderStatus Element ..................................................................................................................... 120
2.2.5.2.4 postSLOrderStatusResponse Element ...................................................................................................... 121
Page 15 of 350
2.2.5.3 Input Message Parameters – createSLOrder .................................................................................................. 122

2.2.5.5 Input Callback Message Parameters - postSLOrderStatus ............................................................................. 127
2.2.5.6 Output Callback Message Parameters – postSLOrderStatusResponse........................................................... 134
2.2.6 Cancel of Install Order (LNP) ...........................................................................................................136
2.2.6.1 Sample Usage................................................................................................................................................. 138
2.2.6.1.1 Cancel – Scenario 1.................................................................................................................................. 138
2.2.6.1.2 Cancel – Scenario 2.................................................................................................................................. 139
2.2.6.2 Class Diagrams .............................................................................................................................................. 140
2.2.6.3 Input Message Parameters - createSLOrder ................................................................................................... 144
2.2.7 Disconnect Order...............................................................................................................................155
2.2.7.1 Sample Usage................................................................................................................................................. 157
2.2.7.2 Class Diagrams .............................................................................................................................................. 158
2.2.8 Cancel of Disconnect Order ..............................................................................................................172
2.2.8.1 Sample Usage................................................................................................................................................. 173
2.2.8.2 Class Diagrams .............................................................................................................................................. 174
2.2.9 Change Order ....................................................................................................................................186
2.2.9.1 Sample Usage................................................................................................................................................. 188
2.2.9.2 Class Diagrams .............................................................................................................................................. 189
2.2.10 Cancel of Change Order....................................................................................................................209
2.2.10.1 Sample Usage ............................................................................................................................................ 210
2.2.10.2 Class Diagrams .......................................................................................................................................... 211
2.2.10.2.1 createSLOrder Element .......................................................................................................................... 211
2.2.10.2.2 createSLOrderResponse Element........................................................................................................... 212
2.2.10.2.3 postSLOrderStatus Element ................................................................................................................... 213
2.2.10.2.4 postSLOrderStatusResponse Element .................................................................................................... 214
2.2.10.3 Input Message Parameters - createSLOrder............................................................................................... 215
2.2.10.4 Output Message Parameters - createSLOrderResponse ............................................................................. 216
2.2.10.5 Input Callback Message Parameters - postSLOrderStatus......................................................................... 217
Page 16 of 350
2.2.10.6 Output Callback Message Parameters - postSLOrderStatusResponse ....................................................... 221

2.2.11 Read Order ........................................................................................................................................223
2.2.11.1 Sample Usage ............................................................................................................................................ 224
2.2.11.2 Class Diagrams .......................................................................................................................................... 225
2.2.11.2.1 readOrder Element ................................................................................................................................. 225
2.2.11.2.2 readOrderResponse Element .................................................................................................................. 226
2.2.11.3 Input Message Parameters - readOrder ...................................................................................................... 227
2.2.11.4 Output Message Parameters - readOrderResponse .................................................................................... 229
2.2.12 Read Service Image ...........................................................................................................................242
2.2.12.1 Sample Usage ............................................................................................................................................ 243
2.2.12.2 Class Diagrams .......................................................................................................................................... 244
2.2.12.2.1 readServiceImage Element..................................................................................................................... 244
2.2.12.2.2 readServiceImageResponse Element...................................................................................................... 245
2.2.12.3 Input Message Parameters - readServiceImage ......................................................................................... 246
2.2.12.4 Output Message Parameters - readServiceImageResponse........................................................................ 247
2.2.13 Real-Time Port Request .....................................................................................................................255
2.2.13.1 Sample Usage ............................................................................................................................................ 256
2.2.13.2 Class Diagrams .......................................................................................................................................... 257
2.2.13.2.1 portTN Element...................................................................................................................................... 257
2.2.13.2.2 portTNResponse Element ...................................................................................................................... 258
2.2.13.3 Input Message Parameters - portTN .......................................................................................................... 259
2.2.13.4 Output Message Parameters - portTNResponse......................................................................................... 261
2.2.14 CSR Request.......................................................................................................................................264
2.2.14.1 Sample Usage ............................................................................................................................................ 265
2.2.14.2 Class Diagrams .......................................................................................................................................... 266
2.2.14.2.1 requestCSR ............................................................................................................................................ 266
2.2.14.2.2 requestCSRResponse ............................................................................................................................. 267
2.2.14.2.3 postCSR ................................................................................................................................................. 268
2.2.14.2.4 postCSRResponse .................................................................................................................................. 269
2.2.14.3 Input Message Parameters - requestCSR ................................................................................................... 270
2.2.14.4 Output Message Parameters – requestCSRResponse................................................................................. 274
2.2.14.5 Input Callback Message Parameters – postCSR ........................................................................................ 275
2.2.14.6 Output Callback Message Parameters - postCSRResponse ....................................................................... 280
2.2.15 Order Status Notifications .................................................................................................................283
2.2.15.1 Sample Usage ............................................................................................................................................ 285
2.2.15.1.1 New TN Install....................................................................................................................................... 285
2.2.15.1.2 LNP Install ............................................................................................................................................. 286
2.2.15.1.3 Disconnect.............................................................................................................................................. 287
2.2.15.2 Class Diagrams .......................................................................................................................................... 288
2.2.15.3 Input Message Parameters – postSLOrderStatus ....................................................................................... 290
2.2.15.4 Output Message Parameters - postSLOrderStatusResponse ...................................................................... 301
2.2.16 CSR Notification ................................................................................................................................303
2.2.16.1 Sample Usage ............................................................................................................................................ 304
2.2.16.1.1 LNP Install ............................................................................................................................................. 304
2.2.16.2 Class Diagrams .......................................................................................................................................... 305
2.2.16.3 Input Message Parameters - postSLOrderStatus........................................................................................ 307
2.2.16.4 Output Message Parameters - postSLOrderStatusResponse ...................................................................... 314
2.2.17 Level 3 Action Notification ................................................................................................................316
2.2.17.1 Sample Usage ............................................................................................................................................ 317
2.2.17.2 Class Diagrams .......................................................................................................................................... 318
2.2.17.3 Input Callback Message Parameters - postSLOrderStatus......................................................................... 321
2.2.17.4 Output Callback Message Parameters - postSLOrderStatusResponse ....................................................... 325
2.3 RESULT CODES ........................................................................................................................................................................................326
2.4 ENUMERATION VALUES ..........................................................................................................................................................................326
Page 17 of 350
2.5 WSDL LISTING .......................................................................................................................................................................................331

2.6 SCHEMA DESCRIPTIONS ..........................................................................................................................................................................332
2.6.1 validateSLServiceAvailability ............................................................................................................332
2.6.1.1 Class Diagram - validateSLServiceAvailability............................................................................................. 332
2.6.1.2 Class Diagram - validateSLServiceAvailabilityResponse.............................................................................. 333
2.6.2 createSLOrder ...................................................................................................................................334
2.6.2.1 Class Diagram – createSLOrder..................................................................................................................... 334
2.6.2.2 Class Diagram – createSLOrderResponse...................................................................................................... 335
2.6.3 postSLOrderStatus.............................................................................................................................336
2.6.3.1 Class Diagram – postSLOrderStatus.............................................................................................................. 336
2.6.3.2 Class Diagram - postSLOrderStatusResponse ............................................................................................... 337
2.6.4 readOrder ..........................................................................................................................................338
2.6.4.1 Class Diagram – readOrder ............................................................................................................................ 338
2.6.4.2 Class Diagram – readOrderResponse............................................................................................................. 339
2.6.5 readServiceImage ..............................................................................................................................340
2.6.5.1 Class Diagram – readServiceImage ............................................................................................................... 340
2.6.5.2 Class Diagram – readServiceImageResponse ................................................................................................ 341
2.6.6 portTN................................................................................................................................................342
2.6.6.1 Class Diagram – portTN ................................................................................................................................ 342
2.6.6.2 Class Diagram – portTNResponse ................................................................................................................. 343
2.6.7 requestCSR ........................................................................................................................................344
2.6.7.1 Class Diagram – requestCSR ......................................................................................................................... 344
2.6.7.2 Class Diagram – requestCSRResponse .......................................................................................................... 345
2.6.7.3 Class Diagram – postCSR.............................................................................................................................. 346
2.6.7.4 Class Diagram – postCSRResponse............................................................................................................... 347
3 APPENDICES ........................................................................................................................................ 348
3.1 GLOSSARY ...............................................................................................................................................................................................348
3.2 HOLIDAY LISTING ....................................................................................................................................................................................350
3.3 FORM FOR REVIEW COMMENTS ..............................................................................................................................................................350
Page 18 of 350
Referenced Documentation
Documentation Title Author URL

Specification Basic Profile 1.0 WS-I http://www.ws-i.org/Profiles/BasicProfile-1.0-2004-04-16
Page 19 of 350
1 Introduction
1.1 Overview
This document describes an Application Programming Interface (API) to enable electronic commerce
between Level 3 and its business partners. It defines the technical design and implementation of Level 3’s
order services for voice products and largely reflects design, implementation and deployment approaches
that conform to WS-I Basic Profile 1.0 for Web services. This document supplements the Level 3 B2B
Implementation Guide, which describes Level 3’s B2B infrastructure, standards, and operating policies.
To facilitate clarity, diagrams in this document provide multiple views of the business transactions and
application mechanics, including overviews of business processes; interfaces, roles and responsibilities;
rules to facilitate WSDL design; and validations that are enforced on data content and format. If individual
diagrams or specifications appear to conflict, the WSDL documents provide the definitive description and
take precedence over other specifications.
This guide is written expressly for a technical audience who is familiar with e-commerce practices and the
jargon of the telecom industry. The services described in this document are available for use by
confirmed Level 3 partners. Please note that certain contractual stipulations, such as credit checks, may
pertain to some Level 3 partners and may affect the behavior of some transactions.
1.2 Scope
The document applies to Level 3’s suite of order services for voice services delivered in February 2008.
These services include business transactions for order validation and submission relating to Level 3®
VoIP Enhanced Local Level 3® Local Inbound.
Services and capabilities that are planned for future phases of the B2B implementation include order
entry for additional voice services, order management, and multiple services or voice lines on a single
order.
1.2.1 Functionality included in this release

This API provides the following capabilities:
Install Orders
• Local Number Portability and new telephone numbers (non-LNP)
• Single telephone number per order
• Port multiple TNs belonging to the same billing TN on the same order
• Supplement (Supp) Customer Request Date, Billing Telephone Number (BTN), Customer Type
Indicator (CTI), and Subscriber Name, with ability to supp CNAM at the same time
• Order cancellation
• Initiate real-time port requests
• Geographically Independent Telephone Numbers (GITN)
Disconnect Orders
• Disconnect a single TN
• Cancellation of a prior disconnection request
• Notification of successful TN deprovisioning with bill stop date
Page 20 of 350
Change Orders
• Change of CNAM information on an existing service
• Change of Directory Listing information on an existing service
• Change of Service Address for an existing service within the same rate center
• Change of E-911 option on an existing service
• Change of Service Address to a different rate center when E-911 option allows
• Change of subscriber’s Service Package on an existing service
Other Services
• Validate subscriber address for an order pre-submit
• Validate subscriber address and TN portability for an order pre-submit
• Read information for specific in-flight order
• Read information for specific completed order service image (TN or Subscriber Line)
• Receive post-order submit notifications for Order Installation, CSR, FOC, Order
Completion/Activation, Disconnect, and critical post-submit errors.
• Receive post-order CSR information when donor LEC can provide.
• Ability to request subscriber’s Customer Service Record (CSR) information prior to submitting an LNP
install request.
• Ability to submit LNP requests for Wireless Numbers
1.3 Key Terms
Term Description
Partner The commercial organization engaged in reselling Level 3’s services to subscribers.
Subscriber User of the products and services provided jointly by Level 3 and its partner.
TN Telephone Number.
Page 21 of 350
2 Usage Scenarios and Implementation

The business transactions, operations, message types and other relevant information for the B2B Services are outlined in the sections below.
These sections specify key details to be defined in the associated WSDL file(s). The exact structure of these files is to be resolved as part of the
implementation.
2.1 Overview of Supported Business Transactions

The following business transactions will be supported. Valid options for attributes that describe these business transactions are listed below.
• Usage Scenario: Synchronous, Asynchronous
• Message Type: Input, Output. Note that handlers for asynchronous callback messages such as postSLOrderStatus are to be
implemented by partner; message type designation (input/output) for such messages is defined from the perspective of the partner-
implemented systems.
• Message Style: Document/Literal
• Message Pattern: Query/Response, Request/Response, Request/Confirm, Information Distribution, Notification, Commercial Transaction.
Business WSDL Message

Usage Scenario Initiator Message Style Message Pattern WSDL Message Message Element
Transaction Operation Type
Pre-Submit
Service
Availability Synchronous
Validation (New
TN)
validateSLSer
Partner input document/literal Request/Response validateSLServiceAvailability validateSLServiceAvailability
viceAvailability
validateSLSer validateSLServiceAvailability validateSLServiceAvailabilityResp

Level 3 output document/literal Request/Response
viceAvailability Output onse
Pre-Submit
Service
Availability Synchronous
Validation (Port-
In)
Page 22 of 350
validateSLSer
viceAvailability

Pre-Submit
Portability Synchronous
Validation
validateSLSer
viceAvailability

Submit New
Asynchronous
Install Order
Commercial
createSLOrder Partner input document/literal createSLOrder createSLOrder
Transaction
Commercial
createSLOrder Level 3 output document/literal createSLOrderOutput createSLOrderResponse
Transaction
postSLOrderS input Commercial

Level 3 document/literal postSLOrderStatus postSLOrderStatus
tatus (callback) Transaction
postSLOrderS output Commercial

Partner document/literal postSLOrderStatusOutput postSLOrderStatusResponse
Supplement of
Asynchronous
Install Order
Commercial
Transaction
Commercial
Transaction

Page 23 of 350

Submit Cancel of
Asynchronous
Install Order
Commercial
Transaction
Commercial
Transaction


Submit New
Asynchronous
Disconnect Order
Commercial
Transaction
Commercial
Transaction


Submit New
Cancel of
Disconnect Order Asynchronous
Commercial
Transaction
Commercial
Transaction
Page 24 of 350


Read Order Synchronous
readOrder Partner input document/literal Request/Response readOrder readOrder
readOrder Level 3 output document/literal Request/Response readOrderOutput readOrderResponse
Read Service
Synchronous
Image
readServiceIm
Partner input document/literal Request/Response readServiceImage readServiceImage
age
readServiceIm
Level 3 output document/literal Request/Response readServiceImageOutput readServiceImageResponse
age
Provide Order
Synchronous
Status Notification
postSLOrderS
Level 3 input document/literal Notification postSLOrderStatus postSLOrderStatus
tatus
postSLOrderS
Partner output document/literal Notification postSLOrderStatusOutput postSLOrderStatusResponse
tatus
Provide Customer
Service Record Synchronous
(CSR) Notification
postSLOrderS
tatus
postSLOrderS
Partner output document/literal Notification postSLOrderStatusOutput postSLOrderStatusResponse
tatus
Submit New
Asynchronous
Change Order
Page 25 of 350
Commercial
Transaction
Commercial
Transaction


Submit Cancel of
Asynchronous
Change Order
Commercial
Transaction
Commercial
Transaction


Submit Real-Time
Synchronous
Port Request
portTN Partner input document/literal Request/Response portTN portTN
portTNRespon
Level 3 output document/literal Request/Response portTNOutput portTNResponse
se
Provide Level 3
Synchronous
Action Notification
postSLOrderS
tatus
postSLOrderS Partner output document/literal Notification postSLOrderStatusOutput postSLOrderStatusResponse
Page 26 of 350
tatus
CSR Request Asynchronous
Commercial
requestCSR Partner input document/literal requestCSR requestCSR
Transaction
Commercial
requestCSR Level 3 output document/literal requestCSROutput requestCSRResponse
Transaction
input Commercial
postCSR Level 3 document/literal postCSR postCSR
(callback) Transaction
output Commercial
postCSR Partner document/literal postCSROutput postCSRResponse
(callback) Transaction
Page 27 of 350
2.2 Business Transaction Details

This section describes in detail each business transaction supported by Level 3 B2B services. The following information may be provided for each
business transaction:
• Description
• Prerequisites
• Expected Results
• Sample Usage
• Process Flow
• Class Diagram
• Input Parameters
• Output Parameters.
Validations are performed in serial fashion; an error encountered at any step in this process is immediately reported, preempting subsequent
validations. This B2B interface is applicable to the VoIP Enhanced Local and Local Inbound services offered by Level 3.
General Requirements
• Partner has completed integration testing with Level 3.
• Partner is established in Level 3 systems to access B2B interface; i.e., customer profile is established and B2B access has been set up.
• Partner is set up in the Rate Center/market; i.e., partner has a completed service order for the appropriate market.
Page 28 of 350
2.2.1 Service Availability Validation (New TN)

Description
This business transaction provides a Level 3 partner with the ability to verify the availability of a new telephone number to a subscriber's specified
address.
The following messages are required for this business transactions:
o validateSLServiceAvailability – sent by partner to verify address
o validateSLServiceAvailabilityResponse – sent by Level 3 to respond with processing results
Prerequisites
Partner is set up in the rate center/market; i.e., partner has TNs allocated in appropriate market.
Expected Results
Successful validation – service is available and a TN can be assigned at a specified address.
Failed validation – see error message for reason.
Page 29 of 350
2.2.1.1 Sample Usage
Page 30 of 350
2.2.1.2 Class Diagrams
The class diagram below describes the objects involved in the WSDL messages that are exchanged as a
part of this business transaction and the relationships that exist among them.
2.2.1.2.1 validateSLServiceAvailability Element
Page 31 of 350
2.2.1.2.2 validateSLServiceAvailabilityResponse Element
Page 32 of 350
2.2.1.3 Input Message Parameters - validateSLServiceAvailability
Class Attribute Required Datatype Enumeration Description
requestMessageHeader information may be utilized by partner and

Level 3 for general purposes such as reporting and auditing. These
values are determined by the transaction initiator and are not enforced
requestMessageHeader
by Level 3 beyond datatype and optionality; however Level 3
recommends that careful consideration be given to the definition and
consistent use of these values to derive maximum benefit.
organization string (256) Code designating partner organization submitting a given message.
Code designating partner department within an organization that

department string (256)
submits a given message.
application string (256) Code designating partner application submitting a given message.
Time that message is submitted, in standard XML Schema dateTime

datatype. Format: CCYY-MM-DDThh:mm:ssZ, with T acting as a
timeStamp √ dateTime separating character between date and time. 24H time format
required. Z denotes time zone. Example: 2001-12-01T15:20:23-05:00
(where -05:00 is explicit time zone used).
Partner-generated and -managed message identifier. Same

messageID submitted in input and input-callback messages are
messageID √ string (32) returned in output and output-callback messages. Partner is required
to keep this value unique per message for correlation and auditing
purposes.
Partner user identifier. Used for Level 3 auditing purposes only. Value
userID string (32)
is logged in Level 3 systems, but is not sent back to the partner.
businessTransactionHeader
B2B Partner Identifier. Provided by Level 3 to partner after partner

√ profile is established in Level 3 systems. A partner may have multiple
B2BPartnerID string(40)
profiles active at any given point, where the URL to respond to is
defined.
Partner’s identifier for a new order life-cycletransaction, which consists

externalBusinessTransactionID √ string(40) of one or more individual business transactions or dialogues (for new,
supp, or cancel).
Page 33 of 350
Partner is required to keep this value unique for correlation and

auditing purposes. ID should begin with Partner’s initials or name (ex.
Level3_123456)
validationHeader
productID √ string(4) ProductID Level 3 identification for a service
serviceAddress √ address
The Customer Service Name is a customer-definable field that

identifies a particular IP address and routing policy. When applied to a
subscriber order, this routing information defines the IP address or
addresses to send traffic, or how to balance traffic across several IP
customerServiceName √ String(15)
addresses. The typical customer scenario involves a single Customer
Service Name definition, but multiple Customer Service Names may
be set up based on customer needs. Please contact your Account
Manager for more information on this configuration.
Specifies the 911 solution the subscriber opts to use. Valid values for
E911Option √ string(60) E911Option
E-911Option are: E911 Static, E911 VPC, E911 Customer Provided.
TNLocationInformation TNLocationInformation
Partner may specify either TNCity, TNState, and TNZip OR TNNPA

and TNNXX to request a GITN.
This information will be used to identify a rate center from which a TN
TNLocationInformation will be selected. Available NPA/NXX combinations may or may not
match what is specified in the request. This location information is
applicable to these E-911 options: E911 VPC and E911 Customer
Provided.
TNCity string(25) City
TNState string(2) State State Abbreviation
TNZip string(5) 5-digit Zip Code
Exchange portion of NADP telephone number of the form

TNNPA string(3)
NPA-NXX-XXXX
TNNXX string(3) Exchange portion of NADP telephone number of the form
Page 34 of 350
NPA-NXX-XXXX
address (serviceAddress) One address within one validation header
Street number prefix.

EXAMPLE: 25 W
streetNumPrefix string(5) Where 25W is the street number prefix for the following address
example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12,
Building 2, Suite 23A.
streetNum √ string(10) Street number
Street number suffix. Optional when StreetNum is populated.

Otherwise, ignored.
EXAMPLE: 1/2
streetNumSuffix string(4)
Where 1/2 is the street number suffix for the following address
Street directional prefix

EXAMPLE: SW
Where SW is the Street directional prefix or pre-directional for the
preDirectional string(2) Directional following address example: 25W 450 1/2 SW Camino Ramon Lane
NW, Floor 12, Building 2
Valid values: N|NE|NW|S|SE|SW|E|W
streetName √ string(44) Street Name
Street suffix (i.e. ST, PL, CT, AVE)

EXAMPLE: LN
streetSuffix string(6) StreetSuffix Where LN is the street suffix for the following address example: 25W
450 1/2 SW Camino Ramon Lane NW, Floor 12, Building 2, Suite
23A.
Street directional suffix

EXAMPLE: NW
Where NW is the Street directional suffix or post-directional for the
postDirectional string(2) Directional following address example: 25W 450 1/2 SW Camino Ramon Lane
NW, Floor 12, Building 2, Suite 23A.
room string(10) Room Designation. Distinct from Unit. Sample use: Room within a
Page 35 of 350
Unit, i.e. Room 100, Hangar A.
Floor Designation
EXAMPLE: 12
floor string(10)
Where 12 is the floor for the following address example: 25W 450 1/2
SW Camino Ramon Lane NW, Floor 12, Building 2, Suite 23A.
Building Designation
EXAMPLE: 2
building string(10)
Where 2 is building for the following address example: 25W 450 1/2
Secondary Location Description.

EXAMPLE: STE
secondaryLocationDescription string(4) LocDescriptor Where STE is the secondary location description for the following
address example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor
12, Building 2, Suite 23A.
Unit or Secondary Location Number.

EXAMPLE: 23A
unit string(10) Where 23A is the unit number for the following address example: 25W
23A.
city √ string(25) City
state √ string(2) State State Abbreviation
country √ string(25) Country. Valid value is ‘USA’.
zipCode √ string(5) 5-digit Zip Code
zipPlus4 string(4) 4-digit Zip Code extension
comments string(512)
Ability to specify an unparsed street address.

If concatenatedAddress is used be sure to populate City, State and
concatenatedAddress string(256)
Zipcode as well.
Concatenated address applicable to productID 2042 only
Page 36 of 350
2.2.1.4 Output Message Parameters - validateSLServiceAvailabilityResponse
responseMessageHeader
√ Time that message is submitted, in standard XML

timeStamp dateTime
Schema dateTime datatype.
√ Same as requestMessageHeader.messageID of
messageID string (32)
responded-to message
B2B Partner Identifier. Provided by Level 3 to partner

√ after partner profile is established in Level 3 systems.
A partner may have multiple profiles active at any
given point, where the URL to respond to is defined.
Partner’s identifier for a new order life-

cycletransaction, which consists of one or more
individual business transactions or dialogues (for new,
externalBusinessTransactionID √ string(40) supp, or cancel).
Partner is required to keep this value unique for
correlation and auditing purposes. ID should begin
with Partner’s initials or name (ex. Level3_123456)
validationHeader
(originalValidationHeader)
√ Same as validationHeader.productID of responded-to

productID string(4) ProductID
message.
address (serviceAddress) One address within one validation header.
Street number prefix.

EXAMPLE: 25 W
streetNumPrefix string(5) Where 25W is the street number prefix for the
following address example: 25W 450 1/2 SW Camino
Ramon Lane NW, Floor 12, Building 2, Suite 23A.
Page 37 of 350
Street number suffix. Optional when StreetNum is

populated. Otherwise, ignored.
EXAMPLE: 1/2
Where 1/2 is the street number suffix for the following
address example: 25W 450 1/2 SW Camino Ramon
Lane NW, Floor 12, Building 2, Suite 23A.

EXAMPLE: SW
Where SW is the Street directional prefix or pre-
preDirectional string(2) Directional directional for the following address example: 25W 450
1/2 SW Camino Ramon Lane NW, Floor 12, Building
2

EXAMPLE: LN
streetSuffix string(6) StreetSuffix Where LN is the street suffix for the following address
example: 25W 450 1/2 SW Camino Ramon Lane NW,
Floor 12, Building 2, Suite 23A.

EXAMPLE: NW
Where NW is the Street directional suffix or post-
postDirectional string(2) Directional directional for the following address example: 25W 450
2, Suite 23A.
Room Designation. Distinct from Unit. Sample use:

room string(10)
Room within a Unit, i.e. Room 100, Hangar A.
Floor Designation
EXAMPLE: 12
floor string(10) Where 12 is the floor for the following address
Page 38 of 350
EXAMPLE: 2
building string(10) Where 2 is building for the following address example:
25W 450 1/2 SW Camino Ramon Lane NW, Floor 12,

EXAMPLE: STE
Where STE is the secondary location description for
secondaryLocationDescription string(4) LocDescriptor
the following address example: 25W 450 1/2 SW
Camino Ramon Lane NW, Floor 12, Building 2, Suite
23A.

EXAMPLE: 23A
unit string(10) Where 23A is the unit number for the following

If concatenatedAddress is used be sure to populate
concatenatedAddress string(256) City, State and Zipcode as well.
Concatenated address applicable to productID 2042
only
validationResponseHeader
Page 39 of 350
Y indicates a valid matching address is found or a

valid similar address is found, no errors are returned,
and the single valid address is returned in
listOfResponseAddresses. N indicates the address is
serviceAvailable √ string(1) invalid, an error condition is generated, and 0
addresses are returned in listOfResponseAddresses.
In some cases, N will indicate that a range of similar
addresses has been found and will be returned in
listOfResponseAddresses.
Earliest customer request date for subsequent order

submission from this address, in standard XML
earliestCRD date
Schema date format. Required if serviceAvailable = Y.
Null otherwise.
Latest customer request date for subsequent order

submission from this address, in standard XML
latestCRD date
Schema date format. Required if serviceAvailable = Y.
Null otherwise.
listOfResults includes either 0 or one resultCode

listOfResultCodes listOfResultCodes
element.
listOfResponseAddresses includes 0 to many address

elements. Please note: in near-miss scenarios, one or
more candidate address records may be returned,
including a range of numbers for the streetNum
listOfResponseAddresses listOfResponseAddresses
attribute within a single address record. In such
scenarios, partner must be careful not to resubmit the
streetNum range as returned by transaction, but
instead, a street num that falls within that range.
listOfTNsHeldForSelection includes 0 to many

listOfTNsHeldForSelection listOfTNResults
TNResult elements.
Disclaimer associated with chosen E-911Option. The

specific text included is:
E911 Static: This subscriber will be activated using
√ E-911. In the event a Public Safety Answering Point is
E911Disclaimer string(1000) not E-911-enabled, your subscriber will be activated
using a permanent 911 solution to the extent
technically feasible. All 911 Services and E-911
Services provided by Level 3 are provided by Level 3
Communications, LLC and are subject to applicable
Page 40 of 350
tarrifs.
E911 VPC: Level 3 has accepted this order. Your
company is responsible for ensuring the information
for the subscriber associated with this Telephone
Number is provided to the VPC. Your subscriber will
not be provisioned with 911 service until your company
has provisioned them with your VPC.
E911 Customer Provided: Level 3 is not providing a
911 solution to this subscriber. Per the terms of your
agreement with Level 3, your company is responsible
for providing 911 to this subscriber.
Y indicates the requested E-911Option is available.

N indicates the requested E-911Option is unavailable.
E911CoverageIndicator string(7) E911CoverageIndicator
Future functionality may require the use of additional
values.
Y indicates that service address and TN location are in

different rate centers and thus require a GITN.
GITNIndicator string(1)
N indicates that service address and TN location are in
the same rate center and a GITN is not needed.
listOfResultCodes
resultCode √ resultCode
Indicator of success or failure of an overall business

resultCode transaction or specific aspect of a given business
transaction
On successful transactions, only one resultCode (the

success code) will be returned.
√ On error situations, only one resultCode is currently
code string(20)
returned; however, future functionality may support the
return of one or more codes for transactions that may
raise several exceptions.
√ Description of result code; required when resultCode is

message string(256)
present
Contextual addendum to description, clarifying the

context string(256)
source of the resultCode
Page 41 of 350
If no error is generated, a valid address is returned

that may be an exact match or a similar match to the
originalValidationHeader.serviceAddress. If an error is
listOfResponseAddresses
generated, the interface will return either 0 addresses
or a range of addresses from which a candidate may
be selected for resubmission.
responseAddress √ address
One address within one validation header. 0 to many

address (responseAddress)
within a given validationResponseHeader.
Street number prefix

EXAMPLE: 25 W

EXAMPLE: 1/2

EXAMPLE: SW
1/2 SW Camino Ramon Lane NW, Floor 12, Building 2

EXAMPLE: LN
Page 42 of 350

EXAMPLE: NW
2, Suite 23A.

room string(10)
Floor Designation
EXAMPLE: 12
EXAMPLE: 2

EXAMPLE: STE
23A.

EXAMPLE: 23A
Page 43 of 350
listOfTNResults
(listOfTNsHeldForSelection)
TNResult √ TNResult
TNResult 0 to many within a given validationResponseHeader.
listOfResultCodes includes either one error resultCode

or one success resultCode.
rateCenter √ rateCenter
listOfResultCodes

transaction

code string(20)

message string(256)
present.

context string(256)
rateCenter One to one within a given TNResult
Page 44 of 350
rateCenterAbbreviation √ string(35) Rate center abbreviation as defined in LERG
LATA √ string(5) 3- to 5-digit industry-standard integer value
Page 45 of 350
2.2.2 Service Availability Validation (LNP)

Description
This business transaction provides a Level 3 partner with the ability to verify that one or more specified telephone numbers at a specified address
can be ported to Level 3.
o validateSLServiceAvailability – sent by partner to verify address and TN portability
o validateSLServiceAvailabilityResponse – sent by Level 3 to respond with processing results
Expected Results
Successful validation – the specified telephone number at a specified address can be ported to Level 3, and the address as specified is a
valid postal address.
Failed validation – see error message for reason
Page 46 of 350
Page 47 of 350
The class diagram below describes the objects involved in the WSDL messages that are exchanged as
part this business transaction and the relationships that exist among them.
2.2.2.2.1 validateSLServiceAvailability Element
RequestMessageHeader
-MessageID
-Organization
-Department
-Application
-TimeStamp
BusinessTransactionHeader
-B2BPartnerID
-ExternalBusinessTransactionID
1
1
ValidationHeader
-ProductID
-LNPIndicator WTN
FlexibleAttr -ListOfWTNs
-NPA
-ServiceAddress
-Name -NXX
-ReturnTNQuantityForSelection
-Value 0..* 1 1 0..* -StartNum
-CustomerServiceName
-EndNum
-E911Option
-TNLocationInformation 1
-ListOfFlexibleAttrs
1 TNLocationInformation
-TNCity
0..1
-TNState
-TNZip
Address 0..1 -TNNPA
-StreetNumPrefix -TNNXX
-StreetNum
-StreetNumSuffix
-PreDirectional
-StreetName
-StreetSuffix
-PostDirectional
-Room
-Floor
-Building
-SecondaryLocationDescription
-Unit
-City
-State
-ZipCode
-ZipPlus4
-Country
-Comments
-ConcatenatedAddress
Page 48 of 350
2.2.2.2.2 validateSLServiceAvailabilityResponse Element
ResponseMessageHeader
-MessageID
-TimeStamp
1
1 BusinessTransactionHeader
OriginialValidationHeader
-B2BPartnerID
1
1
ResultCode
ValidationResponseHeader -Code
-ServiceAvailable -Message
-ListOfResultCodes 0..1 -Context
-ListOfResponseAddresses
-ListOfPortabilityAnalysisResults 0..1
-EarliestCRD 1
1 1
-LatestCRD
-E911CoverageIndicator
-GITNIndicator TNResult
-E911Disclaimer -Portable
0..* -ListOfResultCodes
1 -WTN
-FromLECCompanyCode
-ToLECCompanyCode
-RateCenter
-WirelessLNPIndicator
0..* 1 1
1 1
Address
-StreetNumPrefix RateCenter
WTN
-StreetNum -RateCenterAbbreviation
-NPA
-StreetNumSuffix -LATA
-NXX
-PreDirectional -State
-StartNum
-StreetName -EndNum
-StreetSuffix
-PostDirectional
-Room
-Floor
-Building
-Unit
-City
-State
-ZipCode
-ZipPlus4
-Country
-Comments
Page 49 of 350
2.2.2.3 Input Message Parameters - validateSLServiceAvailability
requestMessageHeader information may be utilized by partner

and Level 3 for general purposes such as reporting and auditing.
These values are determined by the transaction initiator and are
requestMessageHeader not enforced by Level 3 beyond datatype and optionality; however
Level 3 recommends that careful consideration be given to the
definition and consistent use of these values to derive maximum
benefit.
Code designating partner organization submitting a given

organization string (256)
message

submits a given message
application string (256) Code designating partner application submitting a given message
Time that message is submitted, in standard XML Schema

dateTime datatype. Format: CCYY-MM-DDThh:mm:ssZ, with T
timeStamp √ dateTime acting as a separating character between date and time. 24H time
format required. Z denotes time zone. Example: 2001-12-
01T15:20:23-05:00 (where -05:00 is explicit time zone used).

messageID √ string (32) returned in output and output-callback messages. Partner is
required to keep this value unique per message for correlation
and auditing purposes.
Partner user identifier. Used for auditing purposes only. Value is

userID string (32)
logged in Level 3 systems, but is not sent back to the partner.

√ profile is established in Level 3 systems. A partner may have
multiple profiles active at any given point, where the URL to
respond to is defined.
√ Partner’s identifier for a new order life-cycletransaction, which

externalBusinessTransactionID string(40)
consists of one or more individual business transactions or
Page 50 of 350
dialogues (for new, supp, or cancel).

auditing purposes. ID should begin with Partner’s initials or name
(ex. Level3_123456)
validationHeader
productID √ string(4) ProductID Level 3 identification for a service
LNPIndicator √ string(1) Y for LNP validation
listOfWTNs √ listOfWTNs listOfWTNs includes one to many WTN elements
The Customer Service Name is a customer-definable field that

identifies a particular IP address and routing policy. When applied
to a subscriber order, this routing information defines the IP
address or addresses to send traffic, or how to balance traffic
customerServiceName √ String(15) across several IP addresses. The typical customer scenario
involves a single Customer Service Name definition, but multiple
Customer Service Names may be set up based on customer
needs. Please contact your Account Manager for more
information on this configuration.
Specifies the 911 solution the subscriber opts to use. Valid values
E911Option √ string(60) E911Option for E-911Option are: E911 Static, E911 VPC, E911 Customer
Provided.
listOfFlexibleAttributes listOfFlexibleAttributes
listOfWTNs
WTN √ WTN
WTN One to many WTNs within a given validationHeader
NPA √ string(3)
NXX √ string(3)
Page 51 of 350
startNum √ string(4)
Used to specify a sequence of contiguous TNs to validate. Must

endNum string(4) be different from StartNum. Can be used in validation API but not
in order entry API
address (serviceAddress) One address within one validation header

EXAMPLE: 25 W

Otherwise, ignored.
EXAMPLE: 1/2

EXAMPLE: SW
preDirectional string(2) Directional following address example: 25W 450 1/2 SW Camino Ramon
Lane NW, Floor 12, Building 2

EXAMPLE: LN
streetSuffix string(6) StreetSuffix Where LN is the street suffix for the following address example:
25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building 2,
Suite 23A.

EXAMPLE: NW
postDirectional string(2) Directional
Where NW is the Street directional suffix or post-directional for
the following address example: 25W 450 1/2 SW Camino Ramon
Page 52 of 350

Room Designation. Distinct from Unit. Sample use: Room within a

room string(10)
Floor Designation
EXAMPLE: 12
floor string(10) Where 12 is the floor for the following address example: 25W 450
1/2 SW Camino Ramon Lane NW, Floor 12, Building 2, Suite
23A.
EXAMPLE: 2
building string(10) Where 2 is building for the following address example: 25W 450
1/2 SW Camino Ramon Lane NW, Floor 12, Building 2, Suite
23A.
Secondary Location Description

EXAMPLE: STE
address example: 25W 450 1/2 SW Camino Ramon Lane NW,
Unit or Secondary Location Number

EXAMPLE: 23A
unit string(10) Where 23A is the unit number for the following address example:
Suite 23A.
Page 53 of 350

If concatenatedAddress is used be sure to populate City, State
and Zipcode as well.
Concatenated address applicable to productID 2042 only.
listOfFlexibleAttributes
flexibleAttribute flexibleAttribute
flexibleAttribute
name string(80) FlexibleAttr.Name Specifies the Name for the flexible attribute Name/Value pair
value string(80) FlexibleAttr.Value Specifies the Value for the flexible attribute Name/Value pair
2.2.2.4 Output Message Parameters - validateSLServiceAvailabilityResponse
timeStamp √ dateTime Time that message is submitted, in standard XML Schema dateTime datatype.
messageID √ string (32) Same as requestMessageHeader.messageID of responded-to message
B2B Partner Identifier. Provided by Level 3 to partner after partner profile is

B2BPartnerID √ string(40) established in Level 3 systems. A partner may have multiple profiles active at any
Partner’s identifier for a new order life-cycletransaction, which consists of one or

externalBusinessTr more individual business transactions or dialogues (for new, supp, or cancel).
√ string(40)
ansactionID Partner is required to keep this value unique for correlation and auditing
purposes. ID should begin with Partner’s initials or name (ex. Level3_123456)
validationHeader
(originalValidationHeader)
Page 54 of 350
productID √ string(4) ProductID Same as validationHeader.productID of responded-to message.
listOfWTNs listOfWTNs listOfWTNs includes 0 to many WTN elements.
LNPIndicator √ string(1) Y for LNP validation
validationResponseHeader
Y indicates a valid matching address is found or a valid similar address is found,

no errors are returned, and the single valid address is returned in
√ listOfResponseAddresses. N indicates the address is invalid, an error condition is
serviceAvailable string(1)
generated, and 0 addresses are returned in listOfResponseAddresses. In some
cases, N will indicate that a range of similar addresses has been found and will
be returned in listOfResponseAddresses.
Earliest customer request date for subsequent order submission from this
earliestCRD date address, in standard XML Schema date format. Required if serviceAvailable = Y.
Null otherwise.
Latest customer request date for subsequent order submission from this address,
latestCRD date in standard XML Schema date format. Required if serviceAvailable = Y. Null
otherwise.
listOfResultCo listOfResultCodes includes either one error resultCode or one success

listOfResultCodes
des resultCode.
listOfResponseAddresses includes 0 to many address elements. Please note: in

near-miss scenarios, one or more candidate address records may be returned,
listOfResponseAdd listOfRespons including a range of numbers for the streetNum attribute within a single address
resses eAddresses record. In such scenarios, partner must be careful not to resubmit the streetNum
range as returned by transaction, but instead, a street num that falls within that
range.
listOfPortabilityAnal
TNResult listOfPortabilityAnalysisResults includes 0 to many TNResult elements.
ysisResults
listOfTNsHeldForS
TNResult listOfTNsHeldForSelection includes 0 to many TNResult elements.
election
Page 55 of 350
Disclaimer associated with chosen E-911Option. The specific text included is:
E911 Static: This subscriber will be activated using
E-911. In the event a Public Safety Answering Point is not E-911-enabled, your
subscriber will be activated using a permanent 911 solution to the extent
technically feasible. All 911 Services and E-911 Services provided by Level 3 are
provided by Level 3 Communications, LLC and are subject to applicable tarrifs.
E911Disclaimer √ string(1000) E911 VPC: Level 3 has accepted this order. Your company is responsible for
ensuring the information for the subscriber associated with this Telephone
Number is provided to the VPC. Your subscriber will not be provisioned with 911
service until your company has provisioned them with your VPC.
E911 Customer Provided: Level 3 is not providing a 911 solution to this
subscriber. Per the terms of your agreement with Level 3, your company is
responsible for providing 911 to this subscriber.

E911CoverageIndic E911CoverageI N indicates the requested E-911Option is unavailable.
string(7)
ator ndicator
Future functionality may require the use of additional values.
Y indicates that service address and TN location are in different rate centers and
thus require a GITN.
N indicates that service address and TN location are in the same rate center and
a GITN is not needed.
LNPOption
OptionValue string(50) Available based on partner profile.
One address within one validation header. 0 to many within a given

address (responseAddress)
validationResponseHeader.

EXAMPLE: 25 W
streetNumPrefix string(5)
Where 25W is the street number prefix for the following address example: 25W
450 1/2 SW Camino Ramon Lane NW, Floor 12, Building 2, Suite 23A.
Street number suffix. Optional when StreetNum is populated. Otherwise, ignored.

EXAMPLE: 1/2
Where 1/2 is the street number suffix for the following address example: 25W 450
1/2 SW Camino Ramon Lane NW, Floor 12, Building 2, Suite 23A.
Page 56 of 350

EXAMPLE: SW
Where SW is the Street directional prefix or pre-directional for the following
preDirectional string(2) Directional address example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building
2

EXAMPLE: LN
streetSuffix string(6) StreetSuffix
Where LN is the street suffix for the following address example: 25W 450 1/2 SW
Camino Ramon Lane NW, Floor 12, Building 2, Suite 23A.

EXAMPLE: NW
Where NW is the Street directional suffix or post-directional for the following
postDirectional string(2) Directional address example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building
2, Suite 23A.
Room Designation. Distinct from Unit. Sample use: Room within a Unit, i.e. Room
room string(10)
100, Hangar A.
Floor Designation
EXAMPLE: 12
floor string(10)
Where 12 is the floor for the following address example: 25W 450 1/2 SW
EXAMPLE: 2
building string(10)
Where 2 is building for the following address example: 25W 450 1/2 SW Camino

EXAMPLE: STE
secondaryLocation
string(4) LocDescriptor Where STE is the secondary location description for the following address
Description
example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building 2, Suite
23A.

unit string(10) EXAMPLE: 23A
Where 23A is the unit number for the following address example: 25W 450 1/2
Page 57 of 350
TNResult
(listOfPortabilityAnalysisResul 0 to many within a given validationResponseHeader.
ts)
Indicates whether the TN on the request is currently active on the Level 3

internalPortFlag string(1) yesNo
network. This impacts the time to port the number to the new provider.
fromLECCompany NPAC Company code of carrier from which number is to be ported. Required if
string(50)
Code serviceOrder.LNPIndicator = Y
toLECCompanyCo NPAC Company code of carrier to which number is to be ported. Required if

string(50)
de serviceOrder.LNPIndicator = Y
wirelessLNPIndicat
string(1) yesNo Indicates whether the TN on the request is wireless TN.
or
TNResult
0 to many within a given validationResponseHeader.
(listOfTNsHeldForSelection)
Indicator of success or failure of an overall business transaction or specific aspect

resultCode
of a given business transaction
Page 58 of 350
On successful transactions, only one resultCode (the success code) will be

returned.
code √ string(20) On error situations, only one resultCode is currently returned; however, future
functionality may support the return of one or more codes for transactions that
may raise several exceptions.
message √ string(256) Description of result code; required when resultCode is present.
context string(256) Contextual addendum to description, clarifying the source of the resultCode
WTN One to one within a given listOfWTNs.
NPA √ string(3)
NXX √ string(3)
endNum string(4) Can be used in validation API but not in order entry API
rateCenter One to one within a given TNResult
rateCenterAbbrevia √ string(35) Rate center abbreviation as defined in LERG

tion
Page 59 of 350
2.2.3 Install Order (New TN)

Description
This business transaction enables a Level 3 partner to submit a request for Level 3 to provide a new telephone number at the subscriber's
specified address.
o createSLOrder – sent by partner to request new TN
o createSLOrderResponse – sent by Level 3 to acknowledge receipt of partner’s request
o postSLOrderStatus – notification sent by Level 3 to notify partner with processing results and order status (see Expected Results
for all postSLOrderStatus messages for this transaction)
o postSLOrderStatusResponse – sent by partner to acknowledge receipt of Level 3’s notification
If partner chooses to implement the New TN ordering capability, implementation of the Service Availability, Change Order, and Disconnect
Order transactions are required.
If an error is generated, the order is rejected and is not persisted within the Level 3 systems, and may require further action from partner.
Submit notification (input-callback message) returns an active TN for the ordered subscriber line when no errors are encountered. At that
point, the Order is in ACCEPTED status. Once the Customer Commitment Date is set by Level 3 and sent to the partner as the FOC date
within the FOC notification, the order is moved to INSTALLED status.
Only the Submit notification is detailed for this business transaction. Other notifications will be issued throughout the course of processing
this transaction. For more information, please refer to the sample usage diagrams and the Order Status Notification section.
This transaction also supports the ability to order a Geographically Independent Telephone Number (GITN). The directory listing feature is
not available if subscriber chooses a GITN.
Prerequisites
For new TN orders, partner must be set up in the rate center/market; i.e., partner has TNs allocated in appropriate market.
Expected Results
Note: Notifications may occur in a different sequence or at the same time.
Submit notification (postSLOrderStatus message) - successful order submission
Page 60 of 350
FOC notification (postSLOrderStatus message) – expected date of order completion
Install notification (postSLOrderStatus message) - successful installation of order (service activated on Level 3 Network). For LNP Orders
this notification will indicate that Porting has completed.
Complete notification (postSLOrderStatus message) - successful completion of order, including all post-install steps such as 911
provisioning on Level 3 Network and billing commencement
Error notification (postSLOrderStatus message)
o Validation error provided in lieu of the Submit notification if order validations fail. The request is not processed in Level 3 systems.
o 911 Automatic Location Information (ALI) error provided if address cannot be validated in Master Street Address Guide (MSAG).
(may occur at any point in the order flow)
Level 3 action notification (postSLOrderStatus message)
o Will be provided if Level 3 must take proactive action on any order currently processing.
Page 61 of 350
Please note that other notifications may be issued throughout the course of processing this transaction.
For more information, please refer to the state transition diagrams and the sample usage diagrams for the
Provide Order Status Notification and Provide Customer Service Record (CSR) Notification transactions.
2.2.3.1.1 Install Order – New TN
Page 62 of 350
2.2.3.2.1 createSLOrder Element
LNPInformation
RequestMessageHeader -PortDirection
-MessageID -LOA
-Organization -LOADateTime
-Department -TPVPVN
-Application -TPVSentDateTime
-TimeStamp -BTNOldCarrier
-UserID
1 0..1
TNLocationInformation 1
-TNCity
-TNState BusinessTransactionHeader
-TNZip -B2BPartnerID WTN
-TNNPA -ExternalBusinessTransactionID
-TNNXX -NPA
-NXX
1 -StartNum
1
0..1 ServiceOrderHeader 0..1

1
-ProductID
1 -OrderAction
-OrderType
-CRD
-PartnerSubGroupID
1
FlexibleAttr -ExternalOrderID
-Comments
-Name -LNPIndicator SubscriberLine
-Value 0..* 1 -Subscriber
1..* -ServicePackage
-ListOfSubscriberLines 1
-CTI
-ExternalOrderVersion
-WTN 1
-LNPInformation
1 -DirectoryListingInformation
1 -TNLocationInformation
-CNAMInformation
-E911Option
-CustomerServiceName
-ListOfFlexibleAttrs
Subscriber
-BusinessName 1
-FirstName 0..1 1
-MiddleInitial
-LastName
-Level3SubscriberID Address DirectoryListingInformation CNAMInformation
-ExternalSubscriberId -StreetNumPrefix -TreatmentFlag -CNAM
-SubscriberSite -StreetNum -Type -BlockCNAM
-StreetNumSuffix -FirstName
1 -PreDirectional -LastName
-StreetName -DualNameListing
1 -LOA
-StreetSuffix
-PostDirectional -ListedAddressIndicator
SubscriberSite
-Room
-Level3SubscriberSiteId -Floor
-MainCallBackNumber -Building
-ServiceAddress 1 1 -SecondaryLocationDescription
-Unit
-City
-State
-ZipCode
-ZipPlus4
-Country
-Comments
Page 63 of 350
2.2.3.2.2 createSLOrderResponse Element
Page 64 of 350
2.2.3.2.3 postSLOrderStatus Element
-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-OriginalMessageID
-B2BPartnerID
-LegalBinder
1
1
NotificationHeader
-NotificationType
-DateTime
1
1
WTN
ServiceOrderHeader
-NPA
-ProductID
-NXX
-OrderAction
-StartNum
-OrderType
1 -CRD
-ExternalOrderID 0..1
-LNPIndicator
Subscriber 1
-OrderStatus
-Level3SubscriberID -Subscriber
-ExternalSubscriberId -ListOfResultCodes SubscriberLine
-SubscriberSite 1 -ListOfSubscriberLines 1..* -Level3SubscriberLineID
-ExternalOrderVersion -WTN
1
1 -Level3ParentOrderID -FromLECCompanyCode
-PartnerSubGroupID -ToLECCompanyCode
-E911Disclaimer -RateCenter
-E911Option
-GITNIndicator
1
1 1
SubscriberSite 0..* RateCenter

1
-Level3SubscriberSiteId -RateCenterAbbreviation
ResultCode -LATA
-Code -State
-Message
-Context
Page 65 of 350
2.2.3.2.4 postSLOrderStatusResponse Element
Page 66 of 350
2.2.3.3 Input Message Parameters - createSLOrder
requestMessageHeader information may be utilized by

partner and Level 3 for general purposes such as reporting
and auditing. These values are determined by the
transaction initiator and are not enforced by Level 3
beyond datatype and optionality; however Level 3
recommends that careful consideration be given to the
definition and consistent use of these values to derive
maximum benefit.

message
Code designating partner department within an

organization that submits a given message
Code designating partner application submitting a given

application string (256)
message

dateTime datatype. Format: CCYY-MM-DDThh:mm:ssZ,
√ with T acting as a separating character between date and
timeStamp dateTime
time. 24H time format required. Z denotes time zone.
Example: 2001-12-01T15:20:23-05:00 (where -05:00 is
explicit time zone used).
Partner-generated and -managed message identifier.

Same messageID submitted in input and input-callback
messageID √ string (32) messages are returned in output and output-callback
messages. Partner is required to keep this value unique
per message for correlation and auditing purposes.
Partner user identifier. Used for auditing purposes only.

userID string (32) Value is logged in Level 3 systems, but is not sent back to
the partner.
Page 67 of 350
B2B Partner Identifier. Provided by Level 3 to partner after

√ partner profile is established in Level 3 systems. A partner
may have multiple profiles active at any given point, where
the URL to respond to is defined.
Partner’s identifier for a new order life-cycletransaction,

which consists of one or more individual business
transactions or dialogues (for new, supp, or cancel).
externalBusinessTransactionID √ string(40)
Partner is required to keep this value unique for correlation
and auditing purposes. ID should begin with Partner’s
initials or name (ex. Level3_123456)
serviceOrderHeader
productID √ string(4) Level 3 identification for a service.
√ Level 3 identifier used to indicate the action an order will

orderAction string(20) OrderAction
initiate. 'Install' for new install order.
Level 3 identifier used to indicate the type of an order

orderType √ string(20) OrderType action. 'New' for New Install order. 'New' for New Change
order.
Customer Requested Date in standard XML Schema

CRD √ date dateTime datatype.
CRD must not be a weekend or holiday.
partnerSubGroupID string(60) Channel Partner's Reseller Group ID
Partner Order ID stored by Level 3 systems. Level 3 does

externalOrderID string(60) not enforce or utilize this value for any purpose other than
partner-requested reporting.
Partner Order Version stored by Level 3 systems. Level 3

externalOrderVersion string(20) does not enforce or utilize this value for any purpose other
than partner-requested reporting.
Page 68 of 350
LNPIndicator √ string(1) Y: LNP Install. N: New install.
√ One and only one subscriber included within a

subscriber subscriber
serviceOrderHeader
√ A listOfSubscriberLines includes one to many

listOfSubscriberLines listOfSubscriberLines
subscriberLines
Specifies the 911 solution the subscriber opts to use. Valid

E911Option √ string(60) E911Option values for E-911Option are: E911 Static, E911 VPC, E911
Customer Provided.
TNLocationInformation TNLocationInformation
Partner may specify either TNCity, TNState, and TNZip

OR TNNPA and TNNXX to request a GITN for a new TN.
This information will be used to identify a rate center from
which a TN will be selected. Available NPA/NXX
TNLocationInformation
combinations may or may not match what is specified in
the request. This location information is applicable to these
E-911 options: E911 VPC and E911 Customer Provided.
This information is not needed for LNP install transactions.
TNCity string(25) City
TNState string(2) State State Abbreviation
TNZip string(5) 5-digit Zip Code

TNNPA string(3)
NPA-NXX-XXXX

TNNXX string(3)
NPA-NXX-XXXX
Page 69 of 350
One and only one subscriber within a given

subscriber serviceOrderHeader. Titles are to be prepended to
firstName and suffixes are to be appended to lastName.
Required if subscriber has one or more subscriber lines

businessName string(50)
where CTI = B. Invalid if CTI = R

where CTI = R. Invalid if CTI = B
Middle initial is to be included with first name in this format:
First_M
firstName string(50) Titles are to be prepended to firstName. First + Middle +
Last less than or equal to 25 chars for LNP orders. This
restriction is imposed by LSOG repository. LSOG
mismatches are common reasons for LNP failures. To
help ensure LSOG hits, partners are advised to use
subscriber name as it appears in existing phone bills.
First + Middle + Last less than or equal to 25 chars

middleInitial string(1)
This field is currently inactive.

where CTI = R. Invalid if CTI = B.
lastName string(50)
Suffixes are to be appended to lastName. First + Middle +
Last less than or equal to 25 chars
Level 3 subscriber identifier, stored in Level 3 systems for

partner's reporting and querying purposes. If partner does
Level3SubscriberID integer not specify this value, a new subscriber record (and
identifier) is generated and returned within the
postSLOrderStatus callback message.
Partner subscriber identifier, stored in Level 3 systems for

externalSubscriberID string(50)
partner's reporting and querying purposes.
subscriberSite √ subscriberSite
Page 70 of 350
subscriberSite One and only one subscriberSite within a given subscriber
Level 3 subscriber site identifier, stored in Level 3 systems

for partner's reporting and querying purposes. Only need
to populate if installing additional service on a location. If
Level3SubscriberSiteID integer
partner does not specify this value, a new subscriber site
record (and identifier) is generated and returned within the
mainCallBackNumber string(18) Main call-back number to be used in case of Business
serviceAddress √ address See serviceAddress Class
address (serviceAddress)

EXAMPLE: 25 W
streetNumPrefix string(5) Where 25W is the street number prefix for the following
address example: 25W 450 1/2 SW Camino Ramon Lane

EXAMPLE: 1/2

EXAMPLE: SW
Where SW is the Street directional prefix or pre-directional
preDirectional string(2) Directional for the following address example: 25W 450 1/2 SW
Camino Ramon Lane NW, Floor 12, Building 2

streetSuffix string(6) StreetSuffix EXAMPLE: LN
Where LN is the street suffix for the following address
Page 71 of 350


EXAMPLE: NW
postDirectional string(2) Directional directional for the following address example: 25W 450 1/2
SW Camino Ramon Lane NW, Floor 12, Building 2, Suite
23A.
Room Designation. Distinct from Unit. Sample use: Room

room string(10)
within a Unit, i.e. Room 100, Hangar A.
Floor Designation
EXAMPLE: 12
floor string(10) Where 12 is the floor for the following address example:
EXAMPLE: 2

EXAMPLE: STE
secondaryLocationDescription string(4) LocDescriptor Where STE is the secondary location description for the

EXAMPLE: 23A
unit string(10) Where 23A is the unit number for the following address
Page 72 of 350

If concatenatedAddress is used be sure to populate City,
State and Zipcode as well.
listOfSubscriberLines
subscriberLine √ subscriberLine
1 to many subscriberLines within a given

serviceOrderHeader. Note that current release only
subscriberLine
supports one and only one subscriberLine within a given
serviceOrderHeader for this transaction.
Required field describing selected pricing plan. Service

servicePackage √ string(60) SvcPackage
package values will be provided to partner by Level 3.
Customer Type Indicator. B=Business, R=Residential
CTI √ string(1) CTI Maintained by Level 3 systems at subscriberLine level to

support home-office scenarios, where both business and
residential lines may exist.
• If serviceOrderHeader.LNPIndicator = N and
WTN is defined, this is an order for a new,
partner-specified TN. If the TN is currently
reserved, the externalBusinessTransactionID
submitted with the reservation request must
match the externalBusinessTransactionID of this
WTN WTN Submit New Install Order transaction, for this
B2BPartnerID.
WTN is not defined, this order is for a new TN
that will be determined by Level 3.
Page 73 of 350
• If serviceOrderHeader.LNPIndicator = Y and
WTN is defined, this is an LNP order.
WTN is not defined, this is not valid.
CNAMInformation CNAMInformation
directoryListingInformation directoryListingInformation
The Customer Service Name is a customer-definable field

that identifies a particular IP address and routing policy.
When applied to a subscriber order, this routing
information defines the IP address or addresses to send
traffic, or how to balance traffic across several IP
addresses. The typical customer scenario involves a
single Customer Service Name definition, but multiple
Customer Service Names may be set up based on
customer needs. Please contact your Account Manager for
more information on this configuration.
WTN
NPA √ string(3)
NXX √ string(3)
CNAMInformation
Not required if BlockCNAM = 'Y'. CNAM calculation rules

follow the Verisign convention: uppercase LASTNAME
CNAM string(15)
FIRSTNAME, truncated to 15 characters. Symbols and
special characters are not permitted
blockCNAM √ string(1)
directoryListingInformation
Page 74 of 350
Only ‘Add’ listing treatment is supported for New TNs

scenarios.
√ Only 'Keep' and 'Remove' listing treatments are supported

treatmentFlag string(10) ListingTreatment
for port-in scenarios.
Only ‘Change’ listing treatment is supported for Change
scenarios.
Required if treatmentFlag = Add. Valid values (use

number only): 1 (List and Publish); 2 (List Only); 3 (Do Not
List or Publish)
DL is not supported for a GITN (Geographically
type string(1) ListingTreatmentType Independent Telephone Number). Type = ‘3’.
If a subscriber’s directory listing is LISTED, it will be
available by calling 411.
If a subscriber’s directory listing is PUBLISHED, it will be
printed in the local phone book.
Required if 'Treatment Flag' = Add. Identifies the

continuation of the name for Business listings. For
residence listings it identifies the title(s), first name(s),
middle name(s) and initials. If there is no continuation of
the name for the Business listing or if the residence listing
has no first name, this field is not required. The following
characters are not valid and will not print in a directory:
• , comma
firstName string(100)
• + plus sign
• ; semicolon
• = equal sign
• - - consecutive hyphens
Page 75 of 350
Required if 'Treatment Flag' = Add. Indicates the full last

name (surname) and suffix(es) for a Residential listing; or
the first word for Business listings the following special
characters are not allowed in this field:
• ; semicolon
• , comma
• + plus sign
• ; semicolon
lastName string(50)
• = equal sign
• # pound sign
• ? question mark
• $ dollar sign
• ampersand
Valid if CTI = R. dualNameListing = 'Y' indicates

dualNameListing string(1) yesNo directoryListingInformation.firstName should be interpreted
as two first names (e.g. firstName = John & Jane).
√ Indicates whether authorization to publish or list number

LOA string(1) yesNo
has been granted. Required if 'Treatment Flag' = Add.
listedAddressIndicator √ string(1) yesNo Indicates that client wants address included in listing
flexibleAttribute
Page 76 of 350
name string(80) FlexibleAttr.Name
value string(80) FlexibleAttr.Value
2.2.3.4 Output Message Parameters - createSLOrderResponse


more individual business transactions or dialogues (for new, supp, or cancel).
Partner is required to keep this value unique for correlation and auditing purposes.
ID should begin with Partner’s initials or name (ex. Level3_123456)

resultCode

returned.
message √ string(256) Description of result code; required when resultCode is present
Page 77 of 350
2.2.3.5 Input Callback Message Parameters – postSLOrderStatus

requestMessageHeader transaction initiator and are not enforced by Level 3 beyond
datatype and optionality; however Level 3 recommends that
careful consideration be given to the definition and

message
Code designating partner department within an organization

that submits a given message

message

timeStamp dateTime

messageID submitted in input and input-callback messages
messageID √ string (32) are returned in output and output-callback messages.
Partner is required to keep this value unique per message
for correlation and auditing purposes.
Same as requestMessageHeader.messageID of
√ corresponding input message. Valid for callback messages
originalMessageID string (32)
only. Partner is advised to use this value to correlate a
callback or notification to the related original message.

B2BPartnerID √ string(40) partner profile is established in Level 3 systems. A partner
Page 78 of 350

Fixed-value text describing the legally binding agreement

entered into by this commercial transaction. The specific
text included is:
This notice acknowledges receipt of your Customer Order

for the Services described herein. Subject to the terms set
forth in this communication, Level 3 accepts the Customer
Order, and this notice constitutes delivery of a Welcome
√ Letter and memorializes Level 3’s acceptance of your
legalBinder string(1000)
Customer Order. The Services identified in this notice are
governed by and subject to the master agreement between
Level 3 and Customer (or its affiliate, if applicable). In the
event that Level 3 and Customer (or its affiliate) have not
executed a master agreement and/or applicable Service
Schedule(s) with respect to the Services, then Level 3's
standard Master Service Agreement and Service Schedules
(as of the date of this notice) shall govern, copies of which
are available upon request.
notificationHeader
notificationType √ string(40) NotificationType Types are listed in Enumeration Values section.
dateTime √ dateTime
serviceOrderHeader
Identifier assigned by Level 3 systems when the order is

accepted. May be utilized by partner for subsequent
reporting, correlation or other related purposes.
Level3ParentOrderID √ string(60)
This ID will be assigned in the Submit notification. If order
receives an Error notification in lieu of a Submit notification,
the ID will not be assigned.
Page 79 of 350
productID √ string(4) Level 3 identification for a service

initiate
orderType √ string(20) OrderType Level 3 identifier used to indicate the type of an order action



√ See state transition diagrams for specific values that can be

orderStatus string(25)
expected.

serviceOrderHeader

subscriberLines
listOfResultCodes listOfResultCodes A listOfResultCodes includes 0 or one result code element

Customer Provided.
√ Y indicates the requested E-911Option is available.

Page 80 of 350

values.

√ different rate centers and thus require a GITN.
N indicates that service address and TN location are in the
same rate center and a GITN is not needed.
Disclaimer associated with chosen E-911Option. The text

included is:
E911 Static: This subscriber will be activated using E-911.
In the event a Public Safety Answering Point is not E-911-
enabled, your subscriber will be activated using a
permanent 911 solution to the extent technically feasible.
All 911 Services and E-911 Services provided by Level 3
are provided by Level 3 Communications, LLC and are
subject to applicable tarrifs.
E911 Disclaimer √ string(1000) E911 VPC: Level 3 has accepted this order. Your company
is responsible for ensuring the information for the
subscriber associated with this Telephone Number is
provided to the VPC. Your subscriber will not be
provisioned with 911 service until your company has
provisioned them with your VPC.
E911 Customer Provided: Level 3 is not providing a 911
solution to this subscriber. Per the terms of your agreement
with Level 3, your company is responsible for providing 911
to this subscriber.

subscriber
serviceOrderHeader.

where CTI = B. Invalid if CTI = R.

First_M
Titles are to be prepended to firstName. First + Middle +
mismatches are common reasons for LNP failures. To help
Page 81 of 350
ensure LSOG hits, partners are advised to use subscriber

name as it appears in existing phone bills.

lastName string(50)
Last less than or equal to 25 chars.
Same as subscriber.Level3SubscriberID within

√ createSLOrder message if specified there by partner.
Level3SubscriberID integer
Otherwise, generated by Level 3 systems for new
subscriber record.

Same as subscriberSite.Level3SubscriberISiteID within

subscriber site record.
One to many subscriberLines within a given

subscriberLine


support home office scenarios, where both business and
Page 82 of 350
Identifier generated by Level 3 systems for this subscriber

line. This attribute will not be seen until the Complete
Level3SubscriberLineID integer
notification is received. May be utilized by partner for
subsequent reporting, correlation or other related purposes.
Required if no errors encountered. For new TN (i.e. Non-

WTN WTN LNP) Orders, this is the ready-to-use TN for the ordered
subscriber line.

When applied to a subscriber order, this routing information
defines the IP address or addresses to send traffic, or how
to balance traffic across several IP addresses. The typical
customer scenario involves a single Customer Service
Name definition, but multiple Customer Service Names may
be set up based on customer needs. Please contact your
Account Manager for more information on this
configuration.
CNAMInformation CNAMInformation See CNAMInformation class.
directoryListingInformation directoryListingInformation See directoryListinginformation class.
WTN Required within subscriberLine if no errors encountered
NPA √ string(3)
NXX √ string(3)
CNAMInformation
Not required if BlockCNAM = ‘Y’. CNAM calculation rules

CNAM string(15)
special characters are not permitted.
Page 83 of 350

scenarios.
Only 'Keep' and 'Remove' listing treatments are supported
treatmentFlag √ string(10) ListingTreatment
scenarios.
Required if treatmentFlag = Add. Valid values (use number

only): 1 (List and Publish); 2 (List Only); 3 (Do Not List or
Publish)

middle name(s) and initials. If there is no continuation of the
name for the Business listing or if the residence listing has
no first name, this field is not required. The following
characters are not valid and will not print in a directory:
• , comma
• + plus sign
• ; semicolon
• = equal sign
lastName string(50) Required if 'Treatment Flag' = Add. Indicates the full last
Page 84 of 350

• ; semicolon
• , comma
• + plus sign
• ; semicolon
• = equal sign
• # pound sign
• ? question mark
• $ dollar sign
• ampersand

dualNameListing string(1) yesNo directoryListingInformation.firstName should be interpreted
as two first names (e.g. firstName = John & Jane).

LOA string(1) yesNo
has been granted. Required if 'Treatment Flag' = Add.
listedAddressIndicator √ string(1) yesNo Indicates that client wants address included in Listing
rateCenter One to one within a given subscriberLine
Page 85 of 350
listOfResultCodes

transaction

code string(20)
return of one or more codes for transactions that may raise
several exceptions.

message string(256)
present
Contextual addendum to description, clarifying the source

context string(256)
of the resultCode
2.2.3.6 Output Callback Message Parameters - postSLOrderStatusResponse
timeStamp √ dateTime Time that message is submitted, in standard XML Schema dateTime datatype

Page 86 of 350


resultCode

returned.
Page 87 of 350
2.2.4 Install Order (LNP)

Description
This business transaction enables a Level 3 partner to submit a request for Level 3 to port-in an existing telephone number (either Wireline TN or
Wireless TN), at the subscriber's specified address.
o createSLOrder – sent by partner to request the port of an active TN
If partner chooses to implement the LNP ordering capability, implementation of the Service Availability, Supplement of Install Order
(Supp), Cancel of Install Order, Level 3 Action notification, Change Order, Disconnect Order, and Request CSR transactions are required.
If an error is generated, the order is rejected and is not persisted within the Level 3 systems, and may require further action from partner.
Only the Submit notification is detailed for this business transaction. Other notifications will be issued throughout the course of processing
this transaction. For more information, please refer to the sample usage diagrams and the Order Status Notification and Customer Service
Record (CSR) Notification sections.
This transaction also supports the use of Geographically Independent Telephone Numbers (GITN). The directory listing feature is not
available if subscriber chooses a GITN.
Multi-line porting:
o TNs must have same billing TN
o TNs will port together
o Action on order results in all TNs being affected (Supp, Cancel, Jeopardy/Warning, etc.)
o Cannot mix Wireless TNs and Wireline TNs on the same order request.
Page 88 of 350
Prerequisites
For new TN orders, partner must be set up in the rate center/market; i.e., partner has TNs allocated in appropriate market.
Expected Results
Submit notification (postSLOrderStatus message) - successful order submission
FOC notification (postSLOrderStatus message) - availability of FOC date from donor LEC
Install notification (postSLOrderStatus message) - successful installation of order (service activated on Level 3 Network)
Complete notification (postSLOrderStatus message) - successful completion of order, including all post-install steps such as 911
provisioning on Level 3 Network and billing commencement
Error notification (postSLOrderStatus message)
If the install request was a multi-line port and at least one TN failed validation, then only one error notification will be provided for
all TNs on the order.
o LNP error provided requiring partner action to resolve the problem (may occur at any point in the order flow). If the install request
was a multi-line port and at least one TN caused an LNP error, then an error notification will be provided for all TNs on the order.
o LNP error provided not requiring partner action (may occur at any point in the order flow). If the install request was a multi-line
port and at least one TN caused an LNP error, then an error notification will be provided for all TNs on the order.
o 911 Automatic Location Information (ALI) error provided if address cannot be validated in Master Street Address Guide (MSAG).
Level 3 action notification (postSLOrderStatus message)
o Will be provided if Level 3 must take proactive action on any order currently processing.
Page 89 of 350
2.2.4.1.1 Install Order - LNP
Page 90 of 350
Page 91 of 350
Page 92 of 350
-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-OriginalMessageID
-B2BPartnerID
-LegalBinder
1
1
NotificationHeader
-NotificationType
-DateTime
1
1
ServiceOrderHeader WTN
-ProductID -NPA
-OrderAction -NXX
-OrderType -StartNum
1 -CRD
-ExternalOrderID 0..1
-LNPIndicator
Subscriber -OrderStatus 1
-L3SubscriberID -Subscriber
-ExternalSubscriberId -ListOfResultCodes SubscriberLine
-SubscriberSite 1 -ListOfSubscriberLines
1..* -L3SubscriberLineID
-L3ParentOrderID -WTN
1
1 -PartnerSubGroupID -FromLECCompanyCode
-E911Disclaimer -ToLECCompanyCode
-E911Option -RateCenter
-GITNIndicator
-E911CoverageIndicator 1
-wirelessLNPIndicator
1
1
1
-L3SubscriberSiteId -RateCenterAbbreviation
ResultCode -LATA
-Code -State
-Message
-Context
Page 93 of 350
Page 94 of 350
Require
Class Attribute Datatype Enumeration Description
d

transaction initiator and are not enforced by Level 3
maximum benefit.

message


message

timeStamp dateTime


the partner.
Page 95 of 350


serviceOrderHeader

initiate. 'Install' for new install order.

order.

dateTime datatype.
When order is an internal port, CRD must not be on a
Monday, weekend, or holiday. See internalPortFlag
CRD √ date attribute definition in Service Availability Validation (LNP),
Output Message Paramenters section
When an order is a Wireless LNP request, the date can be
the current day’s date (weekend/holiday rules still apply).
Then 120 Minutes will be added to the time the request
was received. If the resulting time is after 5:00PM MST,
then the date will advance to the next business day
externalOrderID string(60) Partner Order ID stored by Level 3 systems. Level 3 does
Page 96 of 350
not enforce or utilize this value for any purpose other than


serviceOrderHeader

subscriberLines
LNPInformation LNPInformation Required if serviceOrderHeader.LNPInidicator = Y

Customer Provided.


where CTI = B. Invalid if CTI = R

where CTI = R. Invalid if CTI = B
First_M
Page 97 of 350


lastName string(50)
Last less than or equal to 25 chars

partner's reporting and querying purposes. If partner does
Level3SubscriberID integer not specify this value, a new subscriber record (and

Level 3 subscriber site identifier, stored in Level 3 systems

for partner's reporting and querying purposes. Only need to
populate if installing additional service on a location. If
partner does not specify this value, a new subscriber site
record (and identifier) is generated and returned within the
mainCallBackNumber string(18) Main call-back number to be used in case of Business

EXAMPLE: 25 W
Page 98 of 350

EXAMPLE: 1/2

EXAMPLE: SW
Where SW is the Street directional prefix or pre-directional
preDirectional string(2) Directional for the following address example: 25W 450 1/2 SW

EXAMPLE: LN

EXAMPLE: NW
Where NW is the Street directional suffix or post-directional
postDirectional string(2) Directional for the following address example: 25W 450 1/2 SW

room string(10)
Floor Designation
EXAMPLE: 12
EXAMPLE: 2
Page 99 of 350

EXAMPLE: STE

EXAMPLE: 23A

1 to many subscriberLines within a given

serviceOrderHeader. One WTN per subscriberLine
subscriberLine element. Multiple subscriberLines are required to port
multiple TNs per BTN.
servicePackage √ string(60) SvcPackage Required field describing selected pricing plan. Service
Page 100 of 350


support home-office scenarios, where both business and
One WTN per subscriberLine element. Multiple

subscriberLines are required to port multiple TNs per BTN.
match the externalBusinessTransactionID of this
Submit New Install Order transaction, for this
B2BPartnerID.
WTN WTN

customerServiceName √ String(15) to balance traffic across several IP addresses. The typical
Name definition, but multiple Customer Service Names
may be set up based on customer needs. Please contact
your Account Manager for more information on this
Page 101 of 350

configuration.
One WTN per subscriberLine element. Multiple

WTN subscriberLines are required to port multiple TNs per BTN.
NPA √ string(3)
NXX √ string(3)
CNAMInformation

CNAM string(15)

√ Only ‘Add’ listing treatment is supported for New TNs

scenarios.
scenarios.
Information needed to process LNP orders. Required if

LNPInformation
serviceOrderHeader.LNPIndicator = Y
Indicates whether authorization to port number has been

LOA string(1) yesNo granted. Required when TPVPVN is not provided; must be
Y for LNP orders.
Timestamp when LNP LOA received, in standard XML

LOADateTime dateTime Schema dateTime datatype. Required when TPVPVN is
not provided.
Page 102 of 350

Reference number for Third Party Validation record.

Required when LOA and LOADateTime not provided. Use
TPVPVN number(10)
in place of LOA /LOADateTime only when contractually
permitted.
Timestamp when TPV Sent. Must be GMT. Required when

TPVSentDateTime dateTime LOA and LOADateTime not provided. Use in place of
LOA/LOADateTime only when contractually permitted.
Required for LNP Orders. Subscriber’s BTN (Billing

BTNOldCarrier string(10) Telephone Number) with the old carrier. It may or may not
be the same as the porting TN.
Required for wireless LNP.If TN is wireless, either Wireless

Subscriber SSN OR wirelessSubscriberAccountNumber
must be popluated.
wirelessSubscriberSSN √ string(11) Proper Format (include zeros where shown, where 1234
would be the actual values for subscriber
000-00-1234 for SSN (individual)
00-0001234 for Tax ID number (business)
Required for wireless LNP.If TN is wireless, either Wireless

Subscriber SSN OR wirelessSubscriberAccountNumber
wirelessSubscriberAccountNumber √ string(20) must be popluated.
Proper Format = Last 4 digits only (along with leading
zeros)
Optional - if the subscriber is entering their Wireless

Account Number AND the subscriber has set up a
WirelessSubscriberAccountPIN string(15)
password or PIN with their wireless carrier then the PIN is
required
flexibleAttribute
value string(80) FlexibleAttr.Value
Page 103 of 350




resultCode

returned.
2.2.4.5 Input Callback Message Parameters – postSLOrderStatus
requestMessageHeader requestMessageHeader information may be utilized by
Page 104 of 350


transaction initiator and are not enforced by Level 3 beyond
datatype and optionality; however Level 3 recommends that
careful consideration be given to the definition and

message
Code designating partner department within an organization

that submits a given message

message

timeStamp dateTime

messageID submitted in input and input-callback messages
messageID √ string (32) are returned in output and output-callback messages.
Partner is required to keep this value unique per message
for correlation and auditing purposes.


externalBusinessTransactionID √ string(40) which consists of one or more individual business
Page 105 of 350


Fixed-value text describing the legally binding agreement

text included is:

standard Master Service Agreement and Service Schedules
(as of the date of this notice) shall govern, copies of which
are available upon request.
notificationHeader
notificationType √ string(40) NotificationType Types are listed in Enumeration Values section.
serviceOrderHeader

accepted. May be utilized by partner for subsequent
Level3ParentOrderID √ string(60)

initiate
Page 106 of 350





expected.

serviceOrderHeader

subscriberLines

Customer Provided.

E911CoverageIndicator √ string(7) E911CoverageIndicator
values.

GITNIndicator √ string(1) different rate centers and thus require a GITN.
N indicates that service address and TN location are in the
Page 107 of 350

same rate center and a GITN is not needed.
Disclaimer associated with chosen E-911Option. The text

included is:
All 911 Services and E-911 Services provided by Level 3
E911 Disclaimer √ string(1000) E911 VPC: Level 3 has accepted this order. Your company
to this subscriber.
Value returned based on whether or not the TN is wireless

wirelessLNPIndicator √ string(1) YesNo
LNP.

subscriber
serviceOrderHeader.

where CTI = B. Invalid if CTI = R.

First_M
Page 108 of 350


lastName string(50)
Last less than or equal to 25 chars.

subscriber record.



subscriberLine
serviceOrderHeader.


support home office scenarios, where both business and

notification is received. May be utilized by partner for
subsequent reporting, correlation or other related purposes.
Page 109 of 350


subscriber line.

to balance traffic across several IP addresses. The typical
Name definition, but multiple Customer Service Names may
be set up based on customer needs. Please contact your
Account Manager for more information on this
configuration.
CNAMInformation CNAMInformation See CNAMInformation class.
directoryListingInformation directoryListingInformation See directoryListinginformation class.
NPAC Company code of carrier from which number is to be

fromLECCompanyCode string(50)
ported. Required if serviceOrder.LNPIndicator = Y
NPAC Company code of carrier to which number is to be

toLECCompanyCode string(50)
NPA √ string(3)
NXX √ string(3)
CNAMInformation

CNAM string(15)
Page 110 of 350


scenarios.
scenarios.
listOfResultCodes

transaction

code string(20)
several exceptions.

message string(256)
present

context string(256)
of the resultCode
Page 111 of 350




resultCode

returned.
Page 112 of 350

2.2.5 Supplement of Install Order (LNP)

Description
This business transaction enables a Level 3 partner to perform the following actions on a submitted install order:
• change the CRD (customer request date)
• change the BTN (billing telephone number)
• change the CTI (customer type indicator (residential or business))
• change the Subscriber Name.
Note the following:
• The following messages are required for this business transactions:
o createSLOrder – sent by partner to Supp an LNP order
• For Level 3 VoIP Enhanced Local and Local Inbound services, this transaction applies only to LNP orders.
• Supplementing a multi-line LNP order will cause all TNs on the order to be supped.
• CRD may be changed to an earlier date, but the likelihood of an error being generated is progressively higher the further you pull in that
date.
• Once a FOC date is received only a supp for CRD is allowed.
• CNAM can be changed only when a supp for subscriber name is submitted. A supp for CNAM only is not supported.
o If the CNAM information is populated on a Supp for Subscriber Name, the system will store that CNAM value in place of what
existed on the previous version of the order.
Page 113 of 350

o If the CNAM information is NOT populated on a Supp for Subscriber Name, the system will store either the lastname, firstname
(truncated to 15 characters) for CTI=R, or the businessName (truncated to 15 characters) for CTI=B as the new CNAM value in
place of what existed on the previous version of the order.
o If a Supp for CTI, BTN, or CRD is requested (not a Supp for Subscriber Name) then the existing CNAM is not impacted as a
result of the Supp.
• If submitting a Supp transaction on Subscriber Name, note that the CTI field is required.
• The latest that a Supp transaction may be performed is 2 business days (48 hours, Greenwich Mean Time) before the FOC date returned
by the FOC notification.
• This B2B interface is applicable to the Level 3 VoIP Enhanced Local and Local Inbound services.
• For Level 3 VoIP Enhanced Local and Local Inbound services, this transaction applies only to LNP orders.
• Supplements, install cancellations, disconnect cancellations, and change cancellations are related to the transactions they operate on via
businessTransactionHeader.externalBusinessTransactionID.
• The suppAllowedIndicator on the Read Order response will identify which Supp actions are available on an in-progress order.
Prerequisites
• A previous order has been successfully submitted and accepted by Level 3 systems.
• Service order is not in Installed order status (reported in serviceOrderHeader.orderStatus within postSLOrderStatus message).
• For LNP orders, “Current Date” is three business days before FOC date (if FOC is already received).
Expected Results
• Submit notification (postSLOrderStatus)
• FOC notification (postSLOrderStatus)
• Install notification (postSLOrderStatus)
• Complete notification (postSLOrderStatus)
Page 114 of 350

• Error notification (postSLOrderStatus) – will be provided in lieu of Submit notification if order validations fail.
Page 115 of 350

2.2.5.1.1 Supp – Scenario 1
Partner Order System Level 3 Order Gateway
Partner requests LNP Install - createSLOrder
Level 3 request acknowledgement- createSLOrderResponse
Process INSTALL Request
Level 3 SUBMIT Notification - postSLOrderStatus
Partner receipt acknowledgement - postSLOrderStatusResponse
Partner requests SUPP of LNP Install - createSLOrder
Process SUPP Request
Level 3 CSR Notification - postSLOrderStatus
Level 3 FOC Notification - postSLOrderStatus
Supps may be submitted up to 48

hours before FOC date (GMT).
Level 3 INSTALL Notification - postSLOrderStatus
Level 3 COMPLETE Notification - postSLOrderStatus
Page 116 of 350

2.2.5.1.2 Supp – Scenario 2
Level 3 CSR Notification - postSLOrderStatus
Partner requests SUPP of LNP Install - createSLOrder
Process SUPP Request
Supps may be submitted up to 48

hours before FOC date (GMT).
Level 3 INSTALL Notification - postSLOrderStatus
Page 117 of 350

-MessageID
-Organization
-Department
-Application
-TimeStamp
-B2BPartnerID
ServiceOrderHeader
1 0..1 LNPInformation
-Level3ParentOrderID
-ProductID -BTNOldCarrier WTN
Subscriber -OrderAction -NPA
-OrderType 0..1 -NXX
-BusinessName
-CRD -StartNum
-FirstName 1
-ExternalOrderID -EndNum
-MiddleInitial 1 0..1
0..1 -Comments 1 SubscriberLine
-LastName
-Subscriber -CTI 1
-ListOfSubscriberLines -WTN
-ExternalOrderVersion -CNAMInformation
-LNPInformation
0..1
CNAMInformation
-CNAM
-BlockCNAM
Page 118 of 350

Page 119 of 350

-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-OriginalMessageID
1 SuppType
-SuppName
1
0..*
1
-B2BPartnerID
0..1
1
1 OrderSummary
-listOFSuppType
NotificationHeader
-NotificationType
-DateTime
1 WTN
-NPA
ServiceOrderHeader -NXX
1
-StartNum
-ProductID
1 -OrderAction
-OrderType 0..1
-CRD 1
Subscriber
-ExternalOrderID
-Level3SubscriberID -LNPIndicator SubscriberLine
-ExternalSubscriberId -OrderStatus
-SubscriberSite 1 -Subscriber 1..* -Level3SubscriberLineID
1 -WTN
-ListOfResultCodes
-ListOfSubscriberLines -FromLECCompanyCode
1 -ToLECCompanyCode
-Level3ParentOrderID -RateCenter
-PartnerSubGroupID -OrderSummary
1 11
RateCenter
SubscriberSite 0..* -RateCenterAbbreviation
1 -LATA
-Level3SubscriberSiteId
-State
ResultCode
-Code
-Message
-Context
Page 120 of 350

Page 121 of 350

2.2.5.3 Input Message Parameters – createSLOrder

values are determined by the transaction initiator and are not
requestMessageHeader enforced by Level 3 beyond datatype and optionality; however
benefit.

submits a given message.

required. Z denotes time zone. Example: 2001-12-01T15:20:23-
05:00 (where -05:00 is explicit time zone used).

purposes.

userID string (32)

multiple profiles active at any given point, where the URL to respond
to is defined.
Page 122 of 350

Partner’s identifier for a new order life-cycletransaction, which

(ex. Level3_123456)
serviceOrderHeader
Level3ParentOrderID string(60) Same as Level3ParentOrderID of responded-to message
√ Level 3 identifier used to indicate the action an order will initiate.

'Install' for Supplement of Install order.
√ Level 3 identifier used to indicate the type of an order action. 'Supp'

orderType string(20) OrderType
for Supplement of Install order.
Customer Requested Date in standard XML Schema dateTime

datatype.
CRD √ date
When order is an internal port, CRD must not be on a Monday,
weekend, or holiday. See internalPortFlag attribute definition in
Service Availability Validation (LNP), Output Message Paramenters
section
Partner Order ID stored by Level 3 systems. Level 3 does not

externalOrderID string(60) enforce or utilize this value for any purpose other than partner-
requested reporting.
Partner Order Version stored by Level 3 systems. Level 3 does not

externalOrderVersion string(20) enforce or utilize this value for any purpose other than partner-
LNPInformation LNPInformation LNP Information needed to process supp for BTN order
subscriber √ subscriber One and only one subscriber included within a serviceOrderHeader
Page 123 of 350

listOfSubscriberLines √ listOfSubscriberLines A listOfSubscriberLines includes one to many subscriberLines
subscriber One and only one subscriber within a given serviceOrderHeader
Required if subscriber has one or more subscriber lines where CTI =

B

R
Middle initial is to be included with first name in this format: First_M
firstName string(50) Titles are to be prepended to firstName. First + Middle + Last less
than or equal to 25 chars for LNP orders. This restriction is imposed
by LSOG repository. LSOG mismatches are common reasons for
LNP failures. To help ensure LSOG hits, partners are advised to use
First + Middle + Last less than or equal to 25 chars.


lastName string(50) R. Suffixes are to be appended to lastName. First + Middle + Last
less than or equal to 25 chars.
LNPInformation
Required if submitting a supp order to change BTN. Subscriber’s

BTNOldCarrier string(10) BTN (Billing Telephone Number) with the old carrier. It may or may
not be the same as the porting TN.
One to many subscriberLines within a given serviceOrderHeader.

Note that current release only supports one and only one
subscriberLine
subscriberLine within a given serviceOrderHeader for this
transaction.
Required if supplementing subscriber name.

CTI √ string(1) CTI
Customer Type Indicator. Maintained by Level 3 systems at
Page 124 of 350

subscriberLine level to support home-office scenarios, where both

business and residential lines may exist.
If serviceOrderHeader.LNPIndicator = N and WTN is defined, this is

an order for a new, partner-specified TN. If the TN is currently
reserved, the externalBusinessTransactionID submitted with the
reservation request must match the externalBusinessTransactionID
of this Submit New Install Order transaction, for this B2BPartnerID.
If serviceOrderHeader.LNPIndicator = N and WTN is not defined,

this order is for a new TN that will be determined by Level 3.
WTN WTN
If serviceOrderHeader.LNPIndicator = Y and WTN is defined, this is
an LNP order.
If serviceOrderHeader.LNPIndicator = Y and WTN is not defined,

this is not valid.
WTN
NPA √ string(3)
NXX √ string(3)
CNAMInformation
Not required if BlockCNAM = ‘Y’. CNAM calculation rules follow the

CNAM string(15) Verisign convention: uppercase LASTNAME FIRSTNAME, truncated
to 15 characters. Symbols and special characters are not permitted.
Page 125 of 350




resultCode

returned.
Page 126 of 350

2.2.5.5 Input Callback Message Parameters - postSLOrderStatus

organization string (256) Code designating partner organization submitting a given message



purposes.
Same as requestMessageHeader.messageID of corresponding input

√ message. Valid for callback messages only. Partner is advised to use
this value to correlate a callback or notification to the related original
message.

defined.
externalBusinessTransactionID √ string(40) Partner’s identifier for a new order life-cycletransaction, which consists
Page 127 of 350

of one or more individual business transactions or dialogues (for new,

supp, or cancel).
Level3_123456)
Fixed-value text describing the legally binding agreement entered into

by this commercial transaction. The specific text included is:
This notice acknowledges receipt of your Customer Order for the

Services described herein. Subject to the terms set forth in this
communication, Level 3 accepts the Customer Order, and this notice
constitutes delivery of a Welcome Letter and memorializes Level 3’s
legalBinder √ string(1000) acceptance of your Customer Order. The Services identified in this
notice are governed by and subject to the master agreement between
Level 3 and Customer (or its affiliate, if applicable). In the event that
Level 3 and Customer (or its affiliate) have not executed a master
agreement and/or applicable Service Schedule(s) with respect to the
Services, then Level 3's standard Master Service Agreement and
Service Schedules (as of the date of this notice) shall govern, a copy
of which are available upon request.
notificationHeader
notificationType √ string(40) NotificationType See notificationType values in Enumeration Values section.
serviceOrderHeader
Level3ParentOrderID √ string(60) Same as Level3ParentOrderID of responded-to message
orderAction √ string(20) OrderAction Level 3 identifier used to indicate the action an order will initiate
√ Customer Requested Date in standard XML Schema dateTime

CRD date
datatype.
Page 128 of 350

Partner Order ID stored by Level 3 systems. Level 3 does not enforce

externalOrderID string(60) or utilize this value for any purpose other than partner-requested
reporting.

orderStatus √ string(25) See state-transition diagrams for specific values that can be expected.
Same as subscriber.Level3SubscriberID within createSLOrder

Level3SubscriberID √ integer message if specified there by partner. Otherwise, generated by
Level 3 systems for new subscriber record.
Partner subscriber identifier, stored in Level 3 systems for partner's

reporting and querying purposes

Level3SubscriberSiteID √ integer createSLOrder message if specified there by partner. Otherwise,
generated by Level 3 systems for new subscriber site record.
Page 129 of 350


EXAMPLE: 25 W

Otherwise, ignored.
EXAMPLE: 1/2

EXAMPLE: SW

EXAMPLE: LN
streetSuffix string(6) StreetSuffix Where LN is the street suffix for the following address example: 25W
23A.

EXAMPLE: NW

room string(10)
floor string(10) Floor Designation
Page 130 of 350

EXAMPLE: 12
EXAMPLE: 2
building string(10)

EXAMPLE: STE

EXAMPLE: 23A
unit string(10) Where 23A is the unit number for the following address example: 25W
23A.
1 to many subscriberLines within a given serviceOrderHeader. Note

subscriberLine that current release only supports one and only one subscriberLine
within a given serviceOrderHeader for this transaction.
CTI √ string(1) CTI Customer Type Indicator. B=Business, R=Residential.
Page 131 of 350

Maintained by Level 3 systems at subscriberLine level to support

home-office scenarios, where both business and residential lines may
exist.
Identifier generated by Level 3 systems for this subscriber line. This

√ attribute will not be seen until the Complete notification is received.
May be utilized by partner for subsequent reporting, correlation or
other related purposes.
WTN WTN Required if no errors encountered
NPAC Company code of carrier from which number is to be ported.

Required if serviceOrder.LNPIndicator = Y
NPAC Company code of carrier to which number is to be ported.

directoryListingInfor
mation
Description of order details. Currently only required for change and

orderSummary √ orderSummary supp orders, (where orderAction = Change; orderType = New OR
orderAction = Install; orderType = Supp ).
NPA √ string(3)
NXX √ string(3)
CNAMInformation
Page 132 of 350


CNAM string(15) Verisign convention: uppercase LASTNAME FIRSTNAME, truncated
to 15 characters. Symbols and special characters are not permitted.
Only 'Keep' and 'Remove' listing treatments are supported for port-in
scenarios.
√ ListingTreatme
treatmentFlag string(10)
nt Only ‘Add’ listing treatment is supported for New TNs scenarios.
Only ‘Change’ listing treatment is supported for Change scenarios.
Required if treatmentFlag = Add. Valid values (use number only): 1

(List and Publish); 2 (List Only); 3 (Do Not List or Publish)
DL is not supported for a GITN (Geographically Independent
ListingTreatme Telephone Number). Type = ‘3’.
type string(1)
ntType If a subscriber’s directory listing is LISTED, it will be available by
calling 411.
If a subscriber’s directory listing is PUBLISHED, it will be printed in
the local phone book.
firstName string(100) DL first name on record
lastName string(50) DL first name on record

dualNameListing string(1) yesNo directoryListingInformation.firstName should be interpreted as two
first names (e.g. firstName = John & Jane).
√ Indicates whether authorization to publish or list number has been

LOA string(1) yesNo
granted. Required if 'Treatment Flag' = Add.
Page 133 of 350

listOfResultCodes
Indicator of success or failure of an overall business transaction or

resultCode
specific aspect of a given business transaction
On successful transactions, only one resultCode (the success code)

will be returned.
code √ string(20) On error situations, only one resultCode is currently returned;
however, future functionality may support the return of one or more
codes for transactions that may raise several exceptions.
Contextual addendum to description, clarifying the source of the

context string(256)
resultCode
orderSummary
listOfSuppType listOfSuppType
listOfSuppType When present, contains list of one or more suppType objects
suppType √ suppType
suppType
suppName √ string(512) SuppName
2.2.5.6 Output Callback Message Parameters – postSLOrderStatusResponse
Page 134 of 350




resultCode

returned.
Page 135 of 350

2.2.6 Cancel of Install Order (LNP)

Description
This business transaction enables a Level 3 partner to cancel a submitted request for a new telephone number or a port-in telephone number. For
Level 3 VoIP Enhanced Local and Local Inbound services, this transaction applies only to LNP orders.
o createSLOrder – sent by partner to Cancel an LNP order
This transaction is required if partner chooses to implement the LNP ordering capability.
Cancelling a multi-line LNP order will cause all TNs on the order to be cancelled.
Supplements, install cancellations, disconnect cancellations, and change cancellations are related to the transactions they operate on via
• Only the Submit notification is detailed for this business transaction. Other notifications may be issued throughout the course of processing
this transaction. For more information, please refer to the state transition diagrams and the sample usage diagrams for the Provide Order
Status Notification transaction.
Prerequisites
• A previous order has been successfully submitted and accepted by Level 3 systems.
• Service order is not in Installed order status (reported in serviceOrderHeader.orderStatus within postSLOrderStatus message).
• “Current Date” is 2 business days (48 hours, Greenwich Mean Time) before FOC date (if FOC is already received).
Expected Results
• Submit notification (postSLOrderStatus)
Page 136 of 350

• Complete notification (postSLOrderStatus)
• Error notification (postSLOrderStatus) – will be provided in lieu of Submit notification if order validations fail.
Page 137 of 350

2.2.6.1.1 Cancel – Scenario 1
Page 138 of 350

2.2.6.1.2 Cancel – Scenario 2
Page 139 of 350

Page 140 of 350

Page 141 of 350

-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-OriginalMessageID
-B2BPartnerID
1
1
NotificationHeader
-NotificationType
-DateTime
1 WTN
-NPA
-StartNum
-ProductID
1 -OrderAction
-OrderType 0..1
-CRD 1
Subscriber
-ExternalOrderID
1 -WTN
-ListOfResultCodes
1 -ToLECCompanyCode
1 11
RateCenter
1 -LATA
-State
ResultCode
-Code
-Message
-Context
Page 142 of 350

Page 143 of 350

requestMessageHeader information may be utilized by partner and Level 3 for

general purposes such as reporting and auditing. These values are determined
requestMessageHeader by the transaction initiator and are not enforced by Level 3 beyond datatype and
optionality; however Level 3 recommends that careful consideration be given to
the definition and consistent use of these values to derive maximum benefit.
Code designating partner department within an organization that submits a

given message
Time that message is submitted, in standard XML Schema dateTime datatype.

√ Format: CCYY-MM-DDThh:mm:ssZ, with T acting as a separating character
timeStamp dateTime
between date and time. 24H time format required. Z denotes time zone.
Example: 2001-12-01T15:20:23-05:00 (where -05:00 is explicit time zone used).
Partner-generated and -managed message identifier. Same messageID

√ submitted in input and input-callback messages are returned in output and
output-callback messages. Partner is required to keep this value unique per
message for correlation and auditing purposes.
Partner user identifier. Used for auditing purposes only. Value is logged in
userID string (32)
Level 3 systems, but is not sent back to the partner.

B2BPartnerID √ string(40) established in Level 3 systems. A partner may have multiple profiles active at
any given point, where the URL to respond to is defined.

Partner is required to keep this value unique for correlation and auditing
serviceOrderHeader
Page 144 of 350

Level3ParentOrderID string(60) Same as Level3ParentOrderID of responded-to message
√ Level 3 identifier used to indicate the action an order will initiate. 'Install' for
Cancel of Install order. h
√ Level 3 identifier used to indicate the type of an order action. 'Cancel' for Cancel
of Install order.
Partner Order ID stored by Level 3 systems. Level 3 does not enforce or utilize
externalOrderID string(60)
this value for any purpose other than partner-requested reporting.
Partner Order Version stored by Level 3 systems. Level 3 does not enforce or
externalOrderVersion string(20)
utilize this value for any purpose other than partner-requested reporting.
Reason code for cancellation or disconnection of service image (required if

√ service image was cancelled or disconnected). Single valid value for this
reasonCode string(40) ReasonCode
transaction: Channel Partner Init. When invalid value submitted, this value will
be used.
reasonComments √ string(256) Detailed comments describing reason for this cancel/disco
B2BPartnerID √ string(40) B2B Partner Identifier. Provided by Level 3 to partner after partner profile is
Page 145 of 350

established in Level 3 systems. A partner may have multiple profiles active at any


resultCode

returned.
code √ string(20)
On error situations, only one resultCode is currently returned; however, future

benefit.

Page 146 of 350



required to keep this value unique per message for correlation and
auditing purposes.
Same as requestMessageHeader.messageID of corresponding

√ input message. Valid for callback messages only. Partner is advised
to use this value to correlate a callback or notification to the related
original message.

to is defined.

(ex. Level3_123456)
Fixed-value text describing the legally binding agreement entered

into by this commercial transaction. The specific text included is:
This notice acknowledges receipt of your Customer Order for the

Services described herein. Subject to the terms set forth in this
communication, Level 3 accepts the Customer Order, and this
legalBinder √ string(1000) notice constitutes delivery of a Welcome Letter and memorializes
Level 3’s acceptance of your Customer Order. The Services
identified in this notice are governed by and subject to the master
agreement between Level 3 and Customer (or its affiliate, if
applicable). In the event that Level 3 and Customer (or its affiliate)
have not executed a master agreement and/or applicable Service
Schedule(s) with respect to the Services, then Level 3's standard
Page 147 of 350

Master Service Agreement and Service Schedules (as of the date of

this notice) shall govern, copies of which are available upon
request.
notificationHeader
notificationType √ string(40) NotificationType See notificationType values in Enumeration Values section
serviceOrderHeader



expected
√ listOfSubscriberLine
listOfSubscriberLines A listOfSubscriberLines includes one to many subscriberLines
s
Page 148 of 350



reporting and querying purposes.


EXAMPLE: 25 W

Otherwise, ignored.
EXAMPLE: 1/2

EXAMPLE: SW
preDirectional string(2) Directional
following address example: 25W 450 1/2 SW Camino Ramon Lane
Page 149 of 350



EXAMPLE: LN
Suite 23A.

EXAMPLE: NW

room string(10)
Floor Designation
EXAMPLE: 12
floor string(10)
Where 12 is the floor for the following address example: 25W 450
EXAMPLE: 2
building string(10)

EXAMPLE: STE
address example: 25W 450 1/2 SW Camino Ramon Lane NW,

EXAMPLE: 23A
Suite 23A.
Page 150 of 350

1 to many subscriberLines within a given serviceOrderHeader. Note

CTI √ string(1) CTI Maintained by Level 3 systems at subscriberLine level to support

home office scenarios, where both business and residential lines
may exist.



Page 151 of 350

directoryListingInfor
mation
NPA √ string(3)
NXX √ string(3)
CNAMInformation

Verisign convention: uppercase LASTNAME FIRSTNAME,
CNAM string(15)
truncated to 15 characters. Symbols and special characters are not
permitted.
Only 'Keep' and 'Remove' listing treatments are supported for port-
in scenarios.
Only ‘Add’ listing treatment is supported for New TNs scenarios.

DL is not supported for a GITN (Geographically Independent
ListingTreatment Telephone Number). Type = ‘3’.
type string(1)
Type
If a subscriber’s directory listing is LISTED, it will be available by
calling 411.
If a subscriber’s directory listing is PUBLISHED, it will be printed in
Page 152 of 350

the local phone book.

dualNameListing string(1) yesNo directoryListingInformation.firstName should be interpreted as two
first names (e.g. firstName = John & Jane).

LOA string(1) yesNo
listOfResultCodes

resultCode

will be returned.

context string(256)
resultCode
Page 153 of 350




resultCode

returned.
Page 154 of 350

2.2.7 Disconnect Order

Description
This business transaction enables a Level 3 partner to disconnect an active service (a ported telephone number or installed new telephone
number).
Please note:
• The following messages are required for this business transactions:
o createSLOrder – sent by partner to disconnect a subscriber’s service
• This service does not provide the ability to port-out a telephone number.
• This transaction will remove the disconnected subscriber line's Directory Listing information.
• CRD (Customer Request Date) must be set at least one business day in the future.
• Only the Submit notification is detailed for this business transaction. Other notifications may be issued throughout the course of processing
Prerequisites
• A previous order has been successfully completed and service is in Active state.
Expected Results
Submit notification (postSLOrderStatus)
Page 155 of 350

Disconnect notification (postSLOrderStatus)

Complete notification (postSLOrderStatus)
Error notification (postSLOrderStatus) – will be provided in lieu of Submit notification if order validations fail.
Page 156 of 350

This diagram shows the messages exchanged up to processing of the Submit Notification, which marks
acceptance of this request by Level 3.
Page 157 of 350

-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-B2BPartnerID
WTN
1
-NPA
-NXX
-StartNum
1
0..1
ServiceOrderHeader
-ProductID
-OrderAction
-OrderType
-CRD 1
-ExternalOrderID
-Comments 1 1
-ListOfSubscriberLines SubscriberLine
-ReasonCode -Level3SubscriberLineId
-ReasonComments -WTN
Page 158 of 350

Page 159 of 350

-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-OriginalMessageID
-B2BPartnerID
1
1
NotificationHeader
-NotificationType
-DateTime
1 WTN
-NPA
-StartNum
-ProductID
1 -OrderAction
-OrderType 0..1
-CRD 1
Subscriber
-ExternalOrderID
1 -WTN
-ListOfResultCodes
1 -ToLECCompanyCode
1 11
RateCenter
1 -LATA
-State
ResultCode
-Code
-Message
-Context
Page 160 of 350

Page 161 of 350




timeStamp √ dateTime separating character between date and time. 24H time format required.
Z denotes time zone. Example: 2001-12-01T15:20:23-05:00 (where -
05:00 is explicit time zone used).

messageID √ string (32) returned in output and output-callback messages. Partner is required to
keep this value unique per message for correlation and auditing
purposes.
Partner user identifier. Used for auditing purposes only. Value is logged
userID string (32)
in Level 3 systems, but is not sent back to the partner.

defined.

supp, or cancel).
Page 162 of 350


Level3_123456)
serviceOrderHeader
√ Level 3 identifier used to indicate the action an order will initiate.

'Disconnect' for New Disconnect order.
√ Level 3 identifier used to indicate the type of an order action. 'New' for
New Disconnect order.

CRD √ date datatype.
Partner Order ID stored by Level 3 systems. Level 3 does not enforce

externalOrderID string(60) or utilize this value for any purpose other than partner-requested
reporting.

Reason code for cancellation or disconnection of service image

(required if service image was cancelled or disconnected). Valid values
for this transaction:
• Channel Partner Init.
reasonCode √ string(40) ReasonCode • CustInit Chg Srvc.
• MSAG ERROR.
Note: if invalid value submitted, default (Channel Partner Init.) will be

used.
Page 163 of 350

One to many subscriberLines within a given serviceOrderHeader. Note


attribute will not be seen until the Complete notification is received.
May be utilized by partner for subsequent reporting, correlation or other
related purposes.
WTN WTN WTN to be disconnected
WTN
NPA √ string(3)
NXX √ string(3)
Page 164 of 350




resultCode

returned.

benefit.

Page 165 of 350



auditing purposes.

original message.
Reason code for cancellation or disconnection of service image

√ (required if service image was cancelled or disconnected). Single
valid value for this transaction: Channel Partner Init. When invalid
value submitted, this value will be used.
If LNPIndicator = Y, FOCDate holds firm order commitment date for

FOCDate date port. If LNPIndicator = N, FOCDate holds customer commitment
date for order activation.
Required only for Post-Submit Disconnect, Order Completion (for

billStopDate date Disconnect) and Post-submit Error notifications. Not applicable
otherwise.

to is defined.

externalBusinessTransactionID √ string(40) dialogues (for new, supp, or cancel).
Page 166 of 350


(ex. Level3_123456)
notificationHeader
serviceOrderHeader
Identifier assigned by Level 3 systems when the order is accepted.

√ This ID will be assigned in the Submit notification. If order receives

Level3ParentOrderID string(60)
an Error notification in lieu of a Submit notification, the ID will not be
assigned.
A new Level3ParentOrderID is assigned for Disconnect and Change
Order transactions.



Page 167 of 350


expected.




subscriberLine
transaction.

Level3SubscriberLineID √ integer attribute will not be seen until the Complete notification is received.
Page 168 of 350



NPA √ string(3)
NXX √ string(3)
listOfResultCodes

resultCode

√ will be returned.
code string(20)
On error situations, only one resultCode is currently returned;
Page 169 of 350


context string(256)
resultCode
messageID √ string (32) Same as requestMessageHeader.messageID of responded- to message



resultCode

returned.
Page 170 of 350

Page 171 of 350

2.2.8 Cancel of Disconnect Order

Description
This business transaction enables a Level 3 partner to cancel the request to disconnect an active service.
o createSLOrder – sent by partner to cancel a disconnect order
Supplements, install cancellations, disconnect cancellations, and change cancellations are related to the transactions on which they
operate via businessTransactionHeader.externalBusinessTransactionID.
Only the Submit notification is detailed for this business transaction. Other notifications may be issued throughout the course of processing
Prerequisites
The Disconnect transaction to be cancelled has been successfully submitted for an active order, but not yet completed.
The current date is earlier than the requested date for the Disconnect transaction to be cancelled.
Expected Results
Page 172 of 350

Partner requests Cancel Disconnect - createSLOrder
Page 173 of 350

The class diagram below describes the objects involved in the WSDL messages that are exchanged as
part this business transaction and the relationships that exist among them.
-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-B2BPartnerID
ServiceOrderHeader
1
-ProductID
-OrderAction
-OrderType
-ExternalOrderID
-Comments
-ReasonCode
-ReasonComments
Page 174 of 350

Page 175 of 350

-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-OriginalMessageID
-B2BPartnerID
1
1
NotificationHeader
-NotificationType
-DateTime
1 WTN
-NPA
-StartNum
-ProductID
1 -OrderAction
-OrderType 0..1
-CRD 1
Subscriber
-ExternalOrderID
1 -WTN
-ListOfResultCodes
1 -ToLECCompanyCode
1 11
RateCenter
1 -LATA
-State
ResultCode
-Code
-Message
-Context
Page 176 of 350

Page 177 of 350


string
organization Code designating partner organization submitting a given message
(256)
string Code designating partner department within an organization that submits a given
department
(256) message
string
application Code designating partner application submitting a given message
(256)

timeStamp dateTime
between date and time. 24H time format required. Z denotes time zone. Example:
2001-12-01T15:20:23-05:00 (where -05:00 is explicit time zone used).

√ submitted in input and input-callback messages are returned in output and output-
callback messages. Partner is required to keep this value unique per message for
correlation and auditing purposes.
Partner user identifier. Used for auditing purposes only. Value is logged in Level 3
userID string (32)
systems, but is not sent back to the partner.


Page 178 of 350

serviceOrderHeader
√ Level 3 identifier used to indicate the action an order will initiate. 'Disconnect' for
Cancel of Disconnect order.
of Disconnect order.

transaction: Channel Partner Init. When invalid value submitted, this value will be
used.
B2BPartnerID √ string(40) B2B Partner Identifier. Provided by Level 3 to partner after partner profile is
Page 179 of 350

established in Level 3 systems. A partner may have multiple profiles active at any


resultCode

returned.

benefit.

Page 180 of 350



auditing purposes.

original message.

to is defined.

(ex. Level3_123456)
notificationHeader
serviceOrderHeader
Page 181 of 350




expected


Page 182 of 350



subscriberLine
transaction.



NPA √ string(3)
NXX √ string(3)
Page 183 of 350

listOfResultCodes

resultCode

will be returned.

context string(256)
resultCode

Page 184 of 350



resultCode

returned.
Page 185 of 350

2.2.9 Change Order

Description
This business transaction enables a Level 3 partner to submit a change to a previously submitted request for a new or a port-in telephone number
(applies to VoIP Enhanced Local service only)
o createSLOrder – sent by partner to change a subscriber’s service
The change may be to the subscriber name, DL (Directory Listing), service address, CNAM/LIDB information, or E-911 option.
Earliest CRD is the current date. Latest CRD must be no more than seven business days in the future.
Status Notification and Provide Customer Service Record (CSR) Notification transactions.
Changing subscriber’s address to a different rate center than the TN’s rate center will result in a Geographically Independent Telephone
Number (GITN) and the removal of subscriber’s directory listing. Please see the E-911 Disclaimer description for postSLOrderStatus for
more details.
Prerequisites
A previous order has been successfully submitted and completed by Level 3 systems.
Expected Results
Page 186 of 350

Page 187 of 350

Page 188 of 350

-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-B2BPartnerID WTN
-ExternalBusinessTransactionID -NPA
-NXX
1 -StartNum
-EndNum
1
0..1
ServiceOrderHeader
-ProductID
-OrderAction
-OrderType 1
-CRD
-PartnerSubGroupID SubscriberLine
-ExternalOrderID 1..*
-Comments -Level3SubscriberLineID
0..1 1 -Subscriber -ServicePackage
1 1
-ReasonCode -DirectoryListingInformation
Subscriber -CNAMInformation
-ReasonComments
-BusinessName -ExternalOrderVersion
-FirstName -E911Option
-MiddleInitial 1
-LastName
-Level3SubscriberID
-SubscriberSite 0..1
-ExternalSubscriberID 0..1
1 Address DirectoryListingInformation CNAMInformation

-StreetNumPrefix -TreatmentFlag -CNAM
-StreetNum -Type -BlockCNAM
-StreetNumSuffix -FirstName
SubscriberSite
1 -LastName
-PreDirectional
-Level3SubscriberSiteId -StreetName -DualNameListing
-ServiceAddress 1 -LOA
1 -StreetSuffix
-PostDirectional -ListedAddressIndicator
-Room
-Floor
-Building
-Unit
-City
-State
-ZipCode
-ZipPlus4
-Country
-Comments
Page 189 of 350

Page 190 of 350

Page 191 of 350

Page 192 of 350


partner and Level 3 for general purposes such as
reporting and auditing. These values are determined by
the transaction initiator and are not enforced by Level 3
maximum benefit.

message


message
Time that message is submitted, in standard XML

Schema dateTime datatype. Format: CCYY-MM-
√ DDThh:mm:ssZ, with T acting as a separating character
timeStamp dateTime
between date and time. 24H time format required. Z
denotes time zone. Example: 2001-12-01T15:20:23-


userID string (32) Value is logged in Level 3 systems, but is not sent back
to the partner.

B2BPartnerID √ string(40) after partner profile is established in Level 3 systems. A
partner may have multiple profiles active at any given
Page 193 of 350

point, where the URL to respond to is defined.

correlation and auditing purposes. ID should begin with
Partner’s initials or name (ex. Level3_123456)
serviceOrderHeader
Level 3 identification for a service

productID √ string(4)
Only applies to ProductID 2042

initiate. 'Change' for change order.

order.


externalOrderID string(60) not enforce or utilize this value for any purpose other

externalOrderVersion string(20) does not enforce or utilize this value for any purpose
other than partner-requested reporting.
Reason code for cancellation, disconnection or change of

service image. Single valid value for this transaction:
Channel Partner Init. When invalid value submitted, this
value will be used.
Page 194 of 350

Detailed comments describing reason for this

reasonComments string(256)
cancel/disco
Required if subscriber is changing subscriber information.

subscriber subscriber One and only one subscriber included within a
serviceOrderHeader

subscriberLines

values for E-911Option are: E911 Static, E911 VPC, E911
E911Option string(60) E911Option Customer Provided.
Required if subscriber is changing E911 option.

businessName string(50) Required if subscriber is changing business name
Required if subscriber is changing first or last name.

Middle initial is to be included with first name in this
format: First_M

mismatches are common reasons for LNP failures. To
help ensure LSOG hits, partners are advised to use

Required if subscriber is changing first or last name.

lastName string(50) Suffixes are to be appended to lastName. First + Middle
+ Last less than or equal to 25 chars.

partner's reporting and querying purposes. If partner
Page 195 of 350

does not specify this value, a new subscriber record (and

Partner subscriber identifier, stored in Level 3 systems

for partner's reporting and querying purposes.
subscriberSite subscriberSite
One and only one subscriberSite within a given

subscriberSite
subscriber

createSLOrder message if specified there by partner.
See serviceAddress Class.

serviceAddress address
Required if subscriber is changing service address.

EXAMPLE: 25 W

EXAMPLE: 1/2

EXAMPLE: SW
1/2 SW Camino Ramon Lane NW, Floor 12, Building 2
Page 196 of 350


EXAMPLE: LN

EXAMPLE: NW
1/2 SW Camino Ramon Lane NW, Floor 12, Building 2,
Suite 23A.

room string(10)
Floor Designation
EXAMPLE: 12
EXAMPLE: 2

EXAMPLE: STE

EXAMPLE: 23A
Page 197 of 350


√ WTN or Level3SubscriberLineID is required to specify

subscriberLine subscriberLine
active service to be changed.

subscriberLine
May be provided in place of WTN to specify active

service to be changed.
Identifier generated by Level 3 systems for this
Level3SubscriberLineID integer subscriber line. This attribute will not be seen until the
Complete notification is received. May be utilized by
partner for subsequent reporting, correlation or other
related purposes.
servicePackage string(60) SvcPackage Required if subscriber is changing service package.
WTN WTN Required if Level3SubscriberLineID is null
Page 198 of 350

match the externalBusinessTransactionID of
this Submit New Install Order transaction, for
this B2BPartnerID.
CNAMInformation CNAMInformation Required if subscriber is changing CNAM information
directoryListingInformation directoryListingInformation Required if subscriber is changing DL information
WTN
NPA √ string(3)
NXX √ string(3)
CNAMInformation

CNAM string(15)
Page 199 of 350

Only 'Keep' and 'Remove' listing treatments are

supported for port-in scenarios.
√ Only ‘Add’ listing treatment is supported for New TNs

scenarios.
scenarios.

number only): 1 (List and Publish); 2 (List Only); 3 (Do
Not List or Publish)

middle name(s) and initials. If there is no continuation of
the name for the Business listing or if the residence
listing has no first name, this field is not required. The
following characters are not valid and will not print in a
directory:
• , comma
• + plus sign
• ; semicolon
• = equal sign
• - - consecutive hyphens.
Page 200 of 350

Required if 'Treatment Flag' = Add. Indicates the full last

• ; semicolon
• , comma
• + plus sign
• ; semicolon
lastName string(50) • = equal sign
• # pound sign
• ? question mark
• $ dollar sign
• ampersand
• - - consecutive hyphens.

√ directoryListingInformation.firstName should be
dualNameListing string(1) yesNo
interpreted as two first names (e.g. firstName = John &
Jane).

LOA string(1) yesNo
has been granted
Page 201 of 350




resultCode

returned.
requestMessageHeader requestMessageHeader information may be utilized by partner and
Page 202 of 350




timeStamp √ dateTime separating character between date and time. 24H time format required.
Z denotes time zone. Example: 2001-12-01T15:20:23-05:00 (where -
05:00 is explicit time zone used).

√ submitted in input and input-callback messages are returned in output
and output-callback messages. Partner is required to keep this value
unique per message for correlation and auditing purposes.
Same as requestMessageHeader.messageID of corresponding input

√ message. Valid for callback messages only. Partner is advised to use
this value to correlate a callback or notification to the related original
message.

defined.

supp, or cancel).
purposes. ID should begin with Partner’s initials or name (ex.
Level3_123456)
notificationHeader
Page 203 of 350

serviceOrderHeader
Identifier assigned by Level 3 systems when the order is accepted. May

be utilized by partner for subsequent reporting, correlation or other
related purposes.
√ This ID will be assigned in the Submit notification. If order receives an

Error notification in lieu of a Submit notification, the ID will not be
assigned.
A new Level3ParentOrderID will be assigned for Disconnect and
Change Order transactions.

Partner Order ID stored by Level 3 systems. Level 3 does not enforce or


externalOrderVersion string(20) enforce or utilize this value for any purpose other than partner-requested
reporting.
orderStatus √ string(25) See state transition diagrams for specific values that can be expected.
Page 204 of 350

Disclaimer associated with chosen E-911Option. The text included is:

E911 Static: This subscriber will be activated using E-911. In the event a
Public Safety Answering Point is not E-911-enabled, your subscriber will
be activated using a permanent 911 solution to the extent technically
feasible. All 911 Services and E-911 Services provided by Level 3 are
provided by Level 3 Communications, LLC and are subject to applicable
tarrifs.
E911 VPC: Level 3 has accepted this order. Your company is
responsible for ensuring the information for the subscriber associated
with this Telephone Number is provided to the VPC. Your subscriber will
E911 Disclaimer √ string(1000) not be provisioned with 911 service until your company has provisioned
them with your VPC.
If Change Order results in a GITN, this text will be appended to E911
VPC disclaimer: If this subscriber previously had DL, it has been
removed due to an address change resulting in a GITN.
E911 Customer Provided: Level 3 is not providing a 911 solution to this
subscriber. Per the terms of your agreement with Level 3, your company
is responsible for providing 911 to this subscriber.
If Change Order results in a GITN, this text will be appended to E911
Customer Provided disclaimer: If this subscriber previously had DL, it
has been removed due to an address change resulting in a GITN.
Specifies the 911 solution the subscriber opts to use. Valid values for E-
911Option are: E911 Static, E911 VPC, E911 Customer Provided.
Same as subscriber.Level3SubscriberID within createSLOrder message

Level3SubscriberID √ integer if specified there by partner. Otherwise, generated by Level 3 systems
for new subscriber record.

Page 205 of 350

Same as subscriberSite.Level3SubscriberISiteID within createSLOrder

Level3SubscriberSiteID √ integer message if specified there by partner. Otherwise, generated by Level 3
systems for new subscriber site record.


√ attribute will not be seen until the Complete notification is received. May
related purposes.


√ Description of order details. Currently only required for change orders

orderSummary orderSummary
(orderAction = Change; orderType = New)
NPA √ string(3)
NXX √ string(3)
Page 206 of 350

orderSummary
listOfChangeType √ listOfChangeType
listOfChangeType When present, contains list of one or more changeType objects
changeType √ changeType
changeType
changeName √ string(512) ChangeName
listOfResultCodes

resultCode
On successful transactions, only one resultCode (the success code) will

be returned.
code √ string(20) On error situations, only one resultCode is currently returned; however,
future functionality may support the return of one or more codes for
transactions that may raise several exceptions.
context string(256) Contextual addendum to description, clarifying the source of the
Page 207 of 350

resultCode



resultCode

returned.
Page 208 of 350

2.2.10 Cancel of Change Order

Description
This business transaction enables a Level 3 partner to cancel the request to change an active service (applies to VoIP Enhanced Local service
only).
o createSLOrder – sent by partner to cancel a change order
Supplements, install cancellations, disconnect cancellations, and change cancellations are related to the transactions they operate on via
Prerequisites
The Change Order transaction to be cancelled has been successfully submitted for an active order, but not yet completed.
The current date is earlier than the CRD (Customer Request Date) for the Change Order transaction to be cancelled.
Expected Results
Page 209 of 350

Page 210 of 350

Page 211 of 350

Page 212 of 350

-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-OriginalMessageID
-B2BPartnerID
1
1
NotificationHeader
-NotificationType
-DateTime
1 WTN
-NPA
-StartNum
-ProductID
1 -OrderAction
-OrderType 0..1
-CRD 1
Subscriber
-ExternalOrderID
1 -WTN
-ListOfResultCodes
1 -ToLECCompanyCode
1 11
RateCenter
1 -LATA
-State
ResultCode
-Code
-Message
-Context
Page 213 of 350

Page 214 of 350


string
organization Code designating partner organization submitting a given message
(256)
string Code designating partner department within an organization that submits a given
department
(256) message
string
application Code designating partner application submitting a given message
(256)

timeStamp dateTime
between date and time. 24H time format required. Z denotes time zone. Example:
2001-12-01T15:20:23-05:00 (where -05:00 is explicit time zone used).

√ submitted in input and input-callback messages are returned in output and output-
callback messages. Partner is required to keep this value unique per message for
correlation and auditing purposes.
Partner user identifier. Used for auditing purposes only. Value is logged in Level 3
userID string (32)
systems, but is not sent back to the partner.


Page 215 of 350

serviceOrderHeader
Level 3 identification for a service

productID √ string(4)
Only applies to productID 2042
√ Level 3 identifier used to indicate the action an order will initiate. 'Change' for
Cancel of Change order.
of Change order.

transaction: Channel Partner Init. When invalid value submitted, this value will be
used.
Page 216 of 350




resultCode

returned.

benefit.

Page 217 of 350



auditing purposes.

original message.

to is defined.

(ex. Level3_123456)
notificationHeader
serviceOrderHeader
Page 218 of 350




expected.


Page 219 of 350



subscriberLine
transaction.



NPA √ string(3)
NXX √ string(3)
Page 220 of 350

listOfResultCodes

resultCode

will be returned.

context string(256)
resultCode

Page 221 of 350



resultCode

returned.
Page 222 of 350

2.2.11 Read Order

Description
This business transaction enables a Level 3 partner to query order-related information for a specific in-progress order. Partner must identify one
and only one to be queried.
This may be done by specifying either businessTransactionHeader.externalBusinessTransactionID and serviceOrderHeader.Level3ParentOrderID

or businessTransactionHeader.externalBusinessTransactionID and serviceOrderHeader.externalOrderID as criteria. To further restrict the output,
you may also specify a TN.
Note: only information about orders submitted via the B2B Gateway (as opposed to the Customer Portal) may be retrieved using this transaction.
o readOrder – sent by partner to query an active order
o readOrderResponse – sent by Level 3 to respond with processing results
Prerequisites
A previous order has been successfully submitted and accepted, but not yet completed by Level 3 systems.
Expected Results
Successful response
Failed response – see error message for reason.
Page 223 of 350

Partner requests Read Order - readOrder
Level 3 sends results - readOrderResponse
Page 224 of 350

2.2.11.2.1 readOrder Element
Page 225 of 350

2.2.11.2.2 readOrderResponse Element

Valid Values in List Valid Values in List
- Move - Subscriber Name
- Service Package - CTI
- CNAM - BTN Old Carrier
- DL - CRD
- Subscriber Name
RequestMessageHeader BusinessTransactionHeader - Customer Service Name
SuppType
-MessageID -B2BPartnerID
-TimeStamp -ExternalBusinessTransactionID JeopardyInformation -SuppName
1 1 -JeopardyCode ChangeType
0..* 1 1 -JeopardyDescription 0..*
-ChangeName
ResultCode
-Code 0..*
1
ServiceOrderHeader 0..* 1
-Message 1
-Level3ParentOrderID 1
-Context
-ProductID
-OrderAction
0..1 LNPInformation
-OrderType 1 -PortDirection
LNPEvents OrderSummary
-CRD
-EventName -PartnerSubGroupID -LOA -listOfChangeType
-DateTimeStamp -ExternalOrderID -LOADateTime -listOfSuppType
0..* 1 0..1
-Comments -TPVPVN -SuppAllowedIndicator
-LNPIndicator -TPVSentDateTime -SuppEarliestCRD
-OrderStatus -BTNOldCarrier -SuppLatestCRD
0..* -Subscriber -LNPState
1
LNPOption -ListOfSubscriberLines -ListOfJeopardyInformations
WTN
-OptionValue -FOCDate
-BillStartDate 1 -NPA
0..1 1
-BillStopDate -NXX
-InstalledDate -StartNum
-ListOfResultCodes -EndNum
-ExternalOrderVersion 1
-LNPInformation SubscriberLine
1
-CSRInformation -Level3SubscriberLineId
1 -ReasonCode -ServicePackage 0..1
1
-ReasonComments 1..* -CTI CNAMInformation
1
-FirstUsageFlag -WTN
Subscriber -CNAM
-E911Option -DirectoryListingInformation -BlockCNAM
-BusinessName -InternalPortFlag -FromLECCompanyCode 1
-FirstName -LECResponseDate -ToLECCompanyCode
-MiddleInitial -CNAMInformation 0..1 DirectoryListingInformation
-LastName -ListOfOrderSummary
-Level3SubscriberID 1 -CustomerServiceName -TreatmentFlag
-ExternalSubscriberID -Type
-SubscriberSite -FirstName
-LastName
-DualNameListing
1 -LOA
Address 1 -ListedAddressIndicator
-StreetNumPrefix
-StreetNum CSRInformation
-StreetNumSuffix
SubscriberSite
1 -AccountTelephoneNumber
-PreDirectional
-CompanyCode
-Level3SubscriberSiteID -StreetName
-CustomerCode
-MainCallBackNumber -StreetSuffix
-SentTimeStamp 1
-ServiceAddress -PostDirectional
1 -FreezePIC
1 -Room
-LPIC Address
-Floor
-PIC
-Building -StreetNumPrefix
-TransactionType
-SecondaryLocationDescription -StreetNum
-EndUserName
-Unit -StreetNumSuffix
-DateReceived
-City -PreDirectional
-ListOfFeatureFlags 1
-State 1 -StreetName
-CSRAddress
-ZipCode -StreetSuffix
-WTN
-ZipPlus4 -PostDirectional
-Country -Room
-Comments 1 -Floor
-ConcatenatedAddress -Building
-Unit
FeatureFlag
-City
-FeatureCode 0..* -State
-FeatureName -ZipCode
-ZipPlus4
-Country
-Comments
Page 226 of 350

2.2.11.3 Input Message Parameters - readOrder
requestMessageHeader information may be utilized by partner

and Level 3 for general purposes such as reporting and auditing.
These values are determined by the transaction initiator and are
requestMessageHeader not enforced by Level 3 beyond datatype and optionality;
however Level 3 recommends that careful consideration be given
to the definition and consistent use of these values to derive
maximum benefit.

message


timeStamp √ dateTime acting as a separating character between date and time. 24H
time format required. Z denotes time zone. Example: 2001-12-

required to keep this value unique per message for correlation

userID string (32)

√ partner profile is established in Level 3 systems. A partner may
have multiple profiles active at any given point, where the URL to
respond to is defined.
√ Partner’s identifier for a new order life-cycletransaction, which

externalBusinessTransactionID string(40)
Page 227 of 350


(ex. Level3_123456)
serviceOrderHeader
Level3ParentOrderID string(60) Level 3 identifier for order to be queried

Partner Order Version stored by Level 3 systems. Level 3 does

externalOrderVersion string(20) not enforce or utilize this value for any purpose other than
listOfSubscriberLines listOfSubscriberLines A listOfSubscriberLines includes one to many subscriberLines

subscriberLine
transaction.
WTN WTN WTN to be queried. Optional query criterion
0 or one WTN within a given subscriberLine. Optional query

WTN
criterion.
NPA √ string(3)
NXX √ string(3)
Page 228 of 350

flexibleAttribute
Valid value is ‘CSRInformationRequired’. Used to retrieve

subscriber’s CSR information.
value string(80) FlexibleAttr.Value Valid value is ‘Y’ or ‘N’.
2.2.11.4 Output Message Parameters - readOrderResponse
√ Time that message is submitted, in standard XML Schema dateTime

timestamp dateTime
datatype

defined.

supp, or cancel).
Level3_123456)
serviceOrderHeader
Page 229 of 350


Partner Order ID stored by Level 3 systems. Level 3 does not enforce or


Comments string(512)
orderStatus √ string(25) See state transition diagrams for specific values that can be expected.

FOCDate date port. If LNPIndicator = N, FOCDate holds customer commitment date for
order activation.
billStartDate date
billStopDate date
installedDate date
Reason code for cancellation, disconnection or change of service

reasonCode String(40) ReasonCode
image. Single valid value for this transaction: Channel Partner Init.
Page 230 of 350

When invalid value submitted, this value will be used.
reasonComments string(256) Detailed comments describing reason for this cancel/disco
Subscriber √ subscriber One and only one subscriber included within a serviceOrderHeader
√ listOfSubscrib
listOfSubscriberLines A listOfSubscriberLines includes one to many subscriberLines
erLines
√ listOfResultC
listOfResultCodes A listOfResultCodes includes 0 to many result code elements
odes
LNPInformati
LNPInformation Required if serviceOrderHeader.LNPInidicator = Y
on
CSRInformati One and only one CSRInformation record within a given

CSRInformation
on ServiceOrderHeader
firstUsageFlag String(1) yesNo
Specifies the 911 solution the subscriber opts to use. Valid values for E-
911Option are: E911 Static, E911 VPC, E911 Customer Provided.
Indicates whether the TN on the request is currently active on the

internalPortFlag string(1) yesNo Level 3 Network. This impacts the time to port the number to the new
provider.
The estimated response date from the losing LEC for the estimated
LECResponseDate date
FOC date or jeopardies/warnings on the order.
Summary of all the LNP activity which has occurred on the order to
LNPEvents
date.
EventName string(50)
DateTimeStamp date
LNPOption
OptionValue string(50) Available based on partner profile.
Page 231 of 350

businessName string(50) Required if subscriber has one or more subscriber lines where CTI = B
firstName string(50) Subscriber first name on record
Subscriber middle initial on record

lastName string(50) Subscriber last name on record
Level 3 subscriber identifier, stored in Level 3 systems for partner's

√ reporting and querying purposes. If partner does not specify this value,
a new subscriber record (and identifier) is generated and returned within
the postSLOrderStatus callback message.

√ subscriberSit
subscriberSite
e
Same as subscriberSite.Level3SubscriberISiteID within createSLOrder

Level3SubscriberSiteID √ integer message if specified there by partner. Otherwise, generated by Level 3
systems for new subscriber site record.
mainCallBackNumber string(18) Main Call-back number to be used in case of Business

EXAMPLE: 25 W
example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building
2, Suite 23A.
streetNumSuffix string(4) Street number suffix. Optional when StreetNum is populated. Otherwise,
Page 232 of 350

ignored.
EXAMPLE: 1/2
Where 1/2 is the street number suffix for the following address example:
25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building 2, Suite
23A.

EXAMPLE: SW
preDirectional string(2) Directional following address example: 25W 450 1/2 SW Camino Ramon Lane NW,
Floor 12, Building 2

EXAMPLE: LN
Where LN is the street suffix for the following address example: 25W

EXAMPLE: NW
postDirectional string(2) Directional following address example: 25W 450 1/2 SW Camino Ramon Lane NW,
Room Designation. Distinct from Unit. Sample use: Room within a Unit,
Room string(10)
i.e. Room 100, Hangar A.
Floor Designation
EXAMPLE: 12
Floor string(10)
EXAMPLE: 2
Building string(10)
Where 2 is building for the following address example: 25W 450 1/2 SW

secondaryLocationDescription string(4) LocDescriptor EXAMPLE: STE
Where STE is the secondary location description for the following
Page 233 of 350

address example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12,

EXAMPLE: 23A
unit string(10)
Where 23A is the unit number for the following address example: 25W
City √ string(25) City
State √ string(2) State State Abbreviation
Country √ string(25) Country. Valid value is ‘USA’.
Comments string(512)
An unparsed address will be returned if the corresponding order utilized

concatenatedAddress string(256) this element at time of order submission.


√ attribute will not be seen until the Complete notification is received. May
related purposes.

CTI √ string(1) CTI Maintained by Level 3 systems at subscriberLine level to support home
office scenarios, where both business and residential lines may exist.
WTN WTN Ordered WTN.
Page 234 of 350



The Customer Service Name is a customer-definable field that identifies

a particular IP address and routing policy. When applied to a subscriber
order, this routing information defines the IP address or addresses to
send traffic, or how to balance traffic across several IP addresses. The
customerServiceName √ string(15)
typical customer scenario involves a single Customer Service Name
definition, but multiple Customer Service Names may be set up based
on customer needs. Please contact your Account Manager for more
information on this configuration.
CNAMInform
CNAMInformation
ation
directoryListin
gInformation
listofOrderSu Description of order details. Currently only required for change orders
listofOrderSummary
mmary (orderAction = Change; orderType = New).
WTN
NPA √ string(3)
NXX √ string(3)
CNAMInformation

CNAM string(15) Verisign convention: uppercase LASTNAME FIRSTNAME, truncated to
15 characters. Symbols and special characters are not permitted.
Page 235 of 350

Only 'Keep' and 'Remove' listing treatments are supported for port-in
scenarios.
√ ListingTreatme
treatmentFlag string(10)
nt Only ‘Add’ listing treatment is supported for New TNs scenarios.

DL is not supported for a GITN (Geographically Independent Telephone
ListingTreatme Number). Type = ‘3’.
type string(1)
ntType If a subscriber’s directory listing is LISTED, it will be available by calling
411.
If a subscriber’s directory listing is PUBLISHED, it will be printed in the
local phone book.

dualNameListing √ string(1) yesNo directoryListingInformation.firstName should be interpreted as two first
names (e.g. firstName = John & Jane).

LOA string(1) yesNo
orderSummary
listOfChange
listOfChangeType
Type
listOfSuppTy
listOfSuppType
pe
Informational attribute identifying the type of supp transaction available.

suppAllowedIndicator string(30)
Types include: “All,” “CRD” or “None.”
Page 236 of 350

suppEarliestCRD date Earliest customer request date for a subsequent supp order submission
suppLatestCRD date Latest customer request date for a subsequent supp order submission
changeType
suppType

resultCode

be returned.
code √ string(20) On error situations, only one resultCode is currently returned; however,

context string(256)
resultCode

LNPInformation
Indicates whether authorization to port number has been granted.

LOA string(1) yesNo
Required when TPVPVN is not provided; must be Y for LNP orders.
Timestamp when LNP LOA received, in standard XML Schema

LOADateTime dateTime
dateTime datatype. Required when TPVPVN is not provided.
Reference number for Third Party Validation record. Required when

TPVPVN number(10) LOA and LOADateTime not provided. Use in place of LOA
/LOADateTime only when contractually permitted.
Timestamp when TPV Sent. Must be GMT. Required when LOA and
TPVSentDateTime dateTime
LOADateTime not provided. Use in place of LOA/LOADateTime only
Page 237 of 350

when contractually permitted.
Required for LNP Orders. Subscriber’s BTN (Billing Telephone

BTNOldCarrier string(10) Number) with the old carrier. It may or may not be the same as the
porting TN.
LNPState string(10) State of LNP porting progress
listOfJeopard
listOfJeopardyInformations A listOfJeopardyInformations includes one to many JeopardyInformation
yInformations
wirelessLNPIndicator √ string(1) yesNo Required for wireless LNP
Required for wireless LNP.If TN is wireless, either Wireless Subscriber

SSN OR wirelessSubscriberAccountNumber must be popluated.
Proper Format (include zeros where shown, where 1234 would be the
wirelessSubscriberSSN √ string(11) actual values for subscriber
000-00-1234 for SSN (individual)
00-0001234 for Tax ID number (business)
Required for wireless LNP.If TN is wireless, either Wireless Subscriber

wirelessSubscriberAccountNumber √ string(20) SSN OR wirelessSubscriberAccountNumber must be popluated.
Proper Format = Last 4 digits only (along with leading zeros)
Optional - if the subscriber is entering their Wireless Account Number

WirelessSubscriberAccountPIN string(15) AND the subscriber has set up a password or PIN with their wireless
carrier then the PIN is required
JeopardyInformation
jeopardyCode string(20) On LNP error situations, one or many jeopardy codes can be returned.
jeopardyDescription string(200) Detailed description for each jeopardy code
CSRInformation
accountTelephoneNumber string
companyCode string
Page 238 of 350

customerCode string
sentTimeStamp string
freezePIC string
LPIC string
PIC string
transactionType string
endUserName string
dateReceived string
listOfFeature
listOfFeatureFlags
Flags
CSRAddress √ Address
WTN WTN WTN to which this CSR corresponds
Subscriber line feature that may impact the portability of this subscriber
featureFlag
line
featureCode √ String
featureName √ String
address (CSRAddress)

EXAMPLE: 25 W
example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building
2, Suite 23A.
Page 239 of 350

Street number suffix. Optional when StreetNum is populated. Otherwise,

ignored.
EXAMPLE: 1/2
Where 1/2 is the street number suffix for the following address example:
25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building 2, Suite
23A.

EXAMPLE: SW
preDirectional string(2) Directional following address example: 25W 450 1/2 SW Camino Ramon Lane NW,
Floor 12, Building 2

EXAMPLE: LN
Where LN is the street suffix for the following address example: 25W

EXAMPLE: NW
postDirectional string(2) Directional following address example: 25W 450 1/2 SW Camino Ramon Lane NW,
Room Designation. Distinct from Unit. Sample use: Room within a Unit,
room string(10)
i.e. Room 100, Hangar A.
Floor Designation
EXAMPLE: 12
floor string(10)
EXAMPLE: 2
building string(10)
Where 2 is building for the following address example: 25W 450 1/2 SW
Page 240 of 350


EXAMPLE: STE
address example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12,

EXAMPLE: 23A
unit string(10)
Where 23A is the unit number for the following address example: 25W
Page 241 of 350

2.2.12 Read Service Image

Description
This business transaction enables a Level 3 partner to query service image-related information (completed orders) for a specific subscriber line
service image, identified by Level3SubscriberLineID or TN.
Note: only information about orders submitted via the B2B Gateway (as opposed to the Customer Portal) may be retrieved using this transaction.
o readServiceImage – sent by partner to query a service image
o readServiceImageResponse – sent by Level 3 to respond with processing results
Prerequisites
A previous order has been successfully submitted, accepted, and completed by Level 3 systems.
Expected Results
Successful response
Failed response – see error message for reason.
Page 242 of 350

Page 243 of 350

2.2.12.2.1 readServiceImage Element
Page 244 of 350

2.2.12.2.2 readServiceImageResponse Element
Page 245 of 350

2.2.12.3 Input Message Parameters - readServiceImage




purposes.

userID string (32)

defined.

supp, or cancel).
Page 246 of 350


Level3_123456)
serviceOrderHeader

subscriberLine Either Level3SubscriberLineID or WTN must be specified as query
criteria.
Identifier generated by Level 3 systems for this subscriber line. May

Level3SubscriberLineID integer be utilized by partner for subsequent reporting, correlation or other
related purposes.
WTN WTN WTN to be queried. Optional query criterion.
WTN 0 or one WTN within a given subscriberLine. Optional query criterion.
NPA √ string(3)
NXX √ string(3)
2.2.12.4 Output Message Parameters - readServiceImageResponse
Page 247 of 350

√ Time that message is submitted, in standard XML

timeStamp dateTime
Schema dateTime datatype
√ Same as requestMessageHeader.messageID of
responded-to message

√ after partner profile is established in Level 3 systems.
A partner may have multiple profiles active at any
Partner’s identifier for a new order life-

cycletransaction, which consists of one or more
individual business transactions or dialogues (for new,
externalBusinessTransactionID √ string(40) supp, or cancel).
correlation and auditing purposes. ID should begin
with Partner’s initials or name (ex. Level3_123456)
serviceOrderHeader
√ Same as Level3ParentOrderID of responded-to

message.
Reason code for cancellation or disconnection of

reasonCode string(40) ReasonCode service image (required if service image was
cancelled or disconnected)
Detailed comments describing reason for this

reasonComments string(256)
cancel/disco
If LNPIndicator = Y, FOCDate holds firm order

commitment date for port. If LNPIndicator = N,
FOCDate date
FOCDate holds customer commitment date for order
activation.
Page 248 of 350

billStartDate date
billStopDate date
installedDate date

serviceOrderHeader

subscriberLines
√ A listOfResultCodes includes 0 or one result code

element
Specifies the 911 solution the subscriber opts to use.

E911Option √ string(60) E911Option Valid values for E-911Option are: E911 Static, E911
VPC, E911 Customer Provided.

subscriber
serviceOrderHeader.
Required if subscriber has one or more subscriber

lines where CTI = B
firstName string(50) Subscriber first name on record
Subscriber middle initial on record

lastName string(50) Subscriber last name on record
Level 3 subscriber identifier, stored in Level 3 systems

for partner's reporting and querying purposes. If
Level3SubscriberID √ integer partner does not specify this value, a new subscriber
record (and identifier) is generated and returned within
the postSLOrderStatus callback message.
Partner subscriber identifier, stored in Level 3 systems

for partner's reporting and querying purposes
Page 249 of 350

One and only one subscriberSite within a given

subscriberSite
subscriber
Same as subscriberSite.Level3SubscriberISiteID
√ within createSLOrder message if specified there by
partner. Otherwise, generated by Level 3 systems for
new subscriber site record.
mainCallBackNumber string(18) Main Call-back number to be used in case of Business

EXAMPLE: 25 W

EXAMPLE: 1/2

EXAMPLE: SW
preDirectional string(2) Directional directional for the following address example: 25W
450 1/2 SW Camino Ramon Lane NW, Floor 12,
Building 2
Page 250 of 350


EXAMPLE: LN

EXAMPLE: NW
postDirectional string(2) Directional directional for the following address example: 25W
450 1/2 SW Camino Ramon Lane NW, Floor 12,

room string(10)
Floor Designation
EXAMPLE: 12
EXAMPLE: 2

EXAMPLE: STE
23A.

EXAMPLE: 23A
Page 251 of 350

An unparsed address will be returned if the

corresponding order utilized this element at time of
concatenatedAddress string(256) order submission.

subscriberLine
supports one and only one subscriberLine within a
given serviceOrderHeader for this transaction.
Identifier generated by Level 3 systems for this

√ subscriber line. May be utilized by partner for
subsequent reporting, correlation or other related
purposes.
servicePackage string(60) SvcPackage
Customer Type Indicator. B=Business, R=Residential.
CTI √ string(1) CTI Maintained by Level 3 systems at subscriberLine level

to support home office scenarios, where both business
and residential lines may exist.
WTN WTN Ordered WTN. Required unless error encountered.
Page 252 of 350

Required within subscriberLine if no errors

WTN
encountered
NPA √ string(3)
NXX √ string(3)
Can be used in validation API but not in order entry

endNum string(4)
API
CNAMInformation
Not required if BlockCNAM = ‘Y’. CNAM calculation

rules follow the Verisign convention: uppercase
CNAM string(15)
LASTNAME FIRSTNAME, truncated to 15 characters.
Symbols and special characters are not permitted.

number only): 1 (List and Publish); 2 (List Only); 3 (Do
Not List or Publish)
If a subscriber’s directory listing is PUBLISHED, it will
be printed in the local phone book.
Page 253 of 350


directoryListingInformation.firstName should be
dualNameListing string(1) yesNo
interpreted as two first names (e.g. firstName = John
& Jane).
listOfResultCodes

transaction

code string(20)
√ Description of result code; required when resultCode

message string(256)
is present

context string(256)
Page 254 of 350

2.2.13 Real-Time Port Request

Description
This business transaction enables a Level 3 partner to trigger the porting of a telephon number.
o portTN – sent by partner to trigger a port
o portTNResponse – sent by Level 3 to respond with processing results
Real-time port may be requested on the same day as the FOC date, or after the FOC date if TN has not auto-ported.
Please note that successful execution of ADOPT (Active Day Of Port Trigger) requires that the participating transactions be correlated
using businessTransactionHeader.externalBusinessTransactionID
If a request is made to port a number for any order submitted through the Portal, all TN’s associated to that order will be activated. In
order to request the port of any Portal service request, either the Level3ParentOrderID or TN must be specified. Although the
externalBusinessTransactionID is required in the context of this request, it will not be validated due to a lack of such variable with Portal
submitted orders.
Prerequisites
Partner profile must be set up to use this transaction.
An LNP order has been successfully submitted, but number has not ported yet.
Expected Results
Telephone number will begin the porting process. (portTNResponse)
Error message that port could not be triggered (portTNResponse)
Page 255 of 350

Page 256 of 350

The class diagram below describes the objects involved in the WSDL messages that are exchanged as a part of this business transaction and the
relationships that exist among them.
2.2.13.2.1 portTN Element
-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-B2BPartnerID
WTN
-NPA
1
-NXX
-StartNum
0..1
1
1
ServiceOrderHeader 0..1
1
-Level3ParentOrderID SubscriberLine
Page 257 of 350

2.2.13.2.2 portTNResponse Element
-MessageID
-TimeStamp
-B2BPartnerID
1 ServiceOrderHeader
ResultCode
1
-Code 1
-ListOfSubscriberLines 0..*
-Message
-FOCDate
-Context SubscriberLine
-ListOfResultCodes
-WTN
0..1
WTN
-NPA
-NXX
-StartNum
Page 258 of 350

2.2.13.3 Input Message Parameters - portTN




purposes.

userID string (32)

defined.
Page 259 of 350


supp, or cancel).
Level3_123456)
serviceOrderHeader
Same as Level3ParentOrderID of responded-to message
Level3ParentOrderID string(60) Either Level3ParentOrderID or the WTN is required to port any order
submitted through Portal mechanisms in addition to the
externalBusinessTransacationID.
ListOfSubscriberLines √ listOfSubscriberLines A listOfSubscriberLines includes one to many subscriberLines
ListOfSubscriberLines

subscriberLine Note that current release only supports one and only one
subscriberLine within a given serviceOrderHeader for this transaction.
Either Level3ParentOrderID or the WTN is required to port any order

WTN WTN submitted through Portal mechanisms in addition to the
externalBusinessTransacationID.
WTN
NPA string(3)
NXX string(3)
startNum string(4)
Page 260 of 350

2.2.13.4 Output Message Parameters - portTNResponse
√ Time that message is submitted, in standard XML Schema dateTime

timeStamp dateTime
datatype
√ Same as requestMessageHeader.messageID of responded-to

message

defined.

supp, or cancel).
Level3_123456)
serviceOrderHeader

FOCDate date port. If LNPIndicator = N, FOCDate holds customer commitment date
for order activation.
listOfResultCodes √ listOfResultCodes A listOfResultCodes includes 0 or one result code element
subscriberLine subscriberLine
Page 261 of 350


subscriberLine Either Level3SubscriberLineID or WTN must be specified as query
criteria.
• If serviceOrderHeader.LNPIndicator = N and WTN is defined,

this is an order for a new, partner-specified TN. If the TN is
currently reserved, the externalBusinessTransactionID
submitted with the reservation request must match the
externalBusinessTransactionID of this Submit New Install
Order transaction, for this B2BPartnerID.
• If serviceOrderHeader.LNPIndicator = N and WTN is not

defined, this order is for a new TN that will be determined by
WTN WTN Level 3.
• If serviceOrderHeader.LNPIndicator = Y and WTN is defined,

this is an LNP order.
• If serviceOrderHeader.LNPIndicator = Y and WTN is not

defined, this is not valid.
WTN
NPA √ string(3)
NXX √ string(3)
listOfResultCodes

resultCode

Code √ string(20) be returned.
On error situations, only one resultCode is currently returned; however,
Page 262 of 350


Context string(256)
resultCode
Page 263 of 350

2.2.14 CSR Request
Description
This business transaction enables a Level 3 partner to access a subscriber’s Customer Service Record (CSR) prior to submitting an LNP Install
order.
o requestCSR – sent by partner to request a subscriber’s CSR
o requestCSRResponse – sent by Level 3 to acknowledge receipt of partner’s request
o postCSR – notification sent by Level 3 to notify partner with processing results and order status (see Expected Results for all
postSLOrderStatus messages for this transaction)
o postCSRResponse – sent by partner to acknowledge receipt of Level 3’s notification
Prerequisites
CSR Request option is enabled on partner profile
Expected Results
postCSR notification containing subscriber’s CSR.
postCSR notification with error will be provided in lieu of CSR if problems are encountered.
Page 264 of 350

Page 265 of 350

2.2.14.2.1 requestCSR
Page 266 of 350

2.2.14.2.2 requestCSRResponse
Page 267 of 350

2.2.14.2.3 postCSR
-MessageID
JeopardyInformation
-TimeStamp
-JeopardyCode
-JeopardyDescription 1
1
1..*
-B2BPartnerID
1 ResultCode
-Code
1 -Message
1 1 0..* -Context
LNPInformation CSR Header

-ListOfJeopardyInformation -RequestorName
1 -BTN
0..1
-LNPInformation
-listOfCSRInformations
1
Address
-StreetNumPrefix
-StreetNum 1..*
-StreetNumSuffix
WTN
-PreDirectional
-StreetName CSRInformation -NPA
-StreetSuffix -AccountTelephoneNumber 1 -NXX
-PostDirectional -CompanyCode -StartNum
-Room -CustomerCode -EndNum
-Floor -CustomerName 1
-Building 1 -SentTimeStamp
-SecondaryLocationDescription -FreezePIC
-Unit -LPIC
-City 1 -PIC 0..*
1
-State -TransactionType FeatureFlag
-ZipCode -EndUserName
-ZipPlus4 -DateReceived -FeatureCode
-Country -ListOfFeatureFlags -FeatureName
-Comments -CSRAddress
Page 268 of 350

2.2.14.2.4 postCSRResponse
-MessageID
-Organization
-Department
-Application
-TimeStamp
-B2BPartnerID
1..*
ResultCode
-Code
-Message
-Context
Page 269 of 350

2.2.14.3 Input Message Parameters - requestCSR
requestMessageHeader information may be utilized by partner and Level 3 for general

purposes such as reporting and auditing. These values are determined by the
requestMessageHeader transaction initiator and are not enforced by Level 3 beyond datatype and optionality;
however Level 3 recommends that careful consideration be given to the definition and
Code designating partner department within an organization that submits a given

message.
Time that message is submitted, in standard XML Schema dateTime datatype. Format:
√ CCYY-MM-DDThh:mm:ssZ, with T acting as a separating character between date and
timeStamp dateTime
time. 24H time format required. Z denotes time zone. Example: 2001-12-01T15:20:23-
Partner-generated and -managed message identifier. Same messageID submitted in

√ input and input-callback messages are returned in output and output-callback
messages. Partner is required to keep this value unique per message for correlation
businessTransactionHead
er
B2B Partner Identifier. Provided by Level 3 to partner after partner profile is established
B2BPartnerID √ string(40) in Level 3 systems. A partner may have multiple profiles active at any given point,
where the URL to respond to is defined.
Partner’s identifier for a new order life-cycletransaction, which consists of one or more
externalBusines individual business transactions or dialogues (for new, supp, or cancel).
√ string(40)
sTransactionID Partner is required to keep this value unique for correlation and auditing purposes. ID
should begin with Partner’s initials or name (ex. Level3_123456)
If BTN and 0 WTN are specified, CSRs for all WTN corresponding to that BTN will be
retrieved. If no BTN and 1 WTN are specified, a CSR will be retrieved corresponding to
CSRHeader
that WTN. If a BTN and 1 WTN are specified a CSR for the BTN and a CSR for WTN
will be retrieved if they are different.
Page 270 of 350

The Billing Telephone Number. If a CSR is requested for a list of TNs, a BTN must be
provided.
BTN string(10)
Note, a single BTN, a single WTN, or both must be provided. Only one BTN per CSR
request.
Customer contact name for order. The authorization name is the name of the person
requesterName string(50)
from the Level 3 customer that is authorizing to pull a particular CSR.
flexibleAttribute
name string(80)
value string(80)
WTN Zero to one to many WTNs within a given validationHeader
NPA √ string(3)
NXX √ string(3)
Used to specify a sequence of contiguous TNs to validate. Must be different from

endNum string(4)
StartNum. Can be used in validation API but not in order entry API
One and only one subscriber within a given serviceOrderHeader. Titles are to be
subscriberName
prepended to firstName and suffixes are to be appended to lastName.
Required if subscriber has one or more subscriber lines where CTI = B. Invalid if CTI =
R
Required if subscriber has one or more subscriber lines where CTI = R. Invalid if CTI =
B
Middle initial is to be included with first name in this format: First_M
Titles are to be prepended to firstName. First + Middle + Last less than or equal to 25
chars for LNP orders. This restriction is imposed by LSOG repository. LSOG
mismatches are common reasons for LNP failures. To help ensure LSOG hits, partners
are advised to use subscriber name as it appears in existing phone bills.
Page 271 of 350


Required if subscriber has one or more subscriber lines where CTI = R. Invalid if CTI =
B.
lastName string(50)
Suffixes are to be appended to lastName. First + Middle + Last less than or equal to 25
chars

CTI √ string(1) CTI Maintained by Level 3 systems at subscriberLine level to support home-office
scenarios, where both business and residential lines may exist.

EXAMPLE: 25 W
Where 25W is the street number prefix for the following address example: 25W 450 1/2

EXAMPLE: 1/2
Where 1/2 is the street number suffix for the following address example: 25W 450 1/2

EXAMPLE: SW
preDirectional string(2) Directional Where SW is the Street directional prefix or pre-directional for the following address
example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building 2

EXAMPLE: LN
Page 272 of 350


EXAMPLE: NW
postDirectional string(2) Directional Where NW is the Street directional suffix or post-directional for the following address
example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building 2, Suite 23A.
Room Designation. Distinct from Unit. Sample use: Room within a Unit, i.e. Room 100,
room string(10)
Hangar A.
Floor Designation
EXAMPLE: 12
floor string(10)
Where 12 is the floor for the following address example: 25W 450 1/2 SW Camino
EXAMPLE: 2
building string(10)

secondaryLocati EXAMPLE: STE
string(4) LocDescriptor
onDescription Where STE is the secondary location description for the following address example:
25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building 2, Suite 23A.

EXAMPLE: 23A
unit string(10)
Where 23A is the unit number for the following address example: 25W 450 1/2 SW
Page 273 of 350

An unparsed address will be returned if the corresponding order utilized this element at
concatenatedAd time of order submission.
string(256)
dress
2.2.14.4 Output Message Parameters – requestCSRResponse

responseMessageHeader by the transaction initiator and are not enforced by Level 3 beyond datatype and

message.

timeStamp dateTime

Page 274 of 350



√ string(40)
Indicator of success or failure of an overall business transaction or specific

resultCode
aspect of a given business transaction

returned.
Context string(256) Contextual addendum to description, clarifying the source of the resultCode
2.2.14.5 Input Callback Message Parameters – postCSR

√ Time that message is submitted, in standard XML Schema dateTime datatype.

timeStamp dateTime
Format: CCYY-MM-DDThh:mm:ssZ, with T acting as a separating character
Page 275 of 350




√ string(40)
CSRHeader
BTN string(10) The Billing Telephone Number.
Customer contact name for order. The authorization name is the name of the
requesterName string(50)
person from the Level 3 customer that is authorizing to pull a particular CSR.
LNPInformation LNPInformation
listOfCSRInformatio
Includes one to many CSRInformation.
ns

LNPInformation
listOfJeopardyInfor listOfJeopardyI
Includes one to many JeopardyInformation.
mations nformations
jeopardyInformation
jeopardyCode string(20) On LNP error situations, one or many jeopardy codes may be returned.
jeopardyDescription string(200) Detailed description for each jeopardy code.
Page 276 of 350


resultCode
aspect of a given business transaction.

returned.
Context string(256) Contextual addendum to description, clarifying the source of the resultCode.
CSRInformation
accountTelephoneN
string
umber
companyCode string
customerCode string
freezePIC string
LPIC string
PIC string
endUserName string
dateReceived string
Page 277 of 350

listOfFeatureFl
listOfFeatureFlags
ags
CSRAddress √ address
WTN √ WTN WTN to which this CSR corresponds.
featureFlag Subscriber line feature which may impact the portability of this subscriber line
featureCode √ string Specific subscriber line feature code as recorded in the CSR
featureName √ string Value description of subscriber line feature
WTN One to many WTNs within a given validationHeader
NPA √ string(3)
NXX √ string(3)
Used to specify a sequence of contiguous TNs to validate. Must be different from

endNum string(4)
StartNum. Can be used in validation API but not in order entry API

EXAMPLE: 25 W
Where 25W is the street number prefix for the following address example: 25W

EXAMPLE: 1/2
Where 1/2 is the street number suffix for the following address example: 25W
Page 278 of 350


EXAMPLE: SW
Where SW is the Street directional prefix or pre-directional for the following
preDirectional string(2) Directional address example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building
2

EXAMPLE: LN

EXAMPLE: NW
Where NW is the Street directional suffix or post-directional for the following
postDirectional string(2) Directional address example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building
2, Suite 23A.
Room Designation. Distinct from Unit. Sample use: Room within a Unit, i.e. Room
room string(10)
100, Hangar A.
Floor Designation
EXAMPLE: 12
floor string(10)
Where 12 is the floor for the following address example: 25W 450 1/2 SW
EXAMPLE: 2
building string(10)
Page 279 of 350


EXAMPLE: STE
secondaryLocation
string(4) LocDescriptor Where STE is the secondary location description for the following address
Description
example: 25W 450 1/2 SW Camino Ramon Lane NW, Floor 12, Building 2, Suite
23A.

EXAMPLE: 23A
unit string(10)
Where 23A is the unit number for the following address example: 25W 450 1/2
An unparsed address will be returned if the corresponding order utilized this

concatenatedAddre element at time of order submission.
string(256)
ss
2.2.14.6 Output Callback Message Parameters - postCSRResponse
Page 280 of 350


responseMessageHeader by the transaction initiator and are not enforced by Level 3 beyond datatype and

message.

timeStamp dateTime



√ string(40)

resultCode
aspect of a given business transaction
Page 281 of 350


returned.
Context string(256) Contextual addendum to description, clarifying the source of the resultCode
Page 282 of 350

2.2.15 Order Status Notifications

Description
This business transaction provides Order Status information to the Level 3 partner for a given order when a noteworthy event occurs. The type of
notifications returned varies based on the type of business transaction submitted (for example, notifications returned for a New Install transaction
is different from those returned for a Disconnect transaction). This transaction will always be generated by Level 3. The following types of
notifications may be returned:
Submit notification - successful order submission
FOC notification - availability of FOC date from donor LEC
Install notification - successful installation of order (service activated on Level 3 Network)
Disconnect notification - successful disconnection of service
Complete notification - successful completion of order, including all post-install steps such as 911 provisioning on Level 3 Network and
billing commencement
Error notification
o LNP error provided requiring partner action to resolve the problem (may occur at any point in the order flow).
o LNP error provided not requiring partner action (may occur at any point in the order flow).
o 911 ALI (Automatic Location Information) error provided if address cannot be validated in MSAG (Master Street Address Guide).
The following notifications are detailed in their respective sections:
CSR notification – successful retrieval of Customer Service Record for an LNP Install Order (Detail specific to this notification can be
found in the CSR Notification section)
Level 3 Action notification – Level 3 initiated action on a pending order (Detail specific to this notification can be found in the Level 3
Action Notification section)
The following messages are required for these notifications:
Page 283 of 350

postSLOrderStatus – notification sent by Level 3 to notify partner with processing results and order status
postSLOrderStatusResponse – sent by partner to acknowledge receipt of Level 3’s notification
Please note the FOC date provided by the FOC notification is the actual date of the port committed to by the donor LEC. This will usually be
equivalent to the CRD, but not always. It may be before or after the CRD.
Prerequisites
A previous order has been successfully submitted and accepted by Level 3 systems.
A notification-generating event has occurred.
Expected Results
The partner should expect to:
Receive a notification of types listed above – postSLOrderStatus message
Acknowledge receipt of notification – postSLOrderStatusResponse
Page 284 of 350

2.2.15.1.1 New TN Install
Page 285 of 350

2.2.15.1.2 LNP Install
Page 286 of 350

2.2.15.1.3 Disconnect
Page 287 of 350


Valid Values in List
RequestMessageHeader - Move Valid Values in List
-MessageID - Service Package - Subscriber Name
-Organization - CNAM - CTI
-Department - DL - BTN Old Carrier
-Application - Subscriber Name - CRD
-TimeStamp - Customer Service Name
-UserID
-OriginalMessageID
1 ChangeType SuppType
1 -ChangeName -SuppName
BusinessTransactionHeader 0..* 0..*

1 1
-B2BPartnerID
-LegalBinder
JeopardyInformation 0..1 Feature
-JeopardyCode 1 OrderSummary -Feature
1
-JeopardyDescription -listOfChangeType -FeatureDetail FeatureFlag
-listOFSuppType
0..* NotificationHeader
0..1
11
-NotificationType
-DateTime 0..1
1 1
ServiceOrderHeader
LNPInformation -ProductID
-OrderAction
-LNPState
-OrderType
-ListOfJeopardyInformations 0..1 WTN 1
-CRD
-ExternalOrderID -NPA
-LNPIndicator -NXX CSRInformation
1 -OrderStatus -StartNum 1
1 1 1 -AccountTelephoneNumber
1 -Subscriber
-CompanyCode
-ListOfResultCodes 0..1 -CustomerCode
-ListOfSubscriberLines
-SentTimeStamp
Subscriber -FOCDate
1 -FreezePIC
-L3SubscriberID -BillStartDate
-LPIC
-ExternalSubscriberId -BillStopDate
-PIC
-SubscriberSite 1 -InstalledDate SubscriberLine
1 -TransactionType
-L3SubscriberLineID -EndUserName
-CSRInformation 1..* -WTN -DateReceived
1 -LNPInformation
-FromLECCompanyCode -ListOfFeatureFlags
-L3ParentOrderID 1
-ToLECCompanyCode -ListOfFeatures
-ReasonCode
-RateCenter -CSRAddress
-ReasonComments
-OrderSummary -WTN
-PartnerSubGroupID
-E911Disclaimer -CustomerServiceName
-E911Option 1
-GITNIndicator 1
-wirelessLNPIndicator 1
1 1
1
ResultCode -LATA
-State
-Code
-Message
-Context
Page 288 of 350

Page 289 of 350

2.2.15.3 Input Message Parameters – postSLOrderStatus

requestMessageHeader transaction initiator and are not enforced by Level 3 beyond
datatype and optionality; however Level 3 recommends
that careful consideration be given to the definition and

message


message

timeStamp dateTime


the partner.
Page 290 of 350



Fixed value text describing the legally binding agreement

text included is:

standard Master Service Agreement and Service
Schedules (as of the date of this notice) shall govern,
copies of which are available upon request.
notificationHeader
serviceOrderHeader

Level3ParentOrderID √ string(60) accepted. May be utilized by partner for subsequent
Page 291 of 350


A new Level3ParentOrderID will be assigned for all New
Install, Disconnect, and Change Order transactions.

initiate
√ Level 3 identifier used to indicate the type of an order

action



√ See state transition diagrams for specific values that can

be expected.
Required only for Installation, FOC and Order

FOCDate date Completion/Activation (for Install) notifications. Not
applicable otherwise.
Required only for Installation and Order

billStartDate date Completion/Activation (for Install) notifications Not
Page 292 of 350

Required only for Post-Submit Disconnect, Order

billStopDate date Completion (for Disconnect) and Post-submit Error
notifications. Not applicable otherwise.
Required only for Installation and Order

installedDate date Completion/Activation (for Install) notifications. Not
One and only one CSRInformation record within a given

CSRInformation CSRInformation ServiceOrderHeader. Required if CSRInformationRequired
= “Y” on the initial request
LNPInformation LNPInformation
Reason code for cancellation, disconnection or change of

√ service image. Single valid value for this transaction:
Channel Partner Init. When invalid value is submitted, this
value will be used.

serviceOrderHeader

subscriberLines
Disclaimer associated with chosen E-911Option. The

specific text included is:
E911 Disclaimer √ string(1000) All 911 Services and E-911 Services provided by Level 3
E911 VPC: Level 3 has accepted this order. Your company
Page 293 of 350


to this subscriber.

E911Option string(60) E911Option values for E-911Option are: E911 Static, E911 VPC, E911
Customer Provided.

values.

different rate centers and thus require a GITN. N indicates
that service address and TN location are in the same rate
center and a GITN is not needed.
wirelessLNPIndicator string(1) yesNo Indicates whether the TN on the request is wireless TN.

subscriber
serviceOrderHeader.

subscriber record.


Page 294 of 350


subscriberLine

Level3SubscriberLineID √ integer notification is received. May be utilized by partner for
subsequent reporting, correlation or other related
purposes.

subscriber line.
NPAC Company code of carrier from which number is to be

NPAC Company code of carrier to which number is to be

√ Description of order details. Currently only required for

orderSummary orderSummary
change orders (orderAction = Change; orderType = New).
A customer-defined name used to specify the service
configuration preferences for the subscriber order. The
service configuration preferences include TN pool, and call
customerServiceName √ string(15) routing. This value must be pre-established as will be
validated. If multiple customer service names exist and the
field is not populated, an error will be returned.
NPA √ string(3)
NXX √ string(3)
Page 295 of 350

listOfResultCodes

transaction

code string(20)
several exceptions.

message string(256)
present

Context string(256)
of the resultCode

LNPInformation
LNPState string(10) State of LNP porting progress
A listOfJeopardyInformations includes one to many

listOfJeopardyInformations listOfJeopardyInformations
JeopardyInformation
listOfJeopardyInformations
Page 296 of 350

jeopardyInformation jeopardyInformation
JeopardyInformation
On LNP error situations, one or many jeopardy code can

jeopardyCode string(20)
be returned.
jeopardyDescription string(200) Detailed description for each jeopardy code
CSRInformation
companyCode string
customerCode string
freezePIC string
LPIC string
PIC string
endUserName string
dateReceived string
listOfFeatures listOfFeatures
listOfFeatureFlags listOfFeatureFlags
WTN √ WTN WTN to which this CSR corresponds
listOfFeatures
Page 297 of 350

feature √ feature
Information about subscriber line feature as recorded in the

feature
CSR
feature √ string Specific subscriber line feature as recorded in the CSR
featureDetail √ string Detailed description of subscriber line feature
listOfFeatureFlags
featureFlag √ featureFlag
Subscriber line feature which may impact the portability of

featureFlag
this subscriber line
featureFlag √ string

EXAMPLE: 25 W

EXAMPLE: 1/2

EXAMPLE: SW
preDirectional string(2) Directional Where SW is the Street directional prefix or pre-directional
for the following address example: 25W 450 1/2 SW
Page 298 of 350


EXAMPLE: LN

EXAMPLE: NW
Where NW is the Street directional suffix or post-directional
postDirectional string(2) Directional for the following address example: 25W 450 1/2 SW

room string(10)
Floor Designation
EXAMPLE: 12
EXAMPLE: 2
building string(10) Where 2 is building for the following address example: 25W
450 1/2 SW Camino Ramon Lane NW, Floor 12, Building 2,
Suite 23A.

EXAMPLE: STE

EXAMPLE: 23A
Page 299 of 350

NPA √ string(3)
NXX √ string(3)
orderSummary
listOfChangeType √ listOfChangeType
listOfSuppType √ listOfSuppType
When present, contains list of one or more changeType

listOfChangeType
objects
changeType √ changeType
changeType
When present, contains list of one or more suppType

listOfSuppType
objects
Page 300 of 350

suppType √ suppType
suppType
2.2.15.4 Output Message Parameters - postSLOrderStatusResponse



resultCode

returned.
Page 301 of 350

Page 302 of 350

2.2.16 CSR Notification

Description
This business transaction notifies the Level 3 partner that a Customer Service Record (CSR) has been received by Level 3 for a given LNP order
from the donor LEC and no error conditions exist for that record.
o postSLOrderStatus – notification sent by Level 3 to notify partner with processing results and order status
Prerequisites
• A previous LNP order has been successfully submitted and accepted by Level 3 systems
• Level 3 has received a CSR from donor LEC for LNP order.
Expected Results
• CSR notification (postSLOrderStatus)
Page 303 of 350

2.2.16.1.1 LNP Install
Page 304 of 350


Valid Values in List
RequestMessageHeader - Move Valid Values in List
-MessageID - Service Package - Subscriber Name
-Organization - CNAM - CTI
-Department - DL - BTN Old Carrier
-Application - Subscriber Name - CRD
-TimeStamp - Customer Service Name
-UserID
-OriginalMessageID
1 ChangeType SuppType
1 -ChangeName -SuppName
BusinessTransactionHeader 0..* 0..*

1 1
-B2BPartnerID
-LegalBinder
JeopardyInformation 0..1 Feature
-JeopardyCode 1 OrderSummary -Feature
1
-JeopardyDescription -listOfChangeType -FeatureDetail FeatureFlag
-listOFSuppType
0..* NotificationHeader
0..1
11
-NotificationType
-DateTime 0..1
1 1
ServiceOrderHeader
LNPInformation -ProductID
-OrderAction
-LNPState
-OrderType
-ListOfJeopardyInformations 0..1 WTN 1
-CRD
-ExternalOrderID -NPA
-LNPIndicator -NXX CSRInformation
1 -OrderStatus -StartNum 1
1 1 1 -AccountTelephoneNumber
1 -Subscriber
-CompanyCode
-ListOfResultCodes 0..1 -CustomerCode
-ListOfSubscriberLines
-SentTimeStamp
Subscriber -FOCDate
1 -FreezePIC
-L3SubscriberID -BillStartDate
-LPIC
-ExternalSubscriberId -BillStopDate
-PIC
-SubscriberSite 1 -InstalledDate SubscriberLine
1 -TransactionType
-L3SubscriberLineID -EndUserName
-CSRInformation 1..* -WTN -DateReceived
1 -LNPInformation
-FromLECCompanyCode -ListOfFeatureFlags
-L3ParentOrderID 1
-ToLECCompanyCode -ListOfFeatures
-ReasonCode
-RateCenter -CSRAddress
-ReasonComments
-OrderSummary -WTN
-PartnerSubGroupID
-E911Disclaimer -CustomerServiceName
-E911Option 1
-GITNIndicator 1
-wirelessLNPIndicator 1
1 1
1
ResultCode -LATA
-State
-Code
-Message
-Context
Page 305 of 350

Page 306 of 350

2.2.16.3 Input Message Parameters - postSLOrderStatus

benefit.



auditing purposes.

original message.

userID string (32)
Page 307 of 350


to is defined.

(ex. Level3_123456)
notificationHeader
notificationType √ string(40) NotificationType The enumerated value for notificationType = “CSR”
serviceOrderHeader


externalOrderVersion string(20) Partner Order Version stored by Level 3 systems. Level 3 does not
Page 308 of 350

enforce or utilize this value for any purpose other than partner-
wirelessLNPIndicator String(1) yesNo Indicates whether the TN on the request is a wireless TN
√ Status of the order at the time the notification is generated. See

state transition diagrams for more detail.
billStopDate √ date
√ One and only one CSRInformation record within a given

CSRInformation CSRInformation
ServiceOrderHeader



CSRInformation
Page 309 of 350

nameMatch √ string(1) yesNo
addressMatch √ string(1) yesNo
addressFormatType string
blockingExceptions string
companyCode string
customerCode string
freezePIC string
LPIC string
PIC string
endUserName string
dateReceived string
listOfFeatures listOfFeatures
listOfFeatureFlags listOfFeatureFlags
WTN √ WTN WTN to which this CSR corresponds
listOfFeatures
feature √ feature
Page 310 of 350

feature Information about subscriber line feature as recorded in the CSR
feature √ string Specific subscriber line feature as recorded in the CSR
featureDetail √ string Detailed description of subscriber line feature
listOfFeatureFlags
featureFlag √ featureFlag
Subscriber line feature which may impact the portability of this

featureFlag
subscriber line
featureFlag √ string

EXAMPLE: 25 W

Otherwise, ignored.
EXAMPLE: 1/2

EXAMPLE: SW
Page 311 of 350


EXAMPLE: LN
Suite 23A.

EXAMPLE: NW

room string(10)
Floor Designation
EXAMPLE: 12
floor string(10)
Where 12 is the floor for the following address example: 25W 450
EXAMPLE: 2
building string(10)

EXAMPLE: STE

EXAMPLE: 23A
Suite 23A.
Page 312 of 350

NPA √ string(3)
NXX √ string(3)

Note that current release only supports One and only one
subscriberLine
transaction.



Page 313 of 350

NPA √ string(3)
NXX √ string(3)
listOfResultCodes

resultCode

will be returned.

context string(256)
resultCode
2.2.16.4 Output Message Parameters - postSLOrderStatusResponse
Page 314 of 350




resultCode

returned.
Page 315 of 350

2.2.17 Level 3 Action Notification

Description
This notification enables Level 3 to take proactive action against any order currently processing. As such, notifications will be provided to the
partner identifying the action taken.
o postSLOrderStatus – notification sent by Level 3 to notify partner that Level 3 has initiated a cancel on an LNP order (see
Expected Results for all postSLOrderStatus messages for this transaction)
Currently, this notification is being issued to notify the partner that Level 3 has initiated a Cancel on a pending order for two possible
reasons:
o Partner has requested an Expedited Cancel (within 48 hours of FOC)
o Order has not been acted upon for 45 consecutive days (Example: Order is in rejected status and partner does not Supp or
Cancel it)
Implementation of notification type is required if implementing New Install transaction for LNP.
Prerequisites
Partner has submitted an LNP order.
Expected Results
Level 3 Action notification (postSLOrderStatus)
Page 316 of 350

Level 3 ERROR Notification - postSLOrderStatus
Level 3 initiates CANCEL

LEVEL3 ACTION Notification - postSLOrderStatus
Page 317 of 350

Page 318 of 350

-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-OriginalMessageID
-B2BPartnerID
1
1
NotificationHeader
-NotificationType
-DateTime
1 WTN
-NPA
-StartNum
-ProductID
1 -OrderAction
-OrderType 0..1
-CRD 1
Subscriber
-ExternalOrderID
1 -WTN
-ListOfResultCodes
1 -ToLECCompanyCode
1 11
RateCenter
1 -LATA
-State
ResultCode
-Code
-Message
-Context
Page 319 of 350

Page 320 of 350


benefit.



auditing purposes.

original message.

to is defined.
Page 321 of 350


(ex. Level3_123456)
notificationHeader
Con gratu latio ns! If you are the first person to find this message
notificationType √ string(40) NotificationType and notify D L-B2 B-Te am@ lev el3.com you will receive a spe cial
pri ze!!!
serviceOrderHeader



expected.
Page 322 of 350





subscriberLine
transaction.
Identifier generated by Level 3 systems for this subscriber line. May

Level3SubscriberLineID √ integer be utilized by partner for subsequent reporting, correlation or other
related purposes.

Page 323 of 350


NPA √ string(3)
NXX √ string(3)
listOfResultCodes

resultCode

will be returned.

context string(256)
resultCode
Page 324 of 350




resultCode

returned.
Page 325 of 350

2.3 Result Codes

The result codes reside in the B2B API Error Codes document that contains a list of the possible response codes and messages encountered
during service processing.
The LNP error codes reside in the LNP Customer Reference Guide that contains a list of the possible LNP jeopardy, warning, and feature codes
and messages encountered during LNP service processing.
2.4 Enumeration Values

Enumeration Valid Value Description
ChangeName CNAM
Move
Service Package
Subscriber Name
DL
E911 Option
911 Route Label
CTI B Business
R Residential
Directional N North
S South
E East
W West
NE Northeast
NW Northwest
SE Southeast
SW Southwest
Page 326 of 350

E911CoverageIndicator Y Yes
N No
Future functionality may include other values for this attribute.
E911Option E911 Static
E911 VPC
E911 Customer Provided
FlexibleAttr.Name CSRInformationRequired
LNP_OPTION
FlexibleAttr.Value LSR_BYPASS
ListingTreatment Add
Keep
Remove
Change
ListingTreatmentType 1 List & Publish (industry standard code)
2 List Only (industry standard code)
3 Do Not List or Publish (industry standard code)
LocDescriptor APT Apartment
BSMT Basement
DEPT Department
FRNT
HNGR Hangar
KEY
Page 327 of 350

LBBY Lobby
LOT Lot
LOWR Lower
OFC Office
PH
PIER Pier
REAR Rear
SIDE Side
SLIP Slip
SPC
STOP Stop, mail stop
STE Suite
TRLR Trailer
UNIT
UPPR Upper
NotificationType Submit The transaction type to which this notification type applies to (i.e. Install vs Disconnect) may be
determined from orderAction and orderType attributes within serviceOrderHeader. Submit
notifications may have error codes.
Install The transaction type to which this notification type applies to (i.e. Install vs Disconnect) may be
determined from orderAction and orderType attributes within serviceOrderHeader.
Disconnect The transaction type to which this notification type applies to (i.e. Install vs Disconnect) may be
Complete The transaction type to which this notification type applies to (i.e. Install vs Disconnect) may be
FOC The transaction type to which this notification type applies to (i.e. Install vs Disconnect) may be
CSR The transaction type to which this notification type applies to (i.e. Install vs Disconnect) may be
Error The transaction type to which this notification type applies to (i.e. Install vs Disconnect) may be
determined from orderAction and orderType attributes within serviceOrderHeader. Notification of
Type ‘Error’ is sent when an issue is encountered that either (1) prevents port or (2) prevents ALI
update. Order status remains what it was at the time of error.
Page 328 of 350

Level3 Action This Notification indicates that Level 3 has initiated a cancel on a partner submitted order that has
encountered a hard error and cannot proceed. An auto-cancel will be initiated if the partner does
not take action (Supp/Cancel) prior to10 days after they are notified that the order is in error, by an
‘Error” Notification.
OptionValue LSR_BYPASS
OrderAction Install
Change
Disconnect
OrderStatus Pending LSR
Submitted
Accepted
Installed
Completed
Rejected
OrderType New
Supp
Cancel
ProductID 2042 Level 3 VoIP Enhanced Local Service
2036 Level 3 VoIP Local Inbound Service
ReasonCode Channel Partner Init. Default value used when invalid value is submitted.
CustInit Chg Srvc. Valid only for Submit New Disconnect Order
MSAG ERROR. Valid only for Submit New Disconnect Order
State Please see USPS Pub 28, Appendix B – Two-Letter

State and Possession Abbreviations
StreetSuffix Please see USPS Pub 28, Appendix C – Street
Abbreviations; Section C1 – Street Suffix Abbreviations
SuppName Subscriber Name
CTI
Page 329 of 350

BTN Old Carrier
CRD
ServicePackage Usage Level 3 will provide the appropriate value based on customer contract.
Primary Local Flat Rate
Primary Local and Domestic LD Flat Rate
Secondary Local Flat Rate
Secondary Local and Domestic LD Flat Rate
YesNo Y Yes
N No
Page 330 of 350

2.5 WSDL Listing

The following WSDL files are provided.
Partner-side WSDL
VoipOrderServices.wsdl
Level 3-side WSDL
VoipOrderServicesLevel3.wsdl
Page 331 of 350

2.6 Schema Descriptions

The data payloads of the Order Services business transactions are governed by the XML Schemas
described below.
2.6.1 validateSLServiceAvailability
2.6.1.1 Class Diagram - validateSLServiceAvailability
Page 332 of 350

2.6.1.2 Class Diagram - validateSLServiceAvailabilityResponse
Page 333 of 350

2.6.2 createSLOrder
2.6.2.1 Class Diagram – createSLOrder
Page 334 of 350

2.6.2.2 Class Diagram – createSLOrderResponse
-MessageID
-TimeStamp
-B2BPartnerID
ResultCode
-Code
-Message
-Context
Page 335 of 350

2.6.3 postSLOrderStatus
2.6.3.1 Class Diagram – postSLOrderStatus
Page 336 of 350

2.6.3.2 Class Diagram - postSLOrderStatusResponse
-MessageID
-TimeStamp
-OriginalMessageID
-B2BPartnerID
ResultCode
-Code
-Message
-Context
Page 337 of 350

2.6.4 readOrder
2.6.4.1 Class Diagram – readOrder
Page 338 of 350

2.6.4.2 Class Diagram – readOrderResponse
RequestMessageHeader BusinessTransactionHeader
SuppType
-MessageID -B2BPartnerID
-TimeStamp -ExternalBusinessTransactionID JeopardyInformation -SuppName
1 1 -JeopardyCode ChangeType
0..* 1 1 -JeopardyDescription 0..*
-ChangeName
ResultCode
-Code 0..*
1
ServiceOrderHeader 0..* 1
-Message 1
-Level3ParentOrderID 1
-Context
-ProductID
-OrderAction
0..1 LNPInformation
-OrderType 1 -PortDirection
LNPEvents OrderSummary
-CRD
-EventName -PartnerSubGroupID -LOA -listOfChangeType
-DateTimeStamp -ExternalOrderID -LOADateTime -listOfSuppType
0..* 1 0..1
-Comments -TPVPVN -SuppAllowedIndicator
-LNPIndicator -TPVSentDateTime -SuppEarliestCRD
-OrderStatus -BTNOldCarrier -SuppLatestCRD
0..* -Subscriber -LNPState
1
LNPOption -ListOfSubscriberLines -ListOfJeopardyInformations
WTN
-OptionValue -FOCDate
-BillStartDate 1 -NPA
0..1 1
-BillStopDate -NXX
-InstalledDate -StartNum
-ListOfResultCodes -EndNum
-ExternalOrderVersion 1
-LNPInformation SubscriberLine
1
-CSRInformation -Level3SubscriberLineId
1 -ReasonCode 0..1
1 -ServicePackage
-ReasonComments 1..* -CTI CNAMInformation
1
-FirstUsageFlag -WTN
Subscriber -CNAM
-E911Option -DirectoryListingInformation -BlockCNAM
-BusinessName -InternalPortFlag -FromLECCompanyCode 1
-FirstName -LECResponseDate -ToLECCompanyCode
-MiddleInitial -CNAMInformation 0..1 DirectoryListingInformation
-LastName -ListOfOrderSummary
-Level3SubscriberID 1 -CustomerServiceName -TreatmentFlag
-ExternalSubscriberID -Type
-SubscriberSite -FirstName
-LastName
-DualNameListing
1 -LOA
Address 1 -ListedAddressIndicator
-StreetNumPrefix
-StreetNum CSRInformation
-StreetNumSuffix
SubscriberSite
1 -AccountTelephoneNumber
-PreDirectional
-CompanyCode
-Level3SubscriberSiteID -StreetName
-CustomerCode
-MainCallBackNumber -StreetSuffix
-SentTimeStamp 1
-ServiceAddress -PostDirectional
1 -FreezePIC
1 -Room
-LPIC Address
-Floor
-PIC
-Building -StreetNumPrefix
-TransactionType
-SecondaryLocationDescription -StreetNum
-EndUserName
-Unit -StreetNumSuffix
-DateReceived
-City -PreDirectional
-ListOfFeatureFlags 1
-State 1 -StreetName
-CSRAddress
-ZipCode -StreetSuffix
-WTN
-ZipPlus4 -PostDirectional
-Country -Room
-Comments 1 -Floor
-ConcatenatedAddress -Building
-Unit
FeatureFlag
-City
-FeatureCode 0..* -State
-FeatureName -ZipCode
-ZipPlus4
-Country
-Comments
Page 339 of 350

2.6.5 readServiceImage
2.6.5.1 Class Diagram – readServiceImage
Page 340 of 350

2.6.5.2 Class Diagram – readServiceImageResponse
Page 341 of 350

2.6.6 portTN
2.6.6.1 Class Diagram – portTN
-MessageID
-Organization
-Department
-Application
-TimeStamp
-UserID
-B2BPartnerID
WTN
-NPA
1
-NXX
-StartNum
0..1
1
1
ServiceOrderHeader 0..1
1
-Level3ParentOrderID SubscriberLine
Page 342 of 350

2.6.6.2 Class Diagram – portTNResponse
-MessageID
-TimeStamp
-B2BPartnerID
1 ServiceOrderHeader
ResultCode
1
-Code 1
-ListOfSubscriberLines 0..*
-Message
-FOCDate
-Context SubscriberLine
-ListOfResultCodes
-WTN
0..1
WTN
-NPA
-NXX
-StartNum
Page 343 of 350

2.6.7 requestCSR
2.6.7.1 Class Diagram – requestCSR
Page 344 of 350

2.6.7.2 Class Diagram – requestCSRResponse
Page 345 of 350

2.6.7.3 Class Diagram – postCSR
Page 346 of 350

2.6.7.4 Class Diagram – postCSRResponse
-MessageID
-Organization
-Department
-Application
-TimeStamp
-B2BPartnerID
1..*
ResultCode
-Code
-Message
-Context
Page 347 of 350

3 Appendices
3.1 Glossary
Term Description
ALI Automatic Location Identification database maintained by ILECs. Contains information
regarding the location associated with the caller’s TN, which is presented to a PSAP when the
caller dials 911.
CIC Carrier Identification Code
CNAM Caller ID Name
CRD Customer Request Date. Date a customer requests an action to be completed by.
CSR Customer Service Record
CTI Customer type indicator (Business or Residential).
DL Directory Listing
FOC Firm Order Commit
GITN Geographically Independent Telephone Number. A telephone number associated with a
different rate center than the service address.
ILEC Incumbent Local Exchange Carrier
LEC Local Exchange Carrier
LERG Local Exchange Routing Guide. A document issued by Telcordia (formerly Bellcore) that is
used to identify NPA-NXX routing and homing information, as well as network element and
equipment designation. It contains a listing of local routing data such as destination codes,
switching entities, rate centers and locality information by LATA.
LD Long Distance
LNP Local Number Portability. A network that allows an end-user to change a service provider,
location and/or service type without having to change their TN.
LOA Letter of Authorization, typically relating to LNP
LSOG Local Services Ordering Guidelines.
LSR Local Service Request
MACD Move, Add, Change, Delete
NPA Numbering Plan Area (Area Code)
NPAC Number Portability Administration Center (http://www.npac.com)
NXX Central office code or Prefix (First three digits of a seven-digit local telephone number)
Order Action Level 3 identifier used to indicate the action an order will initiate. Appropriate values include;
install, change, disconnect
Order Type Level 3 identifier used to indicate the type of an order action. Appropriate values include;
new, supp, cancel.
SL Subscriber Line. Embedded within naming for messages and other artefacts as an
abbreviation.
PIC Primary Interexchange Carrier
PSAP Public Safety Access Point to which 911 calls are routed.
Page 348 of 350

TN Telephone Number
VPC VoIP Positioning Center
WTN Working Telephone Number
Page 349 of 350

3.2 Holiday listing

Below is a list of carrier holidays observed by a majority of the telecommunications industry. Please note
the observed holiday may be different than the actual holiday.
2008 Holidays
New Years Day
Tuesday January 1st
Martin Luther King Day Observed Monday January 21st
Presidents Day Observed Monday February 18th
Memorial Day Observed Monday May 26th
Independence Day Friday July 4th
Labor Day Observed Monday September 1st
Columbus Day Observed Monday October 13th
Thanksgiving Day Observed Thursday November 27th
Day after Thanksgiving Day Observed Friday November 28th
Christmas Eve Wednesday December 24th
Christmas Day Thursday December 25th
3.3 Form for Review Comments

Level 3 will accept comments on this document in two forms: as in-line revision marks and comments,
and via the form below.
Section # Topic Comment Request or Recommendation
Page 350 of 350

B2B Api

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

B2B Api

Uploaded by

Copyright:

Available Formats

Level 3 Communications B2B API Spec – Order Services for Voice Products

B2B API Specification

Revision Release Date Description of Change Author

3.0.1.0 12/22/2004 Made minor WSDL and Spec changes Level 3

3.2.1.0 12/14/2005 Added new functionality Level 3

4.0.0.0 11/11/2006 Added multi-line LNP Install capability. Laura Maxwell

4.0.0.1 08/06/2007 Added product ID 2036 to enumeration Stephanie

Revision Transaction / Message Change

1.0 Various Various Enhanced attribute descriptions, defined enumerations where

1.0 Various Various Renamed businessTransactionHeader.B2BCustomerID to

1.0 Pre-Submit Service validateSLServiceAvailability Added to validationResponseHeader the following attributes:

1.0 Pre-Submit Service validateSLServiceAvailability Added to validationResponseHeader the following attributes:

1.0 Pre-Submit Portability validateSLServiceAvailability Added to validationResponseHeader the following attributes:

Revision Transaction / Message Change

1.0 Pre-Submit Portability validateSLServiceAvailability Added to portabilityAnalysisResult the following attributes:

1.0 Submit Cancel of createSLOrder Added to serviceOrderHeader the following attributes:

1.0 Submit Cancel of createSLOrder Removed from serviceOrderHeader attribute CRD

1.0 Submit Supplement of postSLOrderStatus Added to subscriberLine the following attributes:

1.0 Submit Cancel of postSLOrderStatus Added to subscriberLine the following attributes:

Revision Transaction / Message Change

2.0 Reserve TN n/a Added new business transaction

2.0 Read Order n/a Added new business transaction

2.0 Read Service Image n/a Added new business transaction

2.0 Provide Status n/a Added new business transaction

2.0 Pre-Submit Service validateSLServiceAvailability Removed redundant attribute LNPIndicator from

2.0 Pre-Submit Service validateSLServiceAvailability Changed name of portabilityAnalysisResult object to TNResult to

2.0 Pre-Submit Portability validateSLServiceAvailability Changed name of portabilityAnalysisResult object to TNResult to

2.0 Pre-Submit Service validateSLServiceAvailability Added new class diagram

2.0 Pre-Submit Service validateSLServiceAvailability Added new class diagram

2.0 Pre-Submit Portability validateSLServiceAvailability Added new class diagram

2.0 Submit New Install postSLOrderStatus Added new class diagram

2.0 Submit Supplement of postSLOrderStatus Added new class diagram

2.0 Submit Cancel of Install postSLOrderStatus Added new class diagram

2.0 Submit New Disconnect postSLOrderStatus Added new class diagram

2.0 Submit Cancel of postSLOrderStatus Added new class diagram

Revision Transaction / Message Change

2.0 Error Codes n/a Added several new error codes

2.1 Various requestMessageHeader Removed responseURL, since it is to be maintained in a new

2.1 Provide CSR n/a Added new business transaction

2.1 Various Various Added externalBusinessTransactionID to all messages

2.1 Various Various Removed externalBusinessTransactionVersion from all

2.1 Pre-Submit Service validateSLServiceAvailability Removed productID from TNResult

2.1 Pre-Submit Service validateSLServiceAvailability Removed productID from TNResult

2.1 Pre-Submit Portability validateSLServiceAvailability Removed productID from TNResult

2.1 Submit New Install createSLOrder Removed endNum from WTN

2.1 Reserve TN reserveTN Removed endNum from WTN

2.1 Various postSLOrderStatus Renamed rateCenter.stateCode to state

2.1 Various validateSLServiceAvailability Renamed rateCenter.stateCode to state

2.1 Various Various Changed error.errorCode datatype from integer to string(20).

2.1 Various Various Changed requestStatusMessage.code datatype from number to

2.1 Submit New Disconnect CreateSLOrder Removed directoryListingInformation class and

2.1 Submit New Install CreateSLOrder Removed directoryListingInformation.listingAddress

Revision Transaction / Message Change

2.1 Read Service Image ReadServiceImageResponse Removed directoryListingInformation.listingAddress

2.1 Submit New Install CreateSLOrder Removed customerProfileDefaultOverrides and corresponding

2.1 Various Various Replaced ErrorCode, RequestStatus, and

2.1 Various Various Replaced references to ErrorCode (e.g. listOfErrorCodes) with

2.1 Various Various Add originalMessageID attribute to responseMessageHeader for

2.1 Submit New Install createSLOrder, Added externalOrderVersion to serviceOrderHeader

2.1 Submit Supplement of createSLOrder, Added externalOrderVersion to serviceOrderHeader

2.1 Submit Cancel of Install createSLOrder, Added externalOrderVersion to serviceOrderHeader

2.1 Submit New Disconnect createSLOrder, Added externalOrderVersion to serviceOrderHeader