One document matched: draft-ietf-drinks-spp-protocol-over-soap-02.xml
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY rfc2119 PUBLIC ""
"http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
<!ENTITY rfc3688 PUBLIC ""
"http://xml.resource.org/public/rfc/bibxml/reference.RFC.3688.xml">
<!ENTITY rfc5486 PUBLIC ""
"http://xml.resource.org/public/rfc/bibxml/reference.RFC.5486.xml">
<!ENTITY rfc5246 PUBLIC ""
"http://xml.resource.org/public/rfc/bibxml/reference.RFC.5246.xml">
<!ENTITY rfc2617 PUBLIC ""
"http://xml.resource.org/public/rfc/bibxml/reference.RFC.2617.xml">
<!ENTITY rfc2616 PUBLIC ""
"http://xml.resource.org/public/rfc/bibxml/reference.RFC.2616.xml">
<!ENTITY rfc2818 PUBLIC ""
"http://xml.resource.org/public/rfc/bibxml/reference.RFC.2818.xml">
<!ENTITY rfc5321 PUBLIC ""
"http://xml.resource.org/public/rfc/bibxml/reference.RFC.5321.xml">
]>
<rfc category="std" docName="draft-ietf-drinks-spp-protocol-over-soap-02" ipr="trust200902">
<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<?rfc toc="yes" ?>
<?rfc symrefs="yes" ?>
<?rfc sortrefs="yes"?>
<?rfc iprnotified="no" ?>
<?rfc strict="yes" ?>
<front>
<title abbrev="draft-ietf-drinks-spp-protocol-over-soap">Session Peering Provisioning (SPP) Protocol over SOAP</title>
<author initials='K.C.' surname="Cartwright" fullname='Kenneth Cartwright'>
<organization>TNS</organization>
<address>
<postal>
<street>1939 Roland Clarke Place</street>
<city>Reston</city> <region>VA</region>
<code>20191</code>
<country>USA</country>
</postal>
<email>kcartwright@tnsi.com</email>
</address>
</author>
<author initials='V.B.' surname="Bhatia" fullname='Vikas Bhatia'>
<organization>TNS</organization>
<address>
<postal>
<street>1939 Roland Clarke Place</street>
<city>Reston</city> <region>VA</region>
<code>20191</code>
<country>USA</country>
</postal>
<email>vbhatia@tnsi.com</email>
</address>
</author>
<author initials="J-F.M." surname="Mule" fullname="Jean-Francois Mule">
<organization>CableLabs </organization>
<address>
<postal>
<street>858 Coal Creek Circle</street>
<city>Louisville</city>
<region>CO</region>
<code>80027</code>
<country>USA</country>
</postal>
<email>jfm@cablelabs.com</email>
</address>
</author>
<author initials="A.M." surname="Mayrhofer" fullname="Alexander Mayrhofer">
<organization>enum.at GmbH</organization>
<address>
<postal>
<street>Karlsplatz 1/9</street>
<city>Wien</city>
<region> </region>
<code>A-1010</code>
<country>Austria</country>
</postal>
<email>alexander.mayrhofer@enum.at</email>
</address>
</author>
<date year="2012" month="July"/>
<area>Real-time Applications and Infrastructure Area</area>
<workgroup>DRINKS</workgroup>
<abstract>
<t>The Session Peering Provisioning Framework (SPPF) is an XML framework
that exists to enable the provisioning of session establishment data into
Session Data Registries or SIP Service Provider data stores. Sending XML
data structures over Simple Object Access Protocol (SOAP) and HTTP(s) is
a widely used, de-facto standard for messaging between elements of
provisioning systems. Therefore the combination of SOAP and HTTP(s) as
a transport protocol for SPPF is a natural fit. The obvious benefits include
leveraging existing industry expertise, leveraging existing standards,
and a higher probability that existing provisioning systems can be more
easily integrated with this protocol. This document describes the
specification for transporting SPPF XML structures over SOAP and HTTP(s).
</t>
</abstract>
</front>
<middle>
<section title="Introduction">
<t>SPPF, defined in <xref target="I-D.draft-ietf-drinks-spp-framework"/>,
is best supported by a transport and messaging infrastructure
that is connection oriented, request-response oriented, easily secured,
supports propagation through firewalls in a standard fashion, and that
is easily integrated into back-office systems. This is due to the fact that
the client side of SPPF is likely to be integrated with organizations'
operational support systems that facilitate transactional provisioning of user
addresses and their associated session establishment data. While the server
side of SPPF is likely to reside in a separate organization's network, resulting
the SPPF provisioning transactions traversing the Internet as
they are propagated from the SPPF client to the SPPF server. Given the
current state of industry practice and technologies,
SOAP and HTTP(s) are well suited for this type of environment. This document
describes the specification for transporting SPPF XML structures over
SOAP and HTTP(s).</t>
<t>The specification in this document for transporting SPPF XML structures
over SOAP and HTTP(s) is primarily comprised of five subjects: (1) a
description of any applicable SOAP features, (2) any applicable HTTP
features, (3) security considerations, and perhaps most importantly,
(4) the Web Services Description Language (WSDL) definition for SPP Protocol over
SOAP, and (5) "transport" specific XML schema type definitions</t>
</section>
<section anchor="Terminology" title="Terminology">
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in <xref target="RFC2119"/>.</t>
</section>
<section anchor="SOAPFeatures" title="SOAP Features and Protocol Layering">
<t>The list of SOAP features that are explicitly used and required for SPP Protocol over SOAP are limited. Most SOAP features are not necessary for SPPF. SPP Protocol over SOAP primarily uses SOAP simply as a standard message envelope technology. The SOAP message envelope is comprised of the SOAP header and body. As described in the SOAP specifications, the SOAP header can contain optional, application specific, information about the message. The SOAP body contains the SPPF message itself, whose structure is defined by the combination of one of the WSDL operations defined in this document and the SPPF XML data structures defined in this document and the SPPF document. SPPF does not rely on any data elements in the SOAP header. All relevant data elements are defined in the SPPF XML schema described in <xref target="I-D.draft-ietf-drinks-spp-framework"/> and the SPPF WSDL types specification described in this document.</t>
<t>WSDL is a widely standardized and adopted technology for defining the top-level structures of the messages that are transported within the body of a SOAP message. The WSDL definition for the SPPF SOAP messages is defined later in this document, which imports by reference the XML data types contained in the SPPF schema. The IANA registry where the SPPF schema resides is described in The IETF XML Registry <xref target="RFC3688"/>.</t>
<t>There are multiple structural styles that SOAP WSDL allows. But the best practice for this type of application is what is sometimes referred to as the Document Literal Wrapped style of designing SOAP WSDL. This style is generally regarded as an optimal approach that enhances maintainability, comprehension, portability, and, to a certain extent, performance. It is characterized by setting the soapAction binding style as _document_, the soapAction encoding style as _literal_, and then defining the SOAP messages to simply contain a single data element that _wraps_ a data structure containing all the required input or output data elements. The figure below illustrates this high level technical structure as conceptual layers 3 through 6.</t>
<figure anchor="TechnicalStructureofSPPP"
title="Layering and Technical Structure of the SPP Protocol over SOAP Messages">
<artwork align="left"><![CDATA[
+-------------+
(1) | Transport |Example:
| Protocol | TCP, TLS, BEEP, etc.
+-------------+
|
V
+-------------+
(2) | Message |Example:
| Envelope | HTTP, SOAP, None, etc.
+-------------+
|
V
+--------------+
+----| SOAP |---+
|(3) | Operation | |
Contains | +--------------+ | Contains
| Example: |
V submitAddRqst V
+--------------+ +-------------+
|SOAP Request | |SOAP Response|
Example: | Message | (4) | Message | Example:
spppAdd | (Operation | | (Operation | spppAdd
RequestMsg | Input) | | Output) | ResponseMsg
+--------------+ +-------------+
| |
Contains | | Contains
| |
V V
+---------------+ +---------------+
Example: | Wrapped | (5) | Wrapped | Example:
spppAdd |Request Object | |Response Object| spppAdd
Request +---------------+ +---------------+ Response
| |
Contains | | Contains
| |
V V
+-------------+ +---------------+
| SPPF | | SPPF |
|XML Types | (6) | XML Types |
+-------------+ +---------------+
]]></artwork>
</figure>
<t>The operations supported by SPP Protocol over SOAP are normatively defined later in this
document. Each SOAP operation defines a request/input message and a
response/output message. Each such request and response message then
contains a single object that wraps the SPPF XML data types that comprise
the inputs and the outputs, respectively, of the SOAP operation.</t>
<t>SOAP faults are not used by the SPP Protocol over SOAP. All success
and error responses are specified in the "Response Codes and Messages" section of this document.
However, if a SOAP fault were
to occur, perhaps due to failures in the SOAP message handling layer of a SOAP
library, the client application should capture and handle the fault. Specifics
on how to handle such SOAP faults, if they should occur, will be specific to
the chosen SOAP implementation. </t>
<t>SOAP 1.2 <xref target="SOAPREF"/> or higher and WSDL 1.1 <xref target="WSDLREF"/> or higher SHOULD be used.</t>
<t> SPPF is a request/reply framework that allows a
client application to submit provisioning data and query
requests to a server. The SPPF data structures are designed
to be protocol agnostic. Concerns regarding encryption,
non-repudiation, and authentication are beyond the scope of
this document. For more details, please refer to the
"Transport Protocol Requirements" section in the framework document. </t>
<t> As illustrated in the previous diagram, SPPF can be viewed as
a set of layers that collectively
define the structure of an SPPF request and response. Layers
1 and 2 represent the transport, envelope, and authentication
technologies. This
document defines layers 3, 4, 5, and 6 below for SPP Protocol over SOAP. </t>
<t>
<list style="numbers">
<t> Layer 1: The transport protocol layer represents the communication
mechanism between the client and server. SPPF can be
layered over any transport protocol that provides a set
of basic requirements defined in the Transport Protocol
Requirements section. But this document specifies the required
mechanism.</t>
<t> Layer 2: The message envelope layer is optional, but can
provide features that are above the transport technology
layer but below the application messaging layer.
Technologies such as HTTP and SOAP are examples of
messaging envelope technologies. This document specifies the required
envelope technology.</t>
<t> Layers 3,4,5,6: The operation and message layers provides an
envelope-independent and transport-independent
wrapper for the SPPF data model objects that are being acted on (created,
modified, queried). </t>
</list>
</t>
</section>
<section anchor="HTTPFeatures" title="HTTP(s) Features and SPP Protocol over SOAP">
<t>SOAP is not tied to HTTP(s), however, for reasons described in the
introduction, HTTP(s) is a good choice as the transport mechanism for
the SPP Protocol SOAP messages. HTTP 1.1 includes the "persistent connection"
feature, which allows multiple HTTP request/response pairs to be transported
across a single HTTP connection. This is an important performance
optimization feature, particularly when the connections is an HTTPS
connection where the relatively time consuming SSL handshake has occurred.
Persistent connections SHOULD be used for the SPPF HTTP connections.</t>
<t>HTTP 1.1 <xref target="RFC2616"/> or higher SHOULD be used.</t>
</section>
<section anchor="AuthenticationSessionManagement" title="Authentication and Session Management">
<t>To achieve integrity and privacy, conforming SPP Protocol SOAP Clients and Servers MUST support SOAP over HTTP over TLS <xref target="RFC5246"/> as the secure transport mechanism. This combination of HTTP and TLS is referred to as HTTPS. And to accomplish authentication, conforming SOAP SPPF Clients and Servers MUST use HTTP Digest Authentication as defined in <xref target="RFC2617"/>. As a result, the communication session is established through the initial HTTP connection setup, the digest authentication, and the TLS handshake. When the HTTP connection is broken down, the communication session ends.</t>
</section>
<section anchor="LanguageIdentification" title="Language Identification">
<t>
Section 9 of <xref target="I-D.draft-ietf-drinks-spp-framework"/> requires transport protocols
to provide a mechanism to transmit language tags together with human-readable
messages. When conforming SPP Protocol SOAP servers use such tagging, the XML
"lang" attribute (see Section 2.12 of <xref target="W3C.REC-xml-20081126"/>)
MUST be used for that purpose. Clients MAY use the HTTP "Accept-Language" header
field (see Section 14.4 of <xref target="RFC2616"/>) in order to indicate their
language preference.
</t>
</section>
<section anchor="basicdatastructures" title="SPP Protocol SOAP Data Structures">
<t>SPP Protocol over SOAP uses a set of XML based data structures for all the supported operations
and any parameters that those operations are applied to. As also mentioned earlier in this document, these XML structures
are envelope-independent and transport-independent. Refer the "Protocol Operations" section of this document for
a description of all the operations that MUST be supported.</t>
<t>The following sections describe the definition all the XML data structures. </t>
<section anchor="concreteobjkeys" title="Concrete Object Key Types">
<t>Certain operations in SPPF require an object key that uniquely identifies the object(s) on which a given operation
needs to be performed. SPPF defines the XML structure of the any such object key in an abstract manner and delegates
the concrete representation to any conforming transport protocol. The following sub-sections define the various types of
concrete object key types used in various operations in SPP Protocol over SOAP: </t>
<section anchor="objectkey" title="Generic Object Key">
<t>
Most objects in SPP Protocol over SOAP are uniquely identified by the attributes in the generic object key (Refer "Generic Object Key Type" section
of the framework document for details). The concrete XML representation of ObjKeyType is as below:</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<complexType name="ObjKeyType">
<complexContent>
<extension base="sppfb:ObjKeyType">
<sequence>
<element name="rant" type="sppfb:OrgIdType"/>
<element name="name" type="sppfb:ObjNameType"/>
<element name="type" type="sppfs:ObjKeyTypeEnum"/>
</sequence>
</extension>
</complexContent>
</complexType>
]]>
</artwork>
</figure>
</t>
<t> The ObjKeyType has the data elements as described below:
<list style="symbols" hangIndent="5">
<t>rant: The identifier of the registrant organization that owns the object.</t>
<t>name: The character string that contains the name of the object.</t>
<t>type: The enumeration value that represents the type of SPPF object. For example,
both a Destination Group and a SED Group can have the same name "TestObj" and be associated with same Registrant Id "iana-en:222". Hence, to uniquely identify
the object that represents a Destination Group with the name "TestObj", the type "DestGrp" must be specified when using this concrete ObjKeyType structure to identify the Destination Group "TestObj".</t>
</list>
</t>
<t> The object types in SPP Protocol over SOAP that MUST
adhere to the above definition of generic object key are defined as an enumeration in the XML data structure. The structure of the the enumeration is as follows:</t>
<figure title="">
<artwork align="left"><![CDATA[
<simpleType name="ObjKeyTypeEnum">
<restriction base="token">
<enumeration value="SedGrp"/>
<enumeration value="DestGrp"/>
<enumeration value="SedRec"/>
<enumeration value="EgrRte"/>
</restriction>
</simpleType>
]]></artwork>
</figure>
</section>
<section anchor="pubidkey" title="Public Identity Object Key">
<t>
Public Identity type objects can further be of various sub-types like a TN, RN, TN Prefix, URI, or a TN Range and cannot be cleanly identified
with the attributes in the generic ObjKeyType. The definition of PubIdKeyType is as below:</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<complexType name="PubIdKeyType">
<complexContent>
<extension base="sppfb:PubIdKeyType">
<sequence>
<element name="rant" type="sppfb:OrgIdType"/>
<element name="dgName" type="sppfb:ObjNameType"
minOccurs="0"/>
<choice>
<element name="number"
type="sppfb:NumberType"/>
<element name="range"
type="sppfb:NumberRangeType"/>
<element name="uri"
type="anyURI"/>
</choice>
</sequence>
</extension>
</complexContent>
</complexType>
]]>
</artwork>
</figure>
</t>
<t> The PubIdKeyType has the data elements as described below:
<list style="symbols" hangIndent="5">
<t>rant: The identifier of the registrant organization that owns the object.</t>
<t>dgName: The name of the Destination Group that a Public Identifier is member of. Note that this is an optional attribute of the key as Public Identifiers may or may not be provisioned
as members of a Destination Group. </t>
<t>number: An element of type NumberType (refer framework document) that contains the value and type of a
number .</t>
<t>range: An element of type NumberRangeType (refer framework document) that contains a range of numbers.</t>
<t>uri: A value that represents a Public Identifier.</t>
</list>
It is MUST that only one of the "number", "range", and "uri" elements appears in a PubIdKeyType instance.
</t>
</section>
<section anchor="sedgrpofferkey" title="SED Group Offer Key">
<t>
In addition to the attributes in the generic ObjKeyType, a SED Group Offer object is uniquely identified by the organization ID of the organization
to whom an SED Group has been offered. The definition of SedGrpOfferKeyType is as below:</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<complexType name="SedGrpOfferKeyType">
<complexContent>
<extension base="sppfb:SedGrpOfferKeyType">
<sequence>
<element name="sedGrpKey" type="sppfs:ObjKeyType"/>
<element name="offeredTo" type="sppfb:OrgIdType"/>
</sequence>
</extension>
</complexContent>
</complexType>
]]>
</artwork>
</figure>
</t>
<t> The SedGrpOfferKeyType has the data elements as described below:
<list style="symbols" hangIndent="5">
<t>sedGrpKey: Identifies the SED Group that was offered.</t>
<t>offeredTo: The organization ID of the organization that was offered the SED Group object identified by the sedGrpKey.</t>
</list>
</t>
</section>
</section>
<section anchor="requestandresponse" title="Operation Request and Response Structures">
<t> An SPPF client interacts with an SPPF server by using one of
the supported transport mechanisms to send one or more
requests to the server and receive corresponding replies from
the server. The basic set of operations that an SPPF
client can submit to an SPPF server and the semantics of those operations are defined in the "Framework Operations" section of the framework document. The following
sub-sections describe the XML data structures that are used for each of those types of operations for a SPP Protocol over SOAP implementation. </t>
<section anchor="addsandmods" title="Add Operation Structure">
<t>In order to add (or modify) an object in the registry, an authorized entity
can send the spppAddRequest to the registry.</t>
<t>An SPP Protocol over SOAP Add request is wrapped within the
<![CDATA[<spppAddRequest> ]]> element while an SPP Protocol over SOAP Add response is
wrapped within an <![CDATA[<spppAddResponse>]]> element.
The following sub-sections describe the spppAddRequest and spppAddResponse elements.
Refer the "SPP Protocol over SOAP Examples" section of this document for an example of Add operation on each type of SPPF object.</t>
<section anchor="addrqst" title="Add Request">
<t> An SPP Protocol over SOAP Add request definition is contained within the generic
<![CDATA[<spppAddRequest>]]> element. </t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppAddRequest">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<element name="obj" type="sppfb:BasicObjType"
maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
]]>
</artwork>
</figure>
</t>
<t> The data elements within the <![CDATA[<spppAddRequest>]]>
element are described as follows:
<list style="symbols" hangIndent="5">
<t> clientTransId: Zero or one client-generated transaction ID
that, within the context of the SPPF client, identifies this
request. This value can be used at the discretion of the SPPF
client to track, log or correlate requests and their responses. SPPF server MUST echo back this value to the client in the corresponding response to the incoming request.
SPPF server will not check this value for uniqueness. </t>
<t> minorVer: Zero or one minor version identifier, indicating the minor
version of the SPPF API that the client is attempting to use. This is
used in conjunction with the major version identifier in
the XML namespace to identify the version of SPPF that the client
is using. If the element is not present, the server assumes that
the client is using the latest minor version supported by the SPPF
server for the given major version. The versions supported by a
given SPPF server can be retrieved by the client using the
SPPF server menu operation described later in the document.</t>
<t> obj: One or more elements of abstract type BasicObjType (defined in the framework document). Each element contains all the attributes of an SPPF object that that the client is requesting the SPPF server to add. Refer the "Framework Data Model Objects"
section of the framework document for the XML structure of all concrete types, for various SPPF objects,
that extend from abstract BasicObjType and hence are eligible to be passed into this element. The elements are processed
by the SPPF server in the order in which they are included in the request.
With respect to handling of error conditions, conforming SPPP SOAP servers
MUST stop processing BasicObjType elements in the request at
the first error, and roll back any BasicObjType elements
that had already been processed for that add request ("stop and rollback").
<!-- it is a matter of policy
whether the objects are processed in a "stop and rollback" fashion or
in a "stop and commit" fashion. In the "stop and rollback" scenario,
the SPPF server would stop processing BasicObjType elements in the
request at the first error and roll back any BasicObjType elements
that had already been processed for that add request.
In the "stop and commit" scenario the SPPF server would stop
processing BasicObjType elements in the request at the
first error but commit any BasicObjType elements
that had already been processed for that add request. -->
</t>
</list>
</t>
</section>
<section anchor="addresponse" title="Add Response">
<t> An SPP Protocol over SOAP add response object is contained within the generic
<![CDATA[<spppAddResponse>]]> element. This response structure is used for all
types of SPPF objects that are provisioned by the SPPF client.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppAddResponse">
<complexType>
<sequence>
<element name="clientTransId" type="sppfb:TransIdType"
minOccurs="0"/>
<element name="serverTransId" type="sppfb:TransIdType"/>
<element name="overallResult" type="sppfb:ResultCodeType"/>
<element name="detailResult" type="sppfs:ObjResultCodeType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<complexType name="ResultCodeType">
<sequence>
<element name="code" type="int"/>
<element name="msg" type="string"/>
</sequence>
</complexType>
<complexType name="ObjResultCodeType">
<complexContent>
<extension base="sppfs:ResultCodeType">
<sequence>
<element name="obj" type="sppfb:BasicObjType"/>
</sequence>
</extension>
</complexContent>
</complexType>
]]>
</artwork>
</figure>
</t>
<t> An <![CDATA[<spppAddResponse>]]> contains the
elements necessary for the SPPF client to precisely determine the
overall result of the request, and if an error occurred, it provides
information about the specific object(s) that
caused the error. </t>
<t> The data elements within the SPP Protocol over SOAP Add response are
described as follows: <list style="symbols" hangIndent="5">
<t> clientTransId: Zero or one client transaction ID. This
value is simply an echo of the client transaction ID that
SPPF client passed into the SPPF update request. When included
in the request, the SPPF server MUST return it in the corresponding
response message.</t>
<t> serverTransId: Exactly one server transaction ID that
identifies this request for tracking purposes. This
value MUST be unique for a given SPPF server. </t>
<t> overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details. </t>
<t> detailResult: An optional response code, response message,
and BasicObjType (as defined in the framework document) triplet. This element will be present only if an object level error has occurred.
It indicates the error condition and the exact request object that contributed to the error. The response code will reflect the exact error.
See the Response Code section for further details.</t>
</list>
</t>
</section>
</section>
<section anchor="dels" title="Delete Operation Structure">
<t>In order to remove an object from the registry, an authorized entity
can send the spppDelRequest into the registry. An SPP Protocol over SOAP Delete request is wrapped within the
<![CDATA[<spppDelRequest> ]]> element while a SPP Protocol over SOAP Delete response is
wrapped within the generic <![CDATA[<spppDelResponse>]]> element.
The following sub-sections describe the spppDelRequest and spppDelResponse elements. Refer the "SPP Protocol over SOAP Examples" section of this document for an example of Delete operation on each type of SPPF object.</t>
<section anchor="delrqst" title="Delete Request">
<t> An SPP Protocol over SOAP Delete request definition is contained within the generic
<![CDATA[<spppDelRequest>]]> element. </t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppDelRequest">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<element name="objKey" type="sppfb:ObjKeyType"
maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
]]>
</artwork>
</figure>
</t>
<t> The data elements within the <![CDATA[<spppDelRequest>]]>
element are described as follows:
<list style="symbols" hangIndent="5">
<t> clientTransId: Zero or one client-generated transaction ID
that, within the context of the SPPF client, identifies this
request. This value can be used at the discretion of the SPPF
client to track, log or correlate requests and their responses. SPPF server MUST echo back this value to the client in the corresponding response to the incoming request.
SPPF server will not check this value for uniqueness. </t>
<t> minorVer: Zero or one minor version identifier, indicating the minor
version of the SPPF API that the client is attempting to use. This is
used in conjunction with the major version identifier in
the XML namespace to identify the version of SPPF that the client
is using. If the element is not present, the server assumes that
the client is using the latest minor version supported by the SPPF
server for the given major version. The versions supported by a
given SPPF server can be retrieved by the client using the
SPPF server menu operation described later in the document.</t>
<t> objKey: One or more elements of abstract type ObjKeyType (as defined in the framework document). Each element contains attributes that uniquely identify
the object that the client is requesting the server to delete. Refer the "Concrete Object Keys" section of this document
for a description of all concrete object key types, for various SPPF objects, which are eligible to be passed into this element. The elements are processed
by the SPPF server in the order in which they are included in the request.
With respect to handling of error conditions, conforming SPPP SOAP servers
MUST stop processing ObjKeyType elements in the request at
the first error, and roll back any ObjKeyType elements
that had already been processed for that delete request ("stop and rollback").
<!-- it is a matter of policy
whether the objects are processed in a "stop and rollback" fashion or
in a "stop and commit" fashion. In the "stop and rollback" scenario,
the SPPF server would stop processing ObjKeyType elements in the
request at the first error and roll back any ObjKeyType elements
that had already been processed for that delete request.
In the "stop and commit" scenario the SPPF server would stop
processing ObjKeyType elements in the request at the
first error but commit any KeyParamType elements
that had already been processed for that delete request. -->
</t>
</list>
</t>
</section>
<section anchor="delresponse" title="Delete Response">
<t> An SPP Protocol over SOAP delete response object is contained within the generic
<![CDATA[<sppDeleteResponse>]]> element. This response structure is used for a delete request on all
types of SPPF objects that are provisioned by the SPPF client.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppDelResponse">
<complexType>
<sequence>
<element name="clientTransId" type="sppfb:TransIdType"
minOccurs="0"/>
<element name="serverTransId" type="sppfb:TransIdType"/>
<element name="overallResult" type="sppfb:ResultCodeType"/>
<element name="detailResult" type="sppfs:ObjKeyResultCodeType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<complexType name="ResultCodeType">
<sequence>
<element name="code" type="int"/>
<element name="msg" type="string"/>
</sequence>
</complexType>
<complexType name="ObjKeyResultCodeType">
<complexContent>
<extension base="sppfs:ResultCodeType">
<sequence>
<element name="objKey" type="sppfb:ObjKeyType"/>
</sequence>
</extension>
</complexContent>
</complexType>
]]>
</artwork>
</figure>
</t>
<t> An <![CDATA[<spppDelResponse>]]> contains the
elements necessary for the SPPF client to precisely determine the
overall result of the request, and if an error occurred, it provides
information about the specific object key(s) that
caused the error. </t>
<t> The data elements within the SPP Protocol over SOAP Delete response are
described as follows: <list style="symbols" hangIndent="5">
<t> clientTransId: Zero or one client transaction ID. This
value is simply an echo of the client transaction ID that
SPPF client passed into the SPPF update request. When included
in the request, the SPPF server MUST return it in the corresponding
response message.</t>
<t> serverTransId: Exactly one server transaction ID that
identifies this request for tracking purposes. This
value MUST be unique for a given SPPF server. </t>
<t> overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details. </t>
<t> detailResult: An optional response code, response message,
and ObjKeyType (as defined in the framework document) triplet. This element will be present only if an specific object key level error has occurred.
It indicates the error condition and the exact request object key that contributed to the error. The response code will reflect the exact error.
See the Response Code section for further details.</t>
</list>
</t>
</section>
</section>
<section anchor="accepts" title="Accept Operation Structure">
<t>In SPPF, a SED Group Offer can be accepted or rejected by, or on behalf of, the registrant to
whom the SED Group has been offered (refer "Framework Data Model Objects" section of the framework document for a description
of the SED Group Offer object). The Accept operation is used to accept such SED Group Offers by, or on
behalf of, the Registrant. The request structure for an SPP Protocol over SOAP Accept operation is wrapped within the
<![CDATA[<spppAcceptRequest> ]]> element while an SPP Protocol over SOAP Accept response is
wrapped within the generic <![CDATA[<spppAcceptResponse>]]> element.
The following sub-sections describe the spppAcceptRequest and spppAcceptResponse elements. Refer the "SPP Protocol over SOAP Examples" section of this document for an example of Accept operation on a SED Group Offer.</t>
<section anchor="acceptrqst" title="Accept Request Structure">
<t> An SPP Protocol over SOAP Accept request definition is contained within the generic
<![CDATA[<sppAcceptRequest>]]> element. </t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppAcceptRequest">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<element name="sedGrpOfferKey"
type="sppfs:SedGrpOfferKeyType"
maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
]]>
</artwork>
</figure>
</t>
<t> The data elements within the <![CDATA[<spppAcceptRequest>]]>
element are described as follows:
<list style="symbols" hangIndent="5">
<t> clientTransId: Zero or one client-generated transaction ID
that, within the context of the SPPF client, identifies this
request. This value can be used at the discretion of the SPPF
client to track, log or correlate requests and their responses. SPPF server MUST echo back this value to the client in the corresponding response to the incoming request.
SPPF server will not check this value for uniqueness. </t>
<t> minorVer: Zero or one minor version identifier, indicating the minor
version of the SPPF API that the client is attempting to use. This is
used in conjunction with the major version identifier in
the XML namespace to identify the version of SPPF that the client
is using. If the element is not present, the server assumes that
the client is using the latest minor version supported by the SPPF
server for the given major version. The versions supported by a
given SPPF server can be retrieved by the client using the
SPPF server menu operation described later in the document.</t>
<t> sedGrpOfferKey: One or more elements of type SedGrpOfferKeyType (as defined in this document). Each element contains attributes that uniquely identify
a SED Group Offer that the client is requesting the server to accept. The elements are processed
by the SPPF server in the order in which they are included in the request.
With respect to handling of error conditions, conforming SPPP SOAP servers
MUST stop processing SedGrpOfferKeyType elements in the request at
the first error, and roll back any SedGrpOfferKeyType elements
that had already been processed for that accept request ("stop and rollback").
<!-- With respect to handling of error conditions, it is a matter of policy
whether the objects are processed in a "stop and rollback" fashion or
in a "stop and commit" fashion. In the "stop and rollback" scenario,
the SPPF server would stop processing SedGrpOfferKeyType elements in the
request at the first error and roll back any SedGrpOfferKeyType elements
that had already been processed for that accept request.
In the "stop and commit" scenario the SPPF server would stop
processing SedGrpOfferKeyType elements in the request at the
first error but commit any SedGrpOfferKeyType elements
that had already been processed for that accept request. -->
</t>
</list>
</t>
</section>
<section anchor="acceptresponse" title="Accept Response">
<t> An SPP Protocol over SOAP accept response structure is contained within the generic
<![CDATA[<sppAcceptResponse>]]> element. This response structure is used for an Accept request on a SED Group Offer.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppAcceptResponse">
<complexType>
<sequence>
<element name="clientTransId" type="sppfb:TransIdType"
minOccurs="0"/>
<element name="serverTransId" type="sppfb:TransIdType"/>
<element name="overallResult" type="sppfb:ResultCodeType"/>
<element name="detailResult"
type="sppfs:SedGrpOfferKeyResultCodeType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<complexType name="ResultCodeType">
<sequence>
<element name="code" type="int"/>
<element name="msg" type="string"/>
</sequence>
</complexType>
<complexType name="SedGrpOfferKeyResultCodeType">
<complexContent>
<extension base="sppfs:ResultCodeType">
<sequence>
<element name="sedGrpOfferKey" type="sppfs:SedGrpOfferKeyType"/>
</sequence>
</extension>
</complexContent>
</complexType>
]]>
</artwork>
</figure>
</t>
<t> An <![CDATA[<spppAcceptResponse>]]> contains the
elements necessary for the SPPF client to precisely determine the
overall result of the request, and if an error occurred, it provides
information about the specific SED Group Offer key(s) that
caused the error. </t>
<t> The data elements within the SPP Protocol over SOAP Accept response are
described as follows: <list style="symbols" hangIndent="5">
<t> clientTransId: Zero or one client transaction ID. This
value is simply an echo of the client transaction ID that
SPPF client passed into the SPPF update request. When included
in the request, the SPPF server MUST return it in the corresponding
response message.</t>
<t> serverTransId: Exactly one server transaction ID that
identifies this request for tracking purposes. This
value MUST be unique for a given SPPF server. </t>
<t> overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details. </t>
<t> detailResult: An optional response code, response message,
and SedGrpOfferKeyType (as defined in this document) triplet. This element will be present only if any specific SED Group Offer key level error has occurred.
It indicates the error condition and the exact request SED Group Offer key that contributed to the error. The response code will reflect the exact error.
See the Response Code section for further details.</t>
</list>
</t>
</section>
</section>
<section anchor="rejects" title="Reject Operation Structure">
<t>In SPPF, SED Group Offer can be accepted or rejected by, or on behalf of, the registrant to
whom the SED Group has been offered (refer "Framework Data Model Objects" section of the framework document for a description
of the SED Group Offer object). The Reject operation is used to reject such SED Group Offers by, or on
behalf of, the Registrant. The request structure for an SPP Protocol over SOAP Reject operation is wrapped within the
<![CDATA[<spppRejectRequest> ]]> element while an SPP Protocol over SOAP Reject response is
wrapped within the generic <![CDATA[<spppRejecResponse>]]> element.
The following sub-sections describe the spppRejectRequest and spppRejecResponse elements. Refer the "SPP Protocol over SOAP Examples" section of this document for an example of Reject operation on a SED Group Offer.</t>
<section anchor="rejectrqst" title="Reject Request">
<t> An SPP Protocol over SOAP Reject request definition is contained within the generic
<![CDATA[<spppRejectRequest>]]> element. </t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppRejectRequest">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<element name="sedGrpOfferKey"
type="sppfs:SedGrpOfferKeyType"
maxOccurs="unbounded"/>
</complexType>
</element>
]]>
</artwork>
</figure>
</t>
<t> The data elements within the <![CDATA[<spppRejectRequest>]]>
element are described as follows:
<list style="symbols" hangIndent="5">
<t> clientTransId: Zero or one client-generated transaction ID
that, within the context of the SPPF client, identifies this
request. This value can be used at the discretion of the SPPF
client to track, log or correlate requests and their responses. SPPF server MUST echo back this value to the client in the corresponding response to the incoming request.
SPPF server will not check this value for uniqueness. </t>
<t> minorVer: Zero or one minor version identifier, indicating the minor
version of the SPPF API that the client is attempting to use. This is
used in conjunction with the major version identifier in
the XML namespace to identify the version of SPPF that the client
is using. If the element is not present, the server assumes that
the client is using the latest minor version supported by the SPPF
server for the given major version. The versions supported by a
given SPPF server can be retrieved by the client using the
SPPF server menu operation described later in the document.</t>
<t>sedGrpOfferKey: One or more elements of type SedGrpOfferKeyType (as defined in this document). Each element contains attributes that uniquely identify
a SED Group Offer that the client is requesting the server to reject. The elements are processed
by the SPPF server in the order in which they are included in the request.
With respect to handling of error conditions, conforming SPPP SOAP servers
MUST stop processing SedGrpOfferKeyType elements in the request at
the first error, and roll back any SedGrpOfferKeyType elements
that had already been processed for that reject request ("stop and rollback").
<!-- With respect to handling of error conditions, it is a matter of policy
whether the objects are processed in a "stop and rollback" fashion or
in a "stop and commit" fashion. In the "stop and rollback" scenario,
the SPPF server would stop processing SedGrpOfferKeyType elements in the
request at the first error and roll back any SedGrpOfferKeyType elements
that had already been processed for that reject request.
In the "stop and commit" scenario the SPPF server would stop
processing SedGrpOfferKeyType elements in the request at the
first error but commit any SedGrpOfferKeyType elements
that had already been processed for that reject request. -->
</t>
</list>
</t>
</section>
<section anchor="rejectresponse" title="Reject Response">
<t> An SPP Protocol over SOAP reject response structure is contained within the generic
<![CDATA[<sppRejectResponse>]]> element. This response structure is used for an Reject request on a SED Group Offer.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppRejectResponse">
<complexType>
<sequence>
<element name="clientTransId" type="sppfb:TransIdType"
minOccurs="0"/>
<element name="serverTransId" type="sppfb:TransIdType"/>
<element name="overallResult" type="sppfb:ResultCodeType"/>
<element name="detailResult"
type="sppfs:SedGrpOfferKeyResultCodeType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<complexType name="ResultCodeType">
<sequence>
<element name="code" type="int"/>
<element name="msg" type="string"/>
</sequence>
</complexType>
<complexType name="SedGrpOfferKeyResultCodeType">
<complexContent>
<extension base="sppfs:ResultCodeType">
<sequence>
<element name="sedGrpOfferKey" type="sppfs:SedGrpOfferKeyType"/>
</sequence>
</extension>
</complexContent>
</complexType>
]]>
</artwork>
</figure>
</t>
<t> An <![CDATA[<spppRejectResponse>]]> contains the
elements necessary for the SPPF client to precisely determine the
overall result of the request, and if an error occurred, it provides
information about the specific SED Group Offer key(s) that
caused the error. </t>
<t> The data elements within the SPP Protocol over SOAP Reject response are
described as follows: <list style="symbols" hangIndent="5">
<t> clientTransId: Zero or one client transaction ID. This
value is simply an echo of the client transaction ID that
SPPF client passed into the SPPF update request. When included
in the request, the SPPF server MUST return it in the corresponding
response message.</t>
<t> serverTransId: Exactly one server transaction ID that
identifies this request for tracking purposes. This
value MUST be unique for a given SPPF server. </t>
<t> overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details. </t>
<t> detailResult: An optional response code, response message,
and SedGrpOfferKeyType (as defined in this document) triplet. This element will be present only if any specific SED Group Offer key level error has occurred.
It indicates the error condition and the exact request SED Group Offer key that contributed to the error. The response code will reflect the exact error.
See the Response Code section for further details.</t>
</list>
</t>
</section>
</section>
<section anchor="batchopn" title="Batch Operation Structure">
<t>An SPP Protocol over SOAP Batch request XML structure allows the SPPF client to send any of
of Add, Del, Accept or Reject operations together in one single request. This gives an SPPF Client the
flexibility to use one single request structure to perform more than operations (verbs).
The batch request structure is wrapped within the
<![CDATA[<spppBatchRequest> ]]> element while a SPPF Batch response is
wrapped within the <![CDATA[<spppBatchResponse>]]> element.
This following sub-sections describe the spppBatchRequest and spppBatchResponse elements. Refer the "SPP Protocol over SOAP Examples" section of this document for an example of a batch operation.</t>
<section anchor="batchreq" title="Batch Request Structure">
<t> An SPP Protocol over SOAP Batch request definition is contained within the generic
<![CDATA[<spppBatchRequest>]]> element.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppBatchRequest">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<choice minOccurs="1" maxOccurs="unbounded">
<element name="addObj" type="sppfb:BasicObjType"/>
<element name="delObj" type="sppfb:ObjKeyType"/>
<element name="acceptSedGrpOffer"
type="sppfs:SedGrpOfferKeyType"/>
<element name="rejectSedGrpOffer"
type="sppfs:SedGrpOfferKeyType"/>
</choice>
</sequence>
</complexType>
</element>
]]>
</artwork>
</figure>
</t>
<t> The data elements within the <![CDATA[<sppBatchRequest>]]>
element are described as follows:
<list style="symbols" hangIndent="5">
<t> clientTransId: Zero or one client-generated transaction ID
that, within the context of the SPPF client, identifies this
request. This value can be used at the discretion of the SPPF
client to track, log or correlate requests and their responses. SPPF server MUST echo back this value to the client in the corresponding response to the incoming request.
SPPF server will not check this value for uniqueness. </t>
<t> minorVer: Zero or one minor version identifier, indicating the minor
version of the SPPF API that the client is attempting to use. This is
used in conjunction with the major version identifier in
the XML namespace to identify the version of SPPF that the client
is using. If the element is not present, the server assumes that
the client is using the latest minor version supported by the SPPF
server for the given major version. The versions supported by a
given SPPF server can be retrieved by the client using the
SPPF server menu operation described later in the document.</t>
<t>addObj: One or more elements of abstract type BasicObjType where each element identifies an object that needs to be added.</t>
<t>delObj: One or more elements of abstract type ObjKeyType where each element identifies a key for the object that needs to be deleted .</t>
<t>acceptSedGrpOffer: One or more elements of type SedGrpOfferKeyType where each element identifies a SED Group Offer that needs to be accepted.</t>
<t>rejectSedGrpOffer: One or more elements of type SedGrpOfferKeyType where each element identifies a SED Group Offer that needs to be rejected.</t>
</list>
</t>
<t>With respect to handling of error conditions, conforming SPPP SOAP servers
MUST stop processing elements in the request at
the first error, and roll back any elements
that had already been processed for that batch request ("stop and rollback").
<!-- With respect to handling of error conditions, it is a matter of policy
whether the batch operation processed in a "stop and rollback" fashion or
in a "stop and commit" fashion. In the "stop and rollback" scenario,
the SPPF server would stop processing elements in the
request at the first error and roll back any elements
that had already been processed for that batch request.
In the "stop and commit" scenario the SPPF server would stop
processing elements in the request at the
first error but commit any elements
that had already been processed for that batch request. -->
</t>
</section>
<section anchor="batchresponse" title="Batch Response">
<t> An SPP Protocol over SOAP batch response structure is contained within the generic
<![CDATA[<sppBatchResponse>]]> element. This response structure is used for an Batch request that contains many different types of SPPF operations.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppBatchResponse">
<complexType>
<sequence>
<element name="clientTransId" type="sppfb:TransIdType"
minOccurs="0"/>
<element name="serverTransId" type="sppfb:TransIdType"/>
<element name="overallResult" type="sppfb:ResultCodeType"/>
<choice minOccurs="0" maxOccurs="unbounded">
<element name="addResult"
type="sppfs:ObjResultCodeType"/>
<element name="delResult"
type="sppfs:ObjKeyResultCodeType"/>
<element name="acceptResult"
type="sppfs:SedGrpOfferKeyResultCodeType"/>
<element name="rejectResult"
type="sppfs:SedGrpOfferKeyResultCodeType"/>
</choice>
</sequence>
</complexType>
</element>
]]>
</artwork>
</figure>
</t>
<t> An <![CDATA[<spppBatchResponse>]]> contains the
elements necessary for an SPPF client to precisely determine the
overall result of various operations in the request, and if an error occurred, it provides
information about the specific objects or keys in the request that
caused the error. </t>
<t> The data elements within the SPP Protocol over SOAP Batch response are
described as follows: <list style="symbols" hangIndent="5">
<t> clientTransId: Zero or one client transaction ID. This
value is simply an echo of the client transaction ID that
SPPF client passed into the SPPF update request. When included
in the request, the SPPF server MUST return it in the corresponding
response message.</t>
<t> serverTransId: Exactly one server transaction ID that
identifies this request for tracking purposes. This
value MUST be unique for a given SPPF server. </t>
<t> overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details. </t>
<t>addResult: One or more elements of type ObjResultCodeType where each element identifies the result code, result message and the specific object that the result relates to.</t>
<t>delResult: One or more elements of type ObjKeyResultCodeType where each element identifies the result code, result message and the specific object key that the result relates to.</t>
<t>acceptResult: One or more elements of type SedGrpOfferKeyResultCodeType where each element identifies the result code, result message and the specific SED Group Offer key that the result relates to.</t>
<t>rejectResult: One or more elements of type SedGrpOfferKeyResultCodeType where each element identifies the result code, result message and the specific SED Group Offer key that the result relates to.</t>
</list>
</t>
</section>
</section>
<section anchor="gets" title="Get Operation Structure">
<t> In order to query the details of an object from the Registry, an authorized entity
can send the spppGetRequest to the registry with a GetRqstType XML data structure containing one or more
object keys that uniquely identify the object whose details are being queried. The request structure for an SPP Protocol over SOAP Get operation is contained within the generic
<![CDATA[<spppGetRequest>]]> element while an SPP Protocol over SOAP Get response is
wrapped within the generic <![CDATA[<spppGetResponse>]]> element.
The following sub-sections describe the spppGetRequest and spppGetResponse element. Refer the examples section for an example of SPP Protocol over SOAP Get operation on each type of SPPF object</t>
<section anchor="getreq" title="Get Request">
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppGetRequest">
<complexType>
<sequence>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<element name="objKey"
type="sppfb:ObjKeyType"
maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
]]>
</artwork>
</figure>
</t>
<t> The data elements within the <![CDATA[<spppGetRequest>]]>
element are described as follows:
<list style="symbols" hangIndent="5">
<t> minorVer: Zero or one minor version identifier, indicating the minor
version of the SPPF API that the client is attempting to use. This is
used in conjunction with the major version identifier in
the XML namespace to identify the version of SPPF that the client
is using. If the element is not present, the server assumes that
the client is using the latest minor version supported by the SPPF
server for the given major version. The versions supported by a
given SPPF server can be retrieved by the client using the
SPPF server menu operation described later in the document.</t>
<t> objKey: One or more elements of abstract type ObjKeyType (as defined in the framework document). Each element contains attributes that uniquely identify
the object that the client is requesting the server to query. Refer the "Concrete Object Keys" section of this document
for a description of all concrete object key types, for various SPPF objects, which are eligible to be passed into this element.
</t>
</list>
</t>
</section>
<section anchor="getresponse" title="Get Response">
<t>The spppGetResponse
element is described later in section titled "Generic Query Response". </t>
</section>
</section>
<section anchor="getsedgrpoffers" title="Get SED Group Offers Operation Structure">
<t> In addition to the ability to query the details of one or more SED Group offers using an a SED Group Offer key in the spppGetRequest, this operation
also provides an additional, more flexible, structure to query for SED Group Offer objects. This additional structure is contained within the
<![CDATA[<getSedGrpOffersRequest>]]> element while the response is
wrapped within the generic <![CDATA[<spppGetResponse>]]> element.
The following sub-sections describe the getSedGrpOffersRequest and spppGetResponse elements.</t>
<section anchor="getsedgrpoffersrqst" title="Get SED Group Offers Request">
<t>Using the details passed into this structure, the server will
attempt to find SED Group Offer objects that satisfy all the criteria passed into the
request. If no criteria is passed in then the server will
return the list of SED Group Offer objects that belongs to the
registrant. If there are no matching SED Group Offers found then an empty result set
will be returned. </t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="getSedGrpOffersRequest">
<complexType>
<sequence>
<element name="minorVer" type="sppfb:MinorVerType"
minOccurs="0"/>
<element name="offeredBy" type="sppfb:OrgIdType"
minOccurs="0" maxOccurs="unbounded"/>
<element name="offeredTo" type="sppfb:OrgIdType"
minOccurs="0" maxOccurs="unbounded"/>
<element name="status" type="sppfb:SedGrpOfferStatusType"
minOccurs="0"/>
<element name="sedGrpOfferKey" type="sppfs:SedGrpOfferKeyType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
]]>
</artwork>
</figure>
</t>
<t> The data elements within the <![CDATA[<getSedGrpOffersRequest>]]>
element are described as follows:
<list style="symbols" hangIndent="5">
<t> minorVer: Zero or one minor version identifier, indicating the minor
version of the SPPF API that the client is attempting to use. This is
used in conjunction with the major version identifier in
the XML namespace to identify the version of SPPF that the client
is using. If the element is not present, the server assumes that
the client is using the latest minor version supported by the SPPF
server for the given major version. The versions supported by a
given SPPF server can be retrieved by the client using the
SPPF server menu operation described later in the document.</t>
<t> offeredBy: Zero or more organization IDs. Only offers
that are offered to the organization IDs
in this list should be included in the result set. The
result set is also subject to other query criteria in
the request.
</t>
<t> offeredTo: Zero or more organization IDs. Only offers
that are offered by the organization IDs
in this list should be included in the result set. The
result set is also subject to other query criteria in
the request.
</t>
<t> status: The status of the offer, offered or accepted.
Only offers in the specified status should be included
in the result set. If this element is not present then
the status of the offer should not be considered in the
query. The result set is also subject to other query
criteria in the request. </t>
<t> sedGrpOfferKey: Zero or more SED Group Offer Keys.
Only offers having one of these keys should be included
in the result set. The result set is also subject to
other query criteria in the request. </t>
</list>
</t>
</section>
<section anchor="getsedgrpoffersresponse" title="Get SED Group Offers Response">
<t>The spppGetResponse
element is described later in section titled "Generic Query Response". </t>
</section>
</section>
<section anchor="genericqueryresponse" title="Generic Query Response">
<t> An SPP Protocol over SOAP query response object is contained within the generic
<![CDATA[<spppGetResponse>]]> element. </t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppGetResponse">
<complexType>
<sequence>
<element name="overallResult"
type="sppfs:ResultCodeType"/>
<element name="resultObj"
type="sppfb:BasicObjType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
]]>
</artwork>
</figure>
</t>
<t> An <![CDATA[<spppGetResponse>]]> contains the
elements necessary for the SPPF client to precisely determine the
overall result of the query, and details of any SPPF objects that matched the criteria
in the request. </t>
<t> The data elements within the SPP Protocol over SOAP query response are
described as follows: <list style="symbols" hangIndent="5">
<t> overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details. </t>
<t> resultObj: The set of zero or more objects that matched the
query criteria. If no objects matched the query criteria then the
result object(s) MUST be empty and the overallResult value MUST indicate
success (if no matches are found for the query criteria, the
response is considered a success).</t>
</list>
</t>
</section>
<section anchor="servermenuopn" title="Get Server Details Operation Structure">
<t>In order to query certain details of the SPPF server, like the SPPF server's status and the major/minor version supported by the server,
the Server Details operation structure SHOULD be used. This structure is contained within the
<![CDATA[<spppServerStatusRequest>]]> element while a SPPF server status response is
wrapped within the <![CDATA[<spppServerStatusResponse>]]> element.
This following sub-sections describe the spppServerStatusRequest and spppServerStatusResponse elements.</t>
<section anchor="servermenurqst" title="Get Server Details Request">
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppServerStatusRequest">
<complexType>
<sequence>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
</sequence>
</complexType>
</element>
]]>
</artwork>
</figure>
</t>
<t> The data elements within the <![CDATA[<spppServerStatusRequest>]]>
element are described as follows:
<list style="symbols" hangIndent="5">
<t> minorVer: Zero or one minor version identifier, indicating the minor
version of the SPP Protocol over SOAP API that the client is attempting to use. This is
used in conjunction with the major version identifier in
the XML namespace to identify the version of SPP Protocol over SOAP that the client
is using. If the element is not present, the server assumes that
the client is using the latest minor version of SPP Protocol over SOAP supported by the SPPF
server for the given major version. The versions of SPP Protocol over SOAP supported by a
given SPPF server can be retrieved by the client using this same spppServerStatusRequest without passing in the minorVer element.</t>
</list>
</t>
</section>
<section anchor="servermenuresp" title="Get Server Details Response">
<t> An SPP Protocol over SOAP server details response structure is contained within the generic
<![CDATA[<spppServerStatusResponse>]]> element. </t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<element name="spppServerStatusResponse">
<complexType>
<sequence>
<element name="overallResult" type="sppfs:ResultCodeType"/>
<element name="svcMenu" type="sppfb:SvcMenuType"/>
</sequence>
</complexType>
</element>
]]>
</artwork>
</figure>
</t>
<t> The data elements within the <![CDATA[<spppServerStatusResponse>]]>
element are described as follows:
<list style="symbols" hangIndent="5">
<t> overallResult: Exactly one response code and message pair that
explicitly identifies the result of the request. See the
Response Code section for further details. </t>
<t> svcMenu: Exactly one element of type SvcMenuType which in turn contains the elements
to return the server status and major/minor version of the SPP Protocol over SOAP supported by the SPPF server (refer framework document for definition of SvcMenuType) .</t>
</list>
</t>
</section>
</section>
</section>
<section anchor="resultcodes" title="Response Codes and Messages">
<t> This section contains the listing of response codes
and their corresponding human-readable text. These response codes
are in conformance with the response types defined in the section "Response Message Types"
of the framework document.</t>
<t> The response code numbering scheme generally adheres to the
theory formalized in section 4.2.1 of <xref target="RFC5321"/>:
<list style="symbols" hangIndent="5">
<t> The first digit of the response code can only be 1 or 2:
1 = a positive result, 2 = a negative result. </t>
<t> The second digit of the response code indicates the
category: 0 = Protocol Syntax, 1 = Implementation Specific
Business Rule, 2 = Security, 3 = Server System. </t>
<t> The third and fourth digits of the response code
indicate the individual message event within the category
defines by the first two digits. </t>
</list>
</t>
<t> The response codes are also categorized as to whether they are
overall response codes that may only be returned in the "overallResult"
data element in SPPF responses, or object level response codes that
may only be returned in the "detailResult" element of the SPPF
responses.</t>
<texttable anchor="Table1"
title="Response Codes Numbering Scheme and Messages">
<ttcol align="left" width="10%">Result Code</ttcol>
<ttcol align="left" width="30%">Result Message</ttcol>
<ttcol align="left" width="60%">Overall or Object Level</ttcol>
<c> 1000 </c>
<c> Request Succeeded.</c>
<c> Overall Response Code</c>
<c> 2000 </c>
<c> Request syntax invalid.</c>
<c> Overall Response Code</c>
<c> 2001 </c>
<c> Request too large. MaxSupported:[Maximum requests supported]</c>
<c> Overall Response Code</c>
<c> 2002 </c>
<c> Version not supported.</c>
<c> Overall Response Code</c>
<c> 2100 </c>
<c> Command invalid.</c>
<c> Overall Response Code</c>
<c> 2300 </c>
<c> System temporarily unavailable.</c>
<c> Overall Response Code</c>
<c> 2301 </c>
<c> Unexpected internal system or server error.</c>
<c> Overall Response Code</c>
<c> 2101 </c>
<c> Attribute value invalid. AttrName:[AttributeName] AttrVal:[AttributeValue]</c>
<c> Object Level Response Code</c>
<c> 2102 </c>
<c> Object does not exist. AttrName:[AttributeName] AttrVal:[AttributeValue]</c>
<c> Object Level Response Code</c>
<c> 2103 </c>
<c> Object status or ownership does not allow for operation. AttrName:[AttributeName]
AttrVal:[AttributeValue]</c>
<c> Object Level Response Code</c>
</texttable>
<t> Response message for response code 2001 is "parameterized" with the
following parameter: "[Maximum requests supported]". When the request is too large, this
parameter MUST be used to indicate the maximum number of requests supported by
the server in a single protocol operation. </t>
<t> Each of the object level response messages are "parameterized" with the
following parameters: "AttributeName" and "AttributeValue". </t>
<t>For example, if an SPPF client sends a request to delete a Destination Group with a name "TestDG", and it
does not already exist, then the error message returned should be: "Attribute value invalid. AttrName:dgName AttrVal:TestDG".</t>
<t> The use of these parameters MUST adhere to the rules defined in "Response Message Types" section of the framework document.
</t>
</section>
</section>
<section anchor="protocol_oper" title="Protocol Operations">
<t>Refer the "Framework Operations" section of the framework document for a description of all SPPF operations, and any necessary semantics that MUST be adhered to
in order to conform with the SPPF specification.</t>
</section>
<section anchor="SPPPWSDL" title="SPP Protocol over SOAP WSDL Definition">
<t>The SPP Protocol over SOAP WSDL and data types are defined below. The WSDL design approach is commonly referred to as _Generic WSDL_.
It is generic in the sense that there is not a specific WSDL operation defined for each object type that is supported by the SPPF protocol.
There is a single WSDL structure for each type of SPPF operation. Each such WSDL structure contains exactly one input structure and one output structure that wraps any data elements
that are part of the incoming request and the outgoing response respectively. The spppSOAPBinding in the WSDL defines the binding style as _document_ and the encoding as _literal_.
It is this combination of _wrapped_ input and output data structures, _document_ binding style, and _literal_ encoding that characterize the Document Literal Wrapped style of WSDL specifications.</t>
<t>
Note: The following WSDL has been formatted (e.g., tabs, spaces) to meet I-D requirements.
</t>
<t>
<figure anchor="WSDL" title="WSDL">
<artwork align="left"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:sppfb="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:sppfs="urn:ietf:params:xml:ns:sppf:soap:1"
targetNamespace="urn:ietf:params:xml:ns:sppf:soap:1">
<wsdl:types>
<xsd:schema xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:sppfs="urn:ietf:params:xml:ns:sppf:soap:1"
targetNamespace="urn:ietf:params:xml:ns:sppf:soap:1">
<annotation>
<documentation>
---- Import base schema ----
</documentation>
</annotation>
<import namespace="urn:ietf:params:xml:ns:sppf:base:1"
schemaLocation="sppfbase.xsd"/>
<annotation>
<documentation>
---- Key type(s) extended
from base schema. ----
</documentation>
</annotation>
<complexType name="ObjKeyType">
<complexContent>
<extension base="sppfb:ObjKeyType">
<sequence>
<element name="rant" type="sppfb:OrgIdType"/>
<element name="name" type="sppfb:ObjNameType"/>
<element name="type" type="sppfs:ObjKeyTypeEnum"/>
</sequence>
</extension>
</complexContent>
</complexType>
<simpleType name="ObjKeyTypeEnum">
<restriction base="token">
<enumeration value="SedGrp"/>
<enumeration value="DestGrp"/>
<enumeration value="SedRec"/>
<enumeration value="EgrRte"/>
</restriction>
</simpleType>
<complexType name="SedGrpOfferKeyType">
<complexContent>
<extension base="sppfb:SedGrpOfferKeyType">
<sequence>
<element name="sedGrpKey"
type="sppfs:ObjKeyType"/>
<element name="offeredTo"
type="sppfb:OrgIdType"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="PubIdKeyType">
<complexContent>
<extension base="sppfb:PubIdKeyType">
<sequence>
<element name="rant" type="sppfb:OrgIdType"/>
<element name="dgName"
type="sppfb:ObjNameType" minOccurs="0"/>
<choice>
<element name="number"
type="sppfb:NumberType"/>
<element name="range"
type="sppfb:NumberRangeType"/>
</choice>
</sequence>
</extension>
</complexContent>
</complexType>
<annotation>
<documentation>
---- Generic Request and
Response Definitions ----
</documentation>
</annotation>
<element name="spppAddRequest">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<element name="obj" type="sppfb:BasicObjType"
maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<element name="spppDelRequest">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<element name="objKey"
type="sppfb:ObjKeyType" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<element name="spppAcceptRequest">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<element name="sedGrpOfferKey"
type="sppfs:SedGrpOfferKeyType"
maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<element name="spppRejectRequest">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<element name="sedGrpOfferKey"
type="sppfs:SedGrpOfferKeyType"
maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<element name="spppGetRequest">
<complexType>
<sequence>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<element name="objKey"
type="sppfb:ObjKeyType"
maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<element name="spppBatchRequest">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<choice minOccurs="1" maxOccurs="unbounded">
<element name="addObj" type="sppfb:BasicObjType"/>
<element name="delObj" type="sppfb:ObjKeyType"/>
<element name="acceptSedGrpOffer"
type="sppfs:SedGrpOfferKeyType"/>
<element name="rejectSedGrpOffer"
type="sppfs:SedGrpOfferKeyType"/>
</choice>
</sequence>
</complexType>
</element>
<element name="spppServerStatusRequest">
<complexType>
<sequence>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
</sequence>
</complexType>
</element>
<element name="getSedGrpOffersRequest">
<complexType>
<sequence>
<element name="minorVer"
type="sppfb:MinorVerType" minOccurs="0"/>
<element name="offeredBy"
type="sppfb:OrgIdType" minOccurs="0"
maxOccurs="unbounded"/>
<element name="offeredTo" type="sppfb:OrgIdType"
minOccurs="0" maxOccurs="unbounded"/>
<element name="status"
type="sppfb:SedGrpOfferStatusType" minOccurs="0"/>
<element name="sedGrpOfferKey"
type="sppfs:SedGrpOfferKeyType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<element name="spppAddResponse">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="serverTransId"
type="sppfb:TransIdType"/>
<element name="overallResult"
type="sppfs:ResultCodeType"/>
<element name="detailResult"
type="sppfs:ObjResultCodeType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<element name="spppDelResponse">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="serverTransId"
type="sppfb:TransIdType"/>
<element name="overallResult"
type="sppfs:ResultCodeType"/>
<element name="detailResult"
type="sppfs:ObjKeyResultCodeType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<element name="spppAcceptResponse">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="serverTransId"
type="sppfb:TransIdType"/>
<element name="overallResult"
type="sppfs:ResultCodeType"/>
<element name="detailResult"
type="sppfs:SedGrpOfferKeyResultCodeType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<element name="spppRejectResponse">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="serverTransId"
type="sppfb:TransIdType"/>
<element name="overallResult"
type="sppfs:ResultCodeType"/>
<element name="detailResult"
type="sppfs:SedGrpOfferKeyResultCodeType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<element name="spppBatchResponse">
<complexType>
<sequence>
<element name="clientTransId"
type="sppfb:TransIdType" minOccurs="0"/>
<element name="serverTransId"
type="sppfb:TransIdType"/>
<element name="overallResult"
type="sppfs:ResultCodeType"/>
<choice minOccurs="0" maxOccurs="unbounded">
<element name="addResult"
type="sppfs:ObjResultCodeType"/>
<element name="delResult"
type="sppfs:ObjKeyResultCodeType"/>
<element name="acceptResult"
type="sppfs:SedGrpOfferKeyResultCodeType"/>
<element name="rejectResult"
type="sppfs:SedGrpOfferKeyResultCodeType"/>
</choice>
</sequence>
</complexType>
</element>
<element name="spppGetResponse">
<complexType>
<sequence>
<element name="overallResult"
type="sppfs:ResultCodeType"/>
<element name="resultObj"
type="sppfb:BasicObjType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<element name="spppServerStatusResponse">
<complexType>
<sequence>
<element name="overallResult"
type="sppfs:ResultCodeType"/>
<element name="svcMenu"
type="sppfb:SvcMenuType"/>
</sequence>
</complexType>
</element>
<annotation>
<documentation>
---- Operation Result Type
Definitions ----
</documentation>
</annotation>
<complexType name="ResultCodeType">
<sequence>
<element name="code" type="sppfs:ResultCodeValType"/>
<element name="msg" type="sppfs:MsgType"/>
</sequence>
</complexType>
<simpleType name="ResultCodeValType">
<restriction base="unsignedShort">
<enumeration value="1000"/>
<enumeration value="2000"/>
<enumeration value="2001"/>
<enumeration value="2002"/>
<enumeration value="2100"/>
<enumeration value="2101"/>
<enumeration value="2102"/>
<enumeration value="2103"/>
<enumeration value="2300"/>
<enumeration value="2301"/>
</restriction>
</simpleType>
<simpleType name="MsgType">
<restriction base="token">
<minLength value="3"/>
<maxLength value="255"/>
</restriction>
</simpleType>
<complexType name="ObjResultCodeType">
<complexContent>
<extension base="sppfs:ResultCodeType">
<sequence>
<element name="obj" type="sppfb:BasicObjType"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="ObjKeyResultCodeType">
<complexContent>
<extension base="sppfs:ResultCodeType">
<sequence>
<element name="objKey" type="sppfb:ObjKeyType"/>
</sequence>
</extension>
</complexContent>
</complexType>
<complexType name="SedGrpOfferKeyResultCodeType">
<complexContent>
<extension base="sppfs:ResultCodeType">
<sequence>
<element name="sedGrpOfferKey"
type="sppfs:SedGrpOfferKeyType"/>
</sequence>
</extension>
</complexContent>
</complexType>
</xsd:schema>
</wsdl:types>
<wsdl:message name="spppAddRequestMsg">
<wsdl:part name="rqst" element="sppfs:spppAddRequest"/>
</wsdl:message>
<wsdl:message name="spppDelRequestMsg">
<wsdl:part name="rqst" element="sppfs:spppDelRequest"/>
</wsdl:message>
<wsdl:message name="spppAcceptRequestMsg">
<wsdl:part name="rqst" element="sppfs:spppAcceptRequest"/>
</wsdl:message>
<wsdl:message name="spppRejectRequestMsg">
<wsdl:part name="rqst" element="sppfs:spppRejectRequest"/>
</wsdl:message>
<wsdl:message name="spppBatchRequestMsg">
<wsdl:part name="rqst" element="sppfs:spppBatchRequest"/>
</wsdl:message>
<wsdl:message name="spppGetRequestMsg">
<wsdl:part name="rqst" element="sppfs:spppGetRequest"/>
</wsdl:message>
<wsdl:message name="spppGetSedGrpOffersRequestMsg">
<wsdl:part name="rqst" element="sppfs:getSedGrpOffersRequest"/>
</wsdl:message>
<wsdl:message name="spppAddResponseMsg">
<wsdl:part name="rspns" element="sppfs:spppAddResponse"/>
</wsdl:message>
<wsdl:message name="spppDelResponseMsg">
<wsdl:part name="rspns" element="sppfs:spppDelResponse"/>
</wsdl:message>
<wsdl:message name="spppAcceptResponseMsg">
<wsdl:part name="rspns" element="sppfs:spppAcceptResponse"/>
</wsdl:message>
<wsdl:message name="spppRejectResponseMsg">
<wsdl:part name="rspns" element="sppfs:spppRejectResponse"/>
</wsdl:message>
<wsdl:message name="spppBatchResponseMsg">
<wsdl:part name="rspns" element="sppfs:spppBatchResponse"/>
</wsdl:message>
<wsdl:message name="spppGetResponseMsg">
<wsdl:part name="rspns" element="sppfs:spppGetResponse"/>
</wsdl:message>
<wsdl:message name="spppServerStatusRequestMsg">
<wsdl:part name="rqst" element="sppfs:spppServerStatusRequest"/>
</wsdl:message>
<wsdl:message name="spppServerStatusResponseMsg">
<wsdl:part name="rspns" element="sppfs:spppServerStatusResponse"/>
</wsdl:message>
<wsdl:portType name="spppPortType">
<wsdl:operation name="submitAddRqst">
<wsdl:input message="sppfs:spppAddRequestMsg"/>
<wsdl:output message="sppfs:spppAddResponseMsg"/>
</wsdl:operation>
<wsdl:operation name="submitDelRqst">
<wsdl:input message="sppfs:spppDelRequestMsg"/>
<wsdl:output message="sppfs:spppDelResponseMsg"/>
</wsdl:operation>
<wsdl:operation name="submitAcceptRqst">
<wsdl:input message="sppfs:spppAcceptRequestMsg"/>
<wsdl:output message="sppfs:spppAcceptResponseMsg"/>
</wsdl:operation>
<wsdl:operation name="submitRejectRqst">
<wsdl:input message="sppfs:spppRejectRequestMsg"/>
<wsdl:output message="sppfs:spppRejectResponseMsg"/>
</wsdl:operation>
<wsdl:operation name="submitBatchRqst">
<wsdl:input message="sppfs:spppBatchRequestMsg"/>
<wsdl:output message="sppfs:spppBatchResponseMsg"/>
</wsdl:operation>
<wsdl:operation name="submitGetRqst">
<wsdl:input message="sppfs:spppGetRequestMsg"/>
<wsdl:output message="sppfs:spppGetResponseMsg"/>
</wsdl:operation>
<wsdl:operation name="submitGetSedGrpOffersRqst">
<wsdl:input message="sppfs:spppGetSedGrpOffersRequestMsg"/>
<wsdl:output message="sppfs:spppGetResponseMsg"/>
</wsdl:operation>
<wsdl:operation name="submitServerStatusRqst">
<wsdl:input message="sppfs:spppServerStatusRequestMsg"/>
<wsdl:output message="sppfs:spppServerStatusResponseMsg"/>
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="spppSoapBinding" type="sppfs:spppPortType">
<soap:binding style="document"
transport="http://schemas.xmlsoap.org/soap/http"/>
<wsdl:operation name="submitAddRqst">
<soap:operation soapAction="submitAddRqst" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="submitDelRqst">
<soap:operation soapAction="submitDelRqst" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="submitAcceptRqst">
<soap:operation soapAction="submitAcceptRqst" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="submitRejectRqst">
<soap:operation soapAction="submitRejectRqst" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="submitBatchRqst">
<soap:operation soapAction="submitBatchRqst" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="submitGetRqst">
<soap:operation soapAction="submitGetRqst" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="submitGetSedGrpOffersRqst">
<soap:operation soapAction="submitGetSedGrpOffersRqst"
style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="submitServerStatusRqst">
<soap:operation soapAction="submitServerStatusRqst"
style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="spppService">
<wsdl:port name="spppPort" binding="sppfs:spppSoapBinding">
<soap:address location="REPLACE_WITH_ACTUAL_URL"/>
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
]]></artwork>
</figure></t>
</section>
<section anchor="examples" title="SPP Protocol over SOAP Examples">
<t>This section shows XML message exchange between two SIP Service
Providers (SSP) and a registry. The
messages in this section are valid XML instances that conform to the
SPP Protocol over SOAP schema version within this document. This section
relies on the XML data structures defined in the base SPPF specification <xref target="I-D.draft-ietf-drinks-spp-framework"/>.
So refer to that document to understand XML object types embedded in these example messages.</t>
<t>In this sample use case scenario, SSP1 and SSP2 provision
resource data in the registry and use SPPF constructs to selectively
share the SED groups. In the figure below, SSP2 has two ingress
SBE instances that are associated with the public identities that
SSP2 has the retail relationship with. Also, the two SBE instances
for SSP1 are used to show how to use SPPF to associate
route preferences for the destination ingress routes and exercise
greater control on outbound traffic to the peer's ingress SBEs.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
---------------+ +------------------
| |
+------+ +------+
| sbe1 | | sbe2 |
+------+ +------+
SSP1 | | SSP2
+------+ +------+
| sbe3 | | sbe4 |
+------+ +------+
iana-en:111 | | iana-en:222
---------------+ +------------------
| |
| |
| SPPF +------------------+ SPPF |
+------->| Registry |<--------+
+------------------+
]]>
</artwork>
</figure>
</t>
<section anchor="add_destgrp" title="Add Destination Group">
<t>SSP2 adds a destination group to the registry for use later. The
SSP2 SPPF client sets a unique transaction identifier 'txn_1479' for
tracking purposes. The name of the destination group is set to DEST_GRP_SSP2_1</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppAddRequest>
<!--Optional:-->
<clientTransId>txn_1479</clientTransId>
<!--1 or more repetitions:-->
<obj xsi:type="urn1:DestGrpType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:dgName>DEST_GRP_SSP2_1</urn1:dgName>
</obj>
</urn:spppAddRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>The registry processes the request and return a favorable
response confirming successful creation of the named
destination group. Also, besides returning a unique server transaction
identifier, Registry also returns the matching client transaction
identifier from the request message back to the SPPF client.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppAddResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<clientTransId>txn_1479</clientTransId>
<serverTransId>tx_12345</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppAddResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="add_sedrecs" title="Add SED Records">
<t>SSP2 adds SED records in the form of ingress routes to the registry.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppAddRequest>
<!--Optional:-->
<clientTransId>txn_1479</clientTransId>
<!--1 or more repetitions:-->
<obj xsi:type="urn1:NAPTRType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:sedName>SED_SSP2_SBE2</urn1:sedName>
<urn1:isInSvc>true</urn1:isInSvc>
<urn1:order>10</urn1:order>
<urn1:flags>u</urn1:flags>
<urn1:svcs>E2U+sip</urn1:svcs>
<urn1:regx>
<urn1:ere>^(.*)$</urn1:ere>
<urn1:repl>sip:\1@sbe2.ssp2.example.com</urn1:repl>
</urn1:regx>
</obj>
</urn:spppAddRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>The registry returns a success response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppAddResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<clientTransId>txn_1479</clientTransId>
<serverTransId>tx_12345</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppAddResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="add_sedrecs_uritype" title="Add SED Records -- URIType">
<t>SSP2 adds another SED record to the registry and makes use of URIType</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppAddRequest>
<clientTransId>txn_1479</clientTransId>
<!--1 or more repetitions:-->
<obj xsi:type="urn1:URIType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:sedName>SED_SSP2_SBE4</urn1:sedName>
<urn1:isInSvc>true</urn1:isInSvc>
<urn1:ere>^(.*)$</urn1:ere>
<urn1:uri>sip:\1;npdi@sbe4.ssp2.example.com</urn1:uri>
</obj>
</urn:spppAddRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>The registry returns a success response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppAddResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<clientTransId>txn_1479</clientTransId>
<serverTransId>tx_12345</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppAddResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="add_sedgrp" title="Add SED Group">
<t>SSP2 creates the grouping of SED records (e.g. ingress routes) and chooses higher precedence for SED_SSP2_SBE2 by setting a lower number for the "priority" attribute, a protocol agnostic precedence indicator.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppAddRequest>
<clientTransId>txn_1479</clientTransId>
<!--1 or more repetitions:-->
<obj xsi:type="urn1:SedGrpType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:sedGrpName>SED_GRP_SSP2_1</urn1:sedGrpName>
<urn1:sedRecRef>
<urn1:sedKey xsi:type="urn:ObjKeyType">
<rant>iana-en:222</rant>
<name>SED_SSP2_SBE2</name>
<type>SedRec</type>
</urn1:sedKey>
<urn1:priority>100</urn1:priority>
</urn1:sedRecRef>
<urn1:dgName>DEST_GRP_SSP2_1</urn1:dgName>
<urn1:isInSvc>true</urn1:isInSvc>
<urn1:priority>10</urn1:priority>
</obj>
</urn:spppAddRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>To confirm successful processing of this request, registry returns a well-known result code '1000' to the SSP2 client.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppAddResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<clientTransId>txn_1479</clientTransId>
<serverTransId>tx_12345</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppAddResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="add_pi_corclaim" title="Add Public Identity -- Successful COR claim">
<t>SSP2 activates a TN public identity by associating it with a valid destination group. Further, SSP2 puts forth a claim that it is the carrier-of-record for the TN.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppAddRequest>
<clientTransId>txn_1479</clientTransId>
<!--1 or more repetitions:-->
<obj xsi:type="urn1:TNType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:dgName>DEST_GRP_SSP2_1</urn1:dgName>
<urn1:tn>+12025556666</urn1:tn>
<urn1:corInfo>
<urn1:corClaim>true</urn1:corClaim>
</urn1:corInfo>
</obj>
</urn:spppAddRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Assuming that the registry has access to TN authority data and it performs the required checks to verify that SSP2 is in fact the service provider of record for the given TN, the request is processed successfully. In the response message, the registry sets the value of <cor> to "true" in order to confirm SSP2 claim as the carrier of record and the <corDate> reflects the time when the carrier of record claim is processed.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<S:Body>
<ns3:spppAddResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<clientTransId>txn_1479</clientTransId>
<serverTransId>tx_12345</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
<detailResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
<obj xsi:type="ns2:TNType">
<ns2:rant>iana-en:222</ns2:rant>
<ns2:rar>iana-en:223</ns2:rar>
<ns2:cDate>2010-05-30T09:30:10Z</ns2:cDate>
<ns2:dgName>DEST_GRP_SSP2_1</ns2:dgName>
<ns2:tn>+12025556666</ns2:tn>
<ns2:corInfo>
<ns2:corClaim>true</ns2:corClaim>
<ns2:cor>true</ns2:cor>
<ns2:corDate>2010-05-30T09:30:11Z</ns2:corDate>
</ns2:corInfo>
</obj>
</detailResult>
</ns3:spppAddResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="add_lrn" title="Add LRN">
<t>If another entity that SSP2 shares session establishment information (e.g. routes) with has access to Number Portability data, it may choose to perform route lookups by routing number. Therefore, SSP2 associates a routing number to a destination group in order to facilitate ingress route discovery.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppAddRequest>
<clientTransId>txn_1479</clientTransId>
<!--1 or more repetitions:-->
<obj xsi:type="urn1:RNType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:dgName>DEST_GRP_SSP2_1</urn1:dgName>
<urn1:rn>2025550000</urn1:rn>
</obj>
</urn:spppAddRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response to the SPPF client.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppAddResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<clientTransId>txn_1479</clientTransId>
<serverTransId>tx_12345</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppAddResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="add_tn_range" title="Add TN Range">
<t>Next, SSP2 activates a block of ten thousand TNs and associate it to a destination group.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppAddRequest>
<clientTransId>txn_1479</clientTransId>
<!--1 or more repetitions:-->
<obj xsi:type="urn1:TNRType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:dgName>DEST_GRP_SSP2_1</urn1:dgName>
<urn1:range>
<urn1:startTn>+12026660000</urn1:startTn>
<urn1:endTn>+12026669999</urn1:endTn>
</urn1:range>
</obj>
</urn:spppAddRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppAddResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<clientTransId>txn_1479</clientTransId>
<serverTransId>tx_12345</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppAddResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="add_tn_prefix" title="Add TN Prefix">
<t>Next, SSP2 activates a block of ten thousand TNs using the TNPType structure and identifying a TN prefix.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppAddRequest>
<clientTransId>txn_1479</clientTransId>
<!--1 or more repetitions:-->
<obj xsi:type="urn1:TNPType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:dgName>DEST_GRP_SSP2_1</urn1:dgName>
<urn1:tnPrefix>+1202777</urn1:tnPrefix>
</obj>
</urn:spppAddRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppAddResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<clientTransId>txn_1479</clientTransId>
<serverTransId>tx_12345</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppAddResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="add_sed_grp_offer" title="Enable Peering -- SED Group Offer">
<t>In order for SSP1 to complete session establishment for a destination TN where the target subscriber has a retail relationship with SSP2, it first requires an asynchronous bi-directional handshake to show mutual consent. To start the process, SSP2 initiates the peering handshake by offering SSP1 access to its SED group.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppAddRequest>
<clientTransId>txn_1479</clientTransId>
<!--1 or more repetitions:-->
<obj xsi:type="urn1:SedGrpOfferType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:sedGrpOfferKey xsi:type="urn:SedGrpOfferKeyType">
<sedGrpKey xsi:type="urn:ObjKeyType">
<rant>iana-en:222</rant>
<name>SED_GRP_SSP2_1</name>
<type>SedGrp</type>
</sedGrpKey>
<offeredTo>iana-en:111</offeredTo>
</urn1:sedGrpOfferKey>
<urn1:status>offered</urn1:status>
<urn1:offerDateTime>
2006-05-04T18:13:51.0Z
</urn1:offerDateTime>
</obj>
</urn:spppAddRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and confirms that the SSP1 will now have the opportunity to weigh in on the offer and either accept or reject it. The registry may employ out-of-band notification mechanisms for quicker updates to SSP1 so they can act faster, though this topic is beyond the scope of this document.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppAddResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<clientTransId>txn_1479</clientTransId>
<serverTransId>tx_12345</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppAddResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="add_sed_grp_offer_accept" title="Enable Peering -- SED Group Offer Accept">
<t>SSP1 responds to the offer from SSP2 and agrees to have visibility to SSP2 session establishment information (e.g. ingress routes).</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1">
<soapenv:Header/>
<soapenv:Body>
<urn:spppAcceptRequest>
<!--Optional:-->
<clientTransId>txn_1479</clientTransId>
<!--1 or more repetitions:-->
<sedGrpOfferKey>
<sedGrpKey>
<rant>iana-en:222</rant>
<name>SED_GRP_SSP2_1</name>
<type>SedGrp</type>
</sedGrpKey>
<offeredTo>iana-en:111</offeredTo>
</sedGrpOfferKey>
</urn:spppAcceptRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry confirms that the request has been processed successfully. From this point forward, if SSP1 looks up a public identity through the query resolution server,
where the public identity is part of the destination group by way of "SED_GRP_SSP2_1" session establishment data association, SSP2 ingress SBE information will be shared with SSP1.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppAcceptResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<clientTransId>txn_1479</clientTransId>
<serverTransId>tx_12350</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppAcceptResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="add_egress_rte" title="Add Egress Route">
<t>SSP1 wants to prioritize all outbound traffic to the ingress route associated with the "SED_GRP_SSP2_1" SED Group record, through "sbe1.ssp1.example.com".</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppAddRequest>
<clientTransId>txn_1479</clientTransId>
<!--1 or more repetitions:-->
<obj xsi:type="urn1:EgrRteType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:egrRteName>EGR_RTE_01</urn1:egrRteName>
<urn1:pref>50</urn1:pref>
<urn1:regxRewriteRule>
<urn1:ere>^(.*@)(.*)$</urn1:ere>
<urn1:repl>\1\2?route=sbe1.ssp1.example.com</urn1:repl>
</urn1:regxRewriteRule>
<urn1:ingrSedGrp xsi:type="urn:ObjKeyType">
<rant>iana-en:222</rant>
<name>SED_GRP_SSP2_1</name>
<type>SedGrp</type>
</urn1:ingrSedGrp>
</obj>
</urn:spppAddRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Since peering has already been established, the request to add the egress route has been successfully completed.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppAddResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<clientTransId>txn_1479</clientTransId>
<serverTransId>tx_12345</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppAddResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="sed_grp_offer_reject" title="Remove Peering -- SED Group Offer Reject">
<t>SSP1 had earlier accepted to have visibility to SSP2 session establishment data. SSP1 now decides to no longer maintain this visibility and hence rejects the SED Group Offer.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1">
<soapenv:Header/>
<soapenv:Body>
<urn:spppRejectRequest>
<!--Optional:-->
<clientTransId>txn_1479</clientTransId>
<!--1 or more repetitions:-->
<sedGrpOfferKey>
<sedGrpKey>
<rant>iana-en:222</rant>
<name>SED_GRP_SSP2_1</name>
<type>SedGrp</type>
</sedGrpKey>
<offeredTo>iana-en:111</offeredTo>
</sedGrpOfferKey>
</urn:spppRejectRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry confirms that the request has been processed successfully. From this point forward, if SSP1 looks up a public identity through the query resolution server,
where the public identity is part of the destination group by way of "SED_GRP_SSP2_1" session establishment data association, SSP2 ingress SBE information will NOT be shared with SSP1 and hence
SSP2 ingress SBE will NOT be returned in the query response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppRejectResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<clientTransId>txn_1479</clientTransId>
<serverTransId>tx_12350</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppRejectResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="get_dest_grp" title="Get Destination Group">
<t>SSP2 uses the 'spppGetRequest' operation to tally the last provisioned record for destination group DEST_GRP_SSP2_1.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppGetRequest>
<!--1 or more repetitions:-->
<objKey xsi:type="urn:ObjKeyType">
<rant>iana-en:222</rant>
<name>DEST_GRP_SSP2_1</name>
<type>DestGrp</type>
</objKey>
</urn:spppGetRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<S:Body>
<ns3:spppGetResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<overallResult>
<code>1000</code>
<msg>success</msg>
</overallResult>
<resultObj xsi:type="ns2:DestGrpType">
<ns2:rant>iana-en:222</ns2:rant>
<ns2:rar>iana-en:223</ns2:rar>
<ns2:dgName>DEST_GRP_SSP2_1</ns2:dgName>
</resultObj>
</ns3:spppGetResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="get_pub_id" title="Get Public Identity">
<t>SSP2 obtains the last provisioned record associated with a given TN.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppGetRequest>
<!--1 or more repetitions:-->
<objKey xsi:type="urn:PubIdKeyType">
<rant>iana-en:222</rant>
<number>
<urn1:value>+12025556666</urn1:value>
<urn1:type>TN</urn1:type>
</number>
</objKey>
</urn:spppGetRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<S:Body>
<ns3:spppGetResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<overallResult>
<code>1000</code>
<msg>success</msg>
</overallResult>
<resultObj xsi:type="ns2:TNType">
<ns2:rant>iana-en:222</ns2:rant>
<ns2:rar>iana-en:223</ns2:rar>
<ns2:dgName>DEST_GRP_SSP2_1</ns2:dgName>
<ns2:tn>+12025556666</ns2:tn>
<ns2:corInfo>
<ns2:corClaim>true</ns2:corClaim>
<ns2:cor>true</ns2:cor>
<ns2:corDate>2010-05-30T09:30:10Z</ns2:corDate>
</ns2:corInfo>
</resultObj>
</ns3:spppGetResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="get_sed_grp_request" title="Get SED Group Request">
<t>SSP2 obtains the last provisioned record for the SED group SED_GRP_SSP2_1.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppGetRequest>
<!--1 or more repetitions:-->
<objKey xsi:type="urn:ObjKeyType">
<rant>iana-en:222</rant>
<name>SED_GRP_SSP2_1</name>
<type>SedGrp</type>
</objKey>
</urn:spppGetRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<S:Body>
<ns3:spppGetResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<overallResult>
<code>1000</code>
<msg>success</msg>
</overallResult>
<resultObj xsi:type="ns2:SedGrpType">
<ns2:rant>iana-en:222</ns2:rant>
<ns2:rar>iana-en:223</ns2:rar>
<ns2:sedGrpName>SED_GRP_SSP2_1</ns2:sedGrpName>
<ns2:sedRecRef>
<ns2:sedKey xsi:type="ns3:ObjKeyType">
<rant>iana-en:222</rant>
<name>SED_SSP2_SBE2</name>
<type>SedRec</type>
</ns2:sedKey>
<ns2:priority>100</ns2:priority>
</ns2:sedRecRef>
<ns2:sedRecRef>
<ns2:sedKey xsi:type="ns3:ObjKeyType">
<rant>iana-en:222</rant>
<name>SED_SSP2_SBE4</name>
<type>SedRec</type>
</ns2:sedKey>
<ns2:priority>101</ns2:priority>
</ns2:sedRecRef>
<ns2:dgName>DEST_GRP_SSP2_1</ns2:dgName>
<ns2:isInSvc>true</ns2:isInSvc>
<ns2:priority>10</ns2:priority>
</resultObj>
</ns3:spppGetResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="get_sed_grp_offers_rqst" title="Get SED Group Offers Request">
<t>SSP2 fetches the last provisioned SED group offer to the <peeringOrg> SSP1.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1">
<soapenv:Header/>
<soapenv:Body>
<urn:getSedGrpOffersRequest>
<offeredTo>iana-en:111</offeredTo>
</urn:getSedGrpOffersRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry processes the request successfully and returns a favorable response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<S:Body>
<ns3:spppGetResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<overallResult>
<code>1000</code>
<msg>success</msg>
</overallResult>
<resultObj xsi:type="ns2:SedGrpOfferType">
<ns2:rant>iana-en:222</ns2:rant>
<ns2:rar>iana-en:223</ns2:rar>
<ns2:sedGrpOfferKey
xsi:type="ns3:SedGrpOfferKeyType">
<sedGrpKey>
<rant>iana-en:222</rant>
<name>SED_GRP_SSP2_1</name>
<type>SedGrp</type>
</sedGrpKey>
<offeredTo>iana-en:111</offeredTo>
</ns2:sedGrpOfferKey>
<ns2:status>offered</ns2:status>
<ns2:offerDateTime>
2006-05-04T18:13:51.0Z
</ns2:offerDateTime>
</resultObj>
</ns3:spppGetResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="get_egress_rte" title="Get Egress Route">
<t>SSP1 wants to verify the last provisioned record for the egress route called EGR_RTE_01.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppGetRequest>
<!--1 or more repetitions:-->
<objKey xsi:type="urn:ObjKeyType">
<rant>iana-en:111</rant>
<name>EGR_RTE_01</name>
<type>EgrRte</type>
</objKey>
</urn:spppGetRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<S:Body>
<ns3:spppGetResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<overallResult>
<code>1000</code>
<msg>success</msg>
</overallResult>
<resultObj xsi:type="ns2:EgrRteType">
<ns2:rant>iana-en:222</ns2:rant>
<ns2:rar>iana-en:223</ns2:rar>
<ns2:egrRteName>EGR_RTE_01</ns2:egrRteName>
<ns2:pref>50</ns2:pref>
<ns2:regxRewriteRule>
<ns2:ere>^(.*)$</ns2:ere>
<ns2:repl>sip:\1@sbe1.ssp1.example.com</ns2:repl>
</ns2:regxRewriteRule>
<ns2:ingrSedGrp xsi:type="ns3:ObjKeyType">
<rant>iana-en:222</rant>
<name>SED_GRP_SSP2_1</name>
<type>SedRec</type>
</ns2:ingrSedGrp>
</resultObj>
</ns3:spppGetResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="del_dest_grp" title="Delete Destination Group">
<t>SSP2 initiates a request to delete the destination group DEST_GRP_SSP2_1.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppDelRequest>
<!--1 or more repetitions:-->
<objKey xsi:type="urn:ObjKeyType">
<rant>iana-en:222</rant>
<name>DEST_GRP_SSP2_1</name>
<type>DestGrp</type>
</objKey>
</urn:spppDelRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppDelResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<serverTransId>tx_12354</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppDelResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="del_pub_id" title="Delete Public Identity">
<t>SSP2 chooses to de-activate the TN and remove it from the registry.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppDelRequest>
<!--1 or more repetitions:-->
<objKey xsi:type="urn:PubIdKeyType">
<rant>iana-en:222</rant>
<dgName>DEST_GRP_SSP2_1</dgName>
<number>
<urn1:value>+12025556666</urn1:value>
<urn1:type>TN</urn1:type>
</number>
</objKey>
</urn:spppDelRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppDelResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<serverTransId>tx_12354</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppDelResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="del_sed_grp_rqst" title="Delete SED Group Request">
<t>SSP2 removes the SED group called SED_GRP_SSP2_1.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppDelRequest>
<!--1 or more repetitions:-->
<objKey xsi:type="urn:ObjKeyType">
<rant>iana-en:222</rant>
<name>SED_GRP_SSP2_1</name>
<type>SedGrp</type>
</objKey>
</urn:spppDelRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppDelResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<serverTransId>tx_12354</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppDelResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="del_sed_grp_offers_rqst" title="Delete SED Group Offers Request">
<t>SSP2 no longer wants to share SED group SED_GRP_SSP2_1 with SSP1.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppDelRequest>
<!--1 or more repetitions:-->
<objKey xsi:type="urn:SedGrpOfferKeyType">
<sedGrpKey>
<rant>iana-en:222</rant>
<name>SED_GRP_SSP2_1</name>
<type>SedGrp</type>
</sedGrpKey>
<offeredTo>iana-en:111</offeredTo>
</objKey>
</urn:spppDelRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response. Restoring this resource sharing will require a new SED group offer from SSP2 to SSP1 followed by a successful SED group accept request from SSP1.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppDelResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<serverTransId>tx_12354</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppDelResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="del_egress_rte" title="Delete Egress Route">
<t>SSP1 decides to remove the egress route with the label EGR_RTE_01.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppDelRequest>
<!--1 or more repetitions:-->
<objKey xsi:type="urn:ObjKeyType">
<rant>iana-en:111</rant>
<name>EGR_RTE_01</name>
<type>EgrRte</type>
</objKey>
</urn:spppDelRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppDelResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<serverTransId>tx_12354</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppDelResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
<section anchor="batch_req" title="Batch Request">
<t>Following is an example of how some of the operations mentioned in previous sections
MAY be performed by an SPPF client as a batch in one single SPP Protocol over SOAP request.</t>
<t>In the sample request below SSP1 wants to accept a SED Group Offer from SSP3, add
a Destination Group, add a NAPTR SED Record, add a SED Group, add a SED Group Offer,
delete a previously provisioned TN type Public Identifier, delete a previously provisioned SED Group, and reject a SED Group Offer from SSP4.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:ietf:params:xml:ns:sppf:soap:1"
xmlns:urn1="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header/>
<soapenv:Body>
<urn:spppBatchRequest>
<clientTransId>txn_1467</clientTransId>
<minorVer>1</minorVer>
<acceptSedGrpOffer>
<sedGrpKey>
<rant>iana-en:225</rant>
<name>SED_SSP3_SBE1_Offered</name>
<type>SedGrp</type>
</sedGrpKey>
<offeredTo>iana-en:222</offeredTo>
</acceptSedGrpOffer>
<addObj xsi:type="urn1:DestGrpType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:dgName>DEST_GRP_SSP2_1</urn1:dgName>
</addObj>
<addObj xsi:type="urn1:NAPTRType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:sedName>SED_SSP2_SBE2</urn1:sedName>
<urn1:order>10</urn1:order>
<urn1:flags>u</urn1:flags>
<urn1:svcs>E2U+sip</urn1:svcs>
<urn1:regx>
<urn1:ere>^(.*)$</urn1:ere>
<urn1:repl>sip:\1@sbe2.ssp2.example.com</urn1:repl>
</urn1:regx>
</addObj>
<addObj xsi:type="urn1:SedGrpType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:sedGrpName>SED_GRP_SSP2_1</urn1:sedGrpName>
<urn1:sedRecRef>
<urn1:sedKey xsi:type="urn:ObjKeyType">
<rant>iana-en:222</rant>
<name>SED_SSP2_SBE2</name>
<type>SedRec</type>
</urn1:sedKey>
<urn1:priority>100</urn1:priority>
</urn1:sedRecRef>
<urn1:dgName>DEST_GRP_SSP2_1</urn1:dgName>
<urn1:isInSvc>true</urn1:isInSvc>
<urn1:priority>10</urn1:priority>
</addObj>
<addObj xsi:type="urn1:SedGrpOfferType">
<urn1:rant>iana-en:222</urn1:rant>
<urn1:rar>iana-en:223</urn1:rar>
<urn1:sedGrpOfferKey xsi:type="urn:SedGrpOfferKeyType">
<sedGrpKey xsi:type="urn:ObjKeyType">
<rant>iana-en:222</rant>
<name>SED_GRP_SSP2_1</name>
<type>SedGrp</type>
</sedGrpKey>
<offeredTo>iana-en:111</offeredTo>
</urn1:sedGrpOfferKey>
<urn1:status>offered</urn1:status>
<urn1:offerDateTime>
2006-05-04T18:13:51.0Z
</urn1:offerDateTime>
</addObj>
<delObj xsi:type="urn:PubIdKeyType">
<rant>iana-en:222</rant>
<dgxDEST_GRP_SSP2_Previous</dgName>
<number>
<urn1:value>+12025556666</urn1:value>
<urn1:type>TN</urn1:type>
</number>
</delObj>
<delObj xsi:type="urn:ObjKeyType">
<rant>iana-en:222</rant>
<name>SED_GRP_SSP2_Previous</name>
<type>SedGrp</type>
</delObj>
<rejectSedGrpOffer>
<sedGrpKey>
<rant>iana-en:226</rant>
<name>SED_SSP4_SBE1_Offered</name>
<type>SedGrp</type>
</sedGrpKey>
<offeredTo>iana-en:222</offeredTo>
</rejectSedGrpOffer>
</urn:spppBatchRequest>
</soapenv:Body>
</soapenv:Envelope>
]]>
</artwork>
</figure>
</t>
<t>Registry completes the request successfully and returns a favorable response.</t>
<t>
<figure title="">
<artwork align="left">
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope
xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns3:spppBatchResponse
xmlns:ns2="urn:ietf:params:xml:ns:sppf:base:1"
xmlns:ns3="urn:ietf:params:xml:ns:sppf:soap:1">
<serverTransId>tx_12354</serverTransId>
<overallResult>
<code>1000</code>
<msg>Request Succeeded.</msg>
</overallResult>
</ns3:spppBatchResponse>
</S:Body>
</S:Envelope>
]]>
</artwork>
</figure>
</t>
</section>
</section>
<section anchor="SecurityConsiderations" title="Security Considerations">
<t>SPP Protocol over SOAP is used to query and update session peering data and addresses, so
the ability to access this protocol should be limited to users and
systems that are authorized to query and update this data. Because this
data is sent in both directions, it may not be sufficient for just the client
or user to be authenticated with the server. The identity of the server
should also be authenticated by the client, which is often accomplished using
the TLS certificate exchange and validation described in <xref target="RFC2818"/>.
SPP Protocol over SOAP messages may include sensitive
information, routing data, lists of resolvable addresses, etc. So when used
in a production setting and across non-secure networks, SPP Protocol over SOAP
should only be used over communications channels that provide strong
encryption for data privacy.</t>
<section anchor="IntegrityPrivacyAuthentication" title="Integrity, Privacy, and Authentication">
<t>The SPP Protocol over SOAP binding relies on an underlying secure transport for
integrity and privacy. Such transports are expected to include TLS/HTTPS.
In addition to the application level authentication imposed by an SPPF
server, there are a number of options for authentication within the transport
layer and the messaging envelope. These include TLS client certificates,
HTTP Digest Access Authentication, and digital signatures within SOAP headers. </t>
<t>At a minimum, all conforming SPP Protocol over SOAP implementations MUST
support HTTPS.</t>
</section>
<section anchor="Vulnerabilities" title="Vulnerabilities">
<t>The above protocols may have various vulnerabilities, and these may
be inherited by SPP Protocol over SOAP. SPP Protocol over SOAP itself may have vulnerabilities
because an authorization model is not explicitly specified in the current
specification.
</t>
<t>
Sections 5 and 10.1 describe requirements for HTTPS support using TLS. Non-anonymous TLS servers can optionally request a certificate from a TLS client;
that option is not a requirement for this protocol. This presents a denial of service risk in which unauthenticated clients can consume server CPU resources by creating TLS sessions.
The risk is increased if the server supports client-initiated renegotiation. This risk can be mitigated by disabling client-initiated renegotiation on the server and by ensuring that other
means (such as firewall access control lists) are used to restrict unauthenticated client access to servers.
</t>
<t>In conjunction with the above, it is important that SPP Protocol over SOAP implementations implement an authorization
model that considers the source of each query or update request and
determines whether it is reasonable to authorize that source to perform that
specific query or update. </t>
</section>
<section anchor="DeploymentEnvironmentSpecifics" title="Deployment Environment Specifics">
<t>Some deployments of SPP Protocol over SOAP could choose to use transports
without encryption. This presents vulnerabilities but could be
selected for deployments involving closed networks or debugging
scenarios. However, the vulnerabilities of such a deployment could be a
lack of integrity and privacy of the data transported in
this type of deployment.</t>
</section>
</section>
<section anchor="IANAConsiderations" title="IANA Considerations">
<t>This document uses URNs to describe XML namespaces and XML schemas
conforming to a registry mechanism described in <xref target="RFC3688"/>.
</t>
<t>URN assignments requested are: urn:ietf:params:xml:ns:sppf:soap:1</t>
</section>
<section anchor="Acknowledgements" title="Acknowledgements">
<t>
This document is a result of various discussions held by the DRINKS design team,
with contributions from the following individuals, in alphabetical order:
Alexander Mayrhofer, David Schwartz, Deborah A Guyton, Jean-Francois Mule
Kenneth Cartwright, Lisa Dusseault, Manjul Maharishi, Mickael Marrache, Otmar Lendl,
Peter Saint-Andre, Richard Shockey, Samuel Melloul, Scott Hollenbeck, Sumanth Channabasappa, Syed Ali, and Vikas Bhatia .
</t>
</section>
</middle>
<back>
<references title="Normative References">
&rfc2119;
&rfc3688;
&rfc5246;
&rfc2617;
&rfc2616;
<reference anchor="I-D.draft-ietf-drinks-spp-framework">
<front>
<title>Session Peering Provisioning Framework </title>
<author initials="K.C." surname="Cartwright"/>
<author initials="V.B." surname="Bhatia"/>
<author initials="S.A." surname="Ali"/>
<author initials="D.S." surname="Schwartz"/>
<date month="July" year="2012" />
</front>
<seriesInfo name="Internet-Draft" value="draft-ietf-drinks-spp-framework-02"/>
<format target="http://tools.ietf.org/html/draft-ietf-drinks-spp-framework-02" type="HTML" />
</reference>
<reference anchor="SOAPREF">
<front>
<title>SOAP Version 1.2 Part 1: Messaging Framework</title>
<author initials="M." surname="Gudgin"/>
<author initials="M." surname="Hadley"/>
<author initials="J." surname="Moreau"/>
<author initials="H." surname="Nielsen"/>
<date month="June" year="2002" />
</front>
<seriesInfo name="W3C Recommendation" value="REC-SOAP12-part1-20030624"/>
<format target="http://www.w3.org/TR/soap12-part1/" type="HTML" />
</reference>
</references>
<references title="Informative References">
&rfc2818; &rfc5321;
<reference anchor="WSDLREF">
<front>
<title>Web Services Description Language (WSDL) 1.1</title>
<author initials="E." surname="Christensen"/>
<author initials="F." surname="Curbera"/>
<author initials="G." surname="Meredith"/>
<author initials="S." surname="Weerawarana"/>
<date month="March" year="2001" />
</front>
<seriesInfo name="W3C Note" value="NOTE-wsdl-20010315"/>
<format target="http://www.w3.org/TR/2001/NOTE-wsdl-20010315" type="HTML" />
</reference>
<reference anchor='W3C.REC-xml-20081126' target='http://www.w3.org/TR/2008/REC-xml-20081126'>
<front>
<title>Extensible Markup Language (XML) 1.0 (Fifth Edition)</title>
<author initials='C.' surname='Sperberg-McQueen' fullname='C. M. Sperberg-McQueen'>
<organization />
</author>
<author initials='F.' surname='Yergeau' fullname='François Yergeau'>
<organization />
</author>
<author initials='T.' surname='Bray' fullname='Tim Bray'>
<organization />
</author>
<author initials='E.' surname='Maler' fullname='Eve Maler'>
<organization />
</author>
<author initials='J.' surname='Paoli' fullname='Jean Paoli'>
<organization />
</author>
<date month='November' day='26' year='2008' />
</front>
<seriesInfo name='World Wide Web Consortium Recommendation' value='REC-xml-20081126' />
<format type='HTML' target='http://www.w3.org/TR/2008/REC-xml-20081126' />
</reference>
</references>
</back>
</rfc>
| PAFTECH AB 2003-2026 | 2026-04-24 14:45:58 |