ASR XML Order Technical Specifications - CenturyLink

flashypumpkincenterΛογισμικό & κατασκευή λογ/κού

14 Δεκ 2013 (πριν από 3 χρόνια και 10 μήνες)

156 εμφανίσεις


This document was produced on behalf of the regulated interests of
CenturyLink

Communications International, Inc. (
CenturyLink
). Any use of this document by

unregulated entities of
CenturyLink

must be in accordance with the
C
enturyLink

Fair

Compensation Policy.














CenturyLink

ASR Ordering Systems

Order XML Release
22
.0


Technical Specifications


Document Release Date:
August 9
, 2013



CenturyLink

ASR Orderin
g Systems


Order XML Releas
e
2
2
.0



Technical Specifications



Document Release:
August 9
, 2013

http://www.
Centurylink
.com
/w
holesale/systems/asr.html


1

Version notice

Revision history

The table below lists the versions of this document.


Document Version

Date

1
9
.0

Draft

Version

01/06/2012

19
.0

Final Version

02/03/2012

20.0 Draft Version

07/06/2012

20.0 Final Version

08/03/2012

21.0 Draft Version

01/04/2013

22.0 Draft Version

07/12/2013

22.0 Final Version

08/09/2013


Important:

This document has been through a formal review p
rocess. To the best of
our knowledge, it is accurate. There may be further modifications and
we reserve the right to make those modifications.

Trademarks

CenturyLink

is a registered trademark of
CenturyLink

Communications International,
Inc.

All other trad
emarks mentioned herein are the property of their respective holders.

©200
5
,
CenturyLink

Communications, International, Inc.
CenturyLink

ASR Orderin
g Systems


Order XML Releas
e
2
2
.0



Technical Specifications



Document Release:
August 9
, 2013

http://www.
Centurylink
.com
/w
holesale/systems/asr.html


1

Memorandum Change Summary for Release
22
.0

CenturyLink

UOM Ordering Implementation for ASR

Overview

The
CenturyLink

ASR UOM Orderin
g Implementation follows the guidelines expressed in the
industry document “tML Transport Profile”


Issue 1, 06/25/2003, with the following exceptions:


1.

For the Result Sender and Result Retrieval Listener, the notification to be sent is
encapsulated in a
parent
CenturyLink
-
specific element “NotificationResult,” defined in

CenturyLink
InternalASRTransport.xsd
. This change was required because a single
element needs to be specified for a Web Service Request or Response.
CenturyLink

is
pursuing making this (or

equivalent) part of the industry guideline so that implementation
becomes more straight forward.

2.

The schema tML.Transport.xsd contained syntax errors that were corrected locally. The
corrections are obvious.

3.

SOAP Faults provided by
CenturyLink

and expecte
d from the requester have additional
“type” information as specified by the
“3/01/2005 Draft tML Transport Profile.” pg 35.
The details are also specified in “
tML.Transport.xsd
.”


Common Features

In support of the UOM Ordering Implementation,
CenturyLink

w
ill provide 3 SOAP Web
Services, and is designing expecting that requesters (Telecom Service Requesters, or customers)
will provide an additional 3 SOAP Web Services. For every SOAP Web Service:

1.

The calls are synchronous, where the response follows within
a few seconds of the
request.

2.

For every message, the SOAP Header contains the TML Transport implementation of
TML Header.

3.

For every message, the TransportID is unique.

4.

TrackID becomes an identifier of a specific ASR, except for Results Ready Sender, where
TrackID is generated locally because the service is inter
-
ASR.

5.

ResultID and CorrelationID become synonomous.

6.

The OK message is also known as a t1m1:OK message or TML OK, which is defined in
the TML Transport schema. This is different from the HTTP 200 OK m
essage.

7.

Security is provided by BASIC authenitcation over one
-
way (server
-
side) SSL.
Credentials that allow access to the
CenturyLink

provider Web Services will be provided
by your Account Representative.


CenturyLink

ASR Orderin
g Systems


Order XML Releas
e
2
2
.0



Technical Specifications



Document Release:
August 9
, 2013

http://www.
Centurylink
.com
/w
holesale/systems/asr.html


2

Request


ASR Main Intake

CenturyLink

will provid
e a SOAP Web Service which accepts an ASR in the format defined by
the element ASR_SERVICE_REQUEST in the
UOM
-
ASR.xsd
.


The response is the t1m1:OK.


Request Ack


Verifies ASR Receipt

CenturyLink

will call a requester
-
provided web service with a RequestAc
knowledgement
message.


The response is the t1m1:OK.


CenturyLink

will begin processing the ASR after receipt of the OK response to the Request Ack
call.


Result


Notification Message, a single attempt

CenturyLink

will call a requester
-
provided web servic
e with a NotificationResult message,
defined in

CenturyLink
InternalASRTransport.xsd
.


The response is the t1m1:OK.


ResultReady


List of Unacknowledged Notifications

CenturyLink

will periodically call a requester
-
provided web service with a
ResultWaitingN
otification message defined in
tML.Transport.xsd
. This is a list of Result IDs that
this company has not yet acknowledged. The frequency for this call can be adjusted by pairwise
agreement, and defaults to every 10 minutes.


GetResultReady


Retrieval of a

List

of Unacknowledged Notifications

CenturyLink

will provide a SOAP WebService which will return the same
ResultWaitingNotification message provided by the ResultReady function, described above. This
allows this same information to be “pulled,” rather th
an pushed. The format of the request
“GetResultReadyNotification,” including optional features, is defined in
CenturyLink
InternalASRTransport.xsd.


GetResult


Retrieval of a single Notification Message

CenturyLink

will provide a SOAP Web Service which acc
epts a GetResult message defined in
tML.Transport.xsd
.


The response is a NotificationResult message, defined in

CenturyLink
InternalASRTransport.xsd
.


CenturyLink

ASR Orderin
g Systems


Order XML Releas
e
2
2
.0



Technical Specifications



Document Release:
August 9
, 2013

http://www.
Centurylink
.com
/w
holesale/systems/asr.html


3

ResultAck


Acknowledging Receipt of a Notification

CenturyLink

will provide a SOAP Web Service which acc
epts a ResultAcknowledgement
message defined in
tML.Transport.xsd
.


The response is the t1m1:OK.


CenturyLink

ASR Orderin
g Systems


Order XML Releas
e
2
2
.0



Technical Specifications



Document Release:
August 9
, 2013

http://www.
Centurylink
.com
/w
holesale/systems/asr.html


4

NotificationResult Detail

When implementing a SOAP Web Service, a single Request and Response element must be
specified. Because a single Web Service was imp
lied by the TML Transport document by Result
Sender and Result Retrieval Listener,
CenturyLink

developed a parent element,
NotificationResult. Th
is serves as the Request elemen
t of the Result Sender “push,” and the
Response element of the Get Result “pull.
” According to the
CenturyLink

implementation,
NotificationResult contains one child element, a choice of one of one of the following:

1.

ASR_SERVICE_RESPONSE (Defined in UOM
-
ASR.xsd)



This indicates a REJECTION or ACCEPTANCE, according to the sub
-
element
SR_S
TATE. Rejection responses also have one or more REJECTION sub
-
elements.

2.

CONFIRMATION (Defined in
CenturyLink
InternalUOMASRNotifiy.xsd, and in the
industry equivalent.)

3.

ERROR_CLARIFICATION
, JEOPARDY_NOTIFY, and ORDER_INFO_NOTIFY

(Defined in
CenturyLink
Inter
nalUOMASRNotifiy.xsd, and in the industry equivalent.)
. If
a CNT sub
-
element is present, the notification is a CNR. If absent
(ERROR_CLARIFICATION only), the notification corresponds to an “Error File,”
defined in the industry documentation.

Schema Descrip
tions

CenturyLink
InternalASRTransport.xsd

Contains the defintion of the NotificationResult parent element used as the Request for the
Result Sender, and the Response for the Get Result Web Service. This parent element in turn
specifies the selection of a s
ingle child element to be used, which is defined in the industry
schema.

Also contains the definition of GetResultReadyNotification, which
describes the format
of the ResultReadyRetrieval request message.


CenturyLink
InternalUOMASRNotify.xsd

Contains the i
ndustry defintion of ERROR_CLARIFICATION and CONFIRMATION. This
schema has the content of UOM
-
Base.xsd included internally.


UOM
-
ASR.xsd

Contains the industry defintion of ASR_SERVICE RESPONSE.


tML.Transport.xsd

Contains the defintions of the elements u
sed by the TML Transport protocol. Assembled from:

1.

The TML Transport schema included in the document “tML Transport Profile”


Issue 1,
06/25/2003, with syntactic corrections made by
CenturyLink
.

2.

The SOAP Fault schema from “3/01/2005 Draft tML Transport Pr
ofile.” pg 35 et al.