XML MTAS 68p09278a35

PoC XML Subscriber Provisioning Guide

68P09278A35-B MAR 2007© 2007 Motorola, Inc. All Rights Reserved

Notice

While reasonable efforts have been made to assure the accuracy of this document, Motorola,Inc. assumes no liability resulting from any inaccuracies or omissions in this document, orfrom use of the information obtained herein. The information in this document has beencarefully checked and is believed to be entirely reliable. However, no responsibility is as-sumed for inaccuracies or omissions. Motorola, Inc. reserves the right to make changes toany products described herein and reserves the right to revise this document and to makechanges from time to time in content hereof with no obligation to notify any person of revi-sions or changes. Motorola, Inc. does not assume any liability arising out of the applicationor use of any product, software, or circuit described herein; neither does it convey licenseunder its patent rights or the rights of others.

It is possible that this publication may contain references to, or information about Motorolaproducts (machines and programs), programming, or services that are not announced inyour country. Such references or information must not be construed to mean that Motorolaintends to announce such Motorola products, programming, or services in your country.

Copyrights

This instruction manual, and the Motorola products described in this instruction manual maybe, include or describe copyrighted Motorola material, such as computer programs storedin semiconductor memories or other media. Laws in the United States and other countriespreserve for Motorola and its licensors certain exclusive rights for copyrighted material, in-cluding the exclusive right to copy, reproduce in any form, distribute and make derivativeworks of the copyrighted material. Accordingly, any copyrighted material of Motorola and itslicensors contained herein or in the Motorola products described in this instruction manualmay not be copied, reproduced, distributed, merged or modified in any manner without theexpress written permission of Motorola. Furthermore, the purchase of Motorola productsshall not be deemed to grant either directly or by implication, estoppel, or otherwise, anylicense under the copyrights, patents or patent applications of Motorola, as arises by oper-ation of law in the sale of a product.

Usage and Disclosure Restrictions

License Agreements

The software described in this document is the property of Motorola, Inc and its licensors.It is furnished by express license agreement only and may be used only in accordance withthe terms of such an agreement.

Copyrighted Materials

Software and documentation are copyrighted materials. Making unauthorized copies is pro-hibited by law. No part of the software or documentation may be reproduced, transmitted,transcribed, stored in a retrieval system, or translated into any language or computer lan-guage, in any form or by any means, without prior written permission of Motorola, Inc.

High Risk Materials

Components, units, or third-party products used in the product described herein are NOTfault-tolerant and are NOT designed, manufactured, or intended for use as on-line controlequipment in the following hazardous environments requiring fail-safe controls: the opera-tion of Nuclear Facilities, Aircraft Navigation or Aircraft Communication Systems, Air TrafficControl, Life Support, or Weapons Systems (High Risk Activities). Motorola and its sup-plier(s) specifically disclaim any expressed or implied warranty of fitness for such High RiskActivities.

Trademarks

Motorola and the Stylized M Logo are registered in the US Patent & Trademark Office. Allother product or service names are the property of their respective owners.

MAR 2007

Tableof

Contents

Contents■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

■

■

PoC XML Subscriber Provisioning GuideRevision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Version information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2General information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Cross references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Text conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Contacting Motorola . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Questions and comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524-hour support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Security Advice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Warnings and cautions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Failure to comply with warnings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Warnings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Cautions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

General Safety . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Ground the equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Do not operate in an explosive atmosphere . . . . . . . . . . . . . . . . . . . . . . . . . 9Keep away from live circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Do not service or adjust alone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Use caution when exposing or handling the CRT. . . . . . . . . . . . . . . . . . . . . . . 10Do not substitute parts or modify equipment . . . . . . . . . . . . . . . . . . . . . . . . 10Potentially hazardous procedure warnings. . . . . . . . . . . . . . . . . . . . . . . . . . 10

Devices sensitive to static . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Special handling techniques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Caring for the environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Disposal of Motorola Networks equipment in EU countries . . . . . . . . . . . . . . . . . 12Disposal of Motorola Networks equipment in non-EU countries . . . . . . . . . . . . . . . 12

Motorola document set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Ordering documents and CD-ROMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Document banner definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Third Party Computer Software and Trademarks . . . . . . . . . . . . . . . . . . . . . . . . 14Computer Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 1: Conguring MTASPreconfiguring the MTAS process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Reconfiguring the timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3Login/Logout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4

68P09278A35-B i

MAR 2007

Contents

Chapter 2: XML interface transaction formatTransaction format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

Chapter 3: Maintaining subscribersAdding a subscriber using XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3Results for a new subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3

Deleting a subscriber using XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6Delete subscribers using transaction code D. . . . . . . . . . . . . . . . . . . . . . . . . 3-6Delete subscribers using transaction code P . . . . . . . . . . . . . . . . . . . . . . . . . 3-8

Modifying a subscriber MIN or MDN using XML. . . . . . . . . . . . . . . . . . . . . . . . . 3-10Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11

Query a subscriber status using XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16

Change features using transaction code C . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17

Chapter 4: Enterprise and admin provisioningAdding an enterprise using XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2

Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3

Deleting an enterprise using XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5

Modifying an enterprise using XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9

Querying an enterprise using XML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11

Adding an enterprise admin using XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13

Deleting an enterprise admin using XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14

Modifying an enterprise admin using XML. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16

Modifying or resetting an admin password using XML. . . . . . . . . . . . . . . . . . . . . . 4-17Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17

ii 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Contents

Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17

Querying an enterprise admin name using XML . . . . . . . . . . . . . . . . . . . . . . . . . 4-18Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19

Chapter 5: OMA subscriber provisioningOMA subscriber provisioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Adding an OMA subscriber. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4

Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4

Suspending an OMA subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5

Querying an OMA subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6

Replacing an OMA subscriber MIN/MDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7

Purging an OMA subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9Requirement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9

Chapter 6: Result format for XMLResult format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Message examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3

Successful . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3Unsuccessful . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3

Return codes and messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4Add transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7Delete Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9Change MIN/MDN transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10Query transactions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11

Successful query examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12Codes and messages for syntax errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13

Chapter 7: Enhanced result format for XMLProvisioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Result format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3Message examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Successful . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4Unsuccessful . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Enhanced error codes for query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18Enhanced error codes when adding subscribers . . . . . . . . . . . . . . . . . . . . . . . . . 7-19Enhanced error codes when deleting subscribers . . . . . . . . . . . . . . . . . . . . . . . . 7-20Enhanced error codes when modifying subscribers . . . . . . . . . . . . . . . . . . . . . . . 7-22Invalid MIN and MDN validation for any operation/action . . . . . . . . . . . . . . . . . . . . 7-24Basic communication error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25

68P09278A35-B iii

MAR 2007

Contents

Chapter 8: Acronyms and abbreviations

Appendix A: Customized transaction format

Appendix B: Enabling MTAS versions

iv 68P09278A35-B

MAR 2007

Listof

Figures

List of Figures■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

■

■

Figure 1-1: Viewing MTAS process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Figure 1-2: MTAS_Adapter timer configuration . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

68P09278A35-B v

MAR 2007

List of Figures

vi 68P09278A35-B

MAR 2007

Listof

Tables

List of Tables■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

■

■

Table 2-1: Transaction format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2Table 3-1: Adding a subscriber results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3Table 3-2: Adding subscriber XML transaction results . . . . . . . . . . . . . . . . . . . . . . 3-4Table 3-3: Transaction Code D Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7Table 3-4: Other deletion scenarios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8Table 3-5: Transaction Code P results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9Table 3-6: Modification conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11Table 3-7: Query a subscriber results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16Table 5-1: OMA subscriber format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Table 6-1: XML result format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Table 6-2: Return codes and messages – Not enhanced . . . . . . . . . . . . . . . . . . . . . 6-4Table 6-3: Code/Messages for add transactions . . . . . . . . . . . . . . . . . . . . . . . . . 6-7Table 6-4: Code/Messages for delete transactions . . . . . . . . . . . . . . . . . . . . . . . . 6-9Table 6-5: Code/Messages for change MIN/MDN transactions . . . . . . . . . . . . . . . . . . 6-10Table 6-6: Code/Messages for Query transactions . . . . . . . . . . . . . . . . . . . . . . . . 6-11Table 6-7: Expected code/messages for syntax errors . . . . . . . . . . . . . . . . . . . . . . 6-13Table 7-1: XML result format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3Table 7-2: Return codes and messages – Enhanced . . . . . . . . . . . . . . . . . . . . . . . 7-4Table 7-3: Enhanced error codes for query . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18Table 7-4: Enhanced error codes for add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19Table 7-5: Enhanced error codes for delete . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20Table 7-6: Enhanced error codes for modify . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22Table 7-7: Invalid MIN and MDN validation codes . . . . . . . . . . . . . . . . . . . . . . . . 7-24Table 7-8: Enhanced error codes for basic communication. . . . . . . . . . . . . . . . . . . . 7-25Table A-1: Custom transaction format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

68P09278A35-B vii

MAR 2007

List of Tables

viii 68P09278A35-B

MAR 2007

AboutThisManual

PoC XML Subscriber Provisioning Guide■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

■

■

What is covered in this manual?

This document is an interface specification between the provisioning server process running onthe Push–To–Talk over Cellular (PoC) platform and provisioning system of a carrier.

This manual documents the existing initial subscriber provisioning as well as subscriber accountmanagement available from the EMS (Element Management System) GUI. This manual doesnot address interfaces for subscriber maintenance of their account, for example contact listmanagement or group management.

The carrier may use this document to develop a machine–to–machine interface to add, modify,and delete subscribers from the PoC database.

Two interfaces are defined:

• Existing EMS system

• XML interface

• Information in this document references the terms MIN and MDN. Forusage of this documentation in GPRS networks, the term IMSI must besubstituted for MIN and the term MSISDN must be substituted for MDN.

• Error messages shown in this manual are legacy error messages, unless itstates that enhanced messaging is shown.

The EMS Server on the PoC Control Switch chassis provides a web–based interface to manuallyadd, delete, and modify PoC subscribers. The interface can be reached by logging into the EMSserver associated with the primary Active Directory chassis in the PoC platform.

• Reference the Provisioning Guide and Operations Guide for information on logging intothe EMS interface.

• Reference the PoC Options and Subscribers chapter of the Provisioning Guide for a morecomplete explanation on how to use the EMS Interface.

68P09278A35-B 1

MAR 2007

Revision history

Revision history■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The following shows the status of this document since it was first released.

Version information

Documentissue Date of issue Remarks

A FEB 2007 First issue

B MAR 2007 Updated

2 68P09278A35-B

MAR 2007

General information

General information■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Motorola disclaims all liability whatsoever, implied or express, for any risk of damage,loss or reduction in system performance arising directly or indirectly out of thefailure of the customer, or anyone acting on the customers behalf, to abide by theinstructions, system parameters or recommendations made in this document.

Purpose

Motorola cellular communications documents are intended to instruct and assist personnel inthe operation, installation, and maintenance of the Motorola cellular infrastructure equipmentand ancillary devices. It is recommended that all personnel engaged in such activities beproperly trained by Motorola.

Failure to comply with Motorola’s operation, installation, and maintenance instructionsmay, in exceptional circumstances, lead to serious injury or death.

These documents are not intended to replace the system and equipment training offered byMotorola, although they can be used to supplement and enhance the knowledge gained throughsuch training.

Cross references

Throughout this document, references are made to external publications, chapter numbers,and section names. The references to external publications are shown in italics. Chapter andsection name cross references are emphasized in blue text in electronic versions. These areactive links to the references.

This document is divided into uniquely identified and numbered chapters that, in turn, aredivided into sections. Sections are not numbered, but are individually named at the top of eachpage, and are listed in the table of contents.

Text conventions

The following conventions are used in the Motorola cellular infrastructure documents torepresent keyboard input text, screen output text, and special key sequences.

68P09278A35-B 3

MAR 2007

General information

Input

Characters typed in at the keyboard are shown like this.

Output

Messages, prompts, file listings, directories, utilities, and environmental

variables that appear on the screen are shown like this.

Special key sequences

Special key sequences are represented as follows:

CTRL-c Press the Control and c keys at the same time.

ALT-f Press the Alt and f keys at the same time.

¦ Press the pipe symbol key.

CR or RETURN Press the Return key.

4 68P09278A35-B

MAR 2007

Contacting Motorola

Contacting Motorola■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Motorola appreciates feedback from the users of our documents.

Errors

To report a documentation error, call the CNRC (Customer Network Resolution Center) andprovide the following information to enable CNRC to open an SR (Service Request):

• The document type

• The document title, part number, and revision character

• The page numbers with the error

• A detailed description of the error and if possible the proposed solution

Questions and comments

Send questions and comments regarding user documentation to the email address:[email protected]

24-hour support

If you have problems regarding the operation of your equipment, please contact the CustomerNetwork Resolution Center (CNRC) for immediate assistance. The 24-hour telephone numbersare listed at https://mynetworksupport.motorola.com. Select Customer Network ResolutionCenter contact information. For additional CNRC contact information, contact your Motorolaaccount representative.

68P09278A35-B 5

MAR 2007

Security Advice

Security Advice■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Motorola systems and equipment provide configurable security parameters that the operatorsets based on their particular operating environment. Motorola recommends setting andusing these parameters following industry recognized security practices. Security aspectsto be considered are protecting the confidentiality, integrity, and availability of informationand assets. Assets include the ability to communicate, information about the nature of thecommunications, and information about the parties involved.

In certain instances Motorola makes specific recommendations regarding security practices.However, the implementation of these recommendations and final responsibility for the securityof the system lies with the operator of the system.

Please contact the Customer Network Resolution Center (CNRC) for assistance. The 24-hourtelephone numbers are listed at https://mynetworksupport.motorola.com. Select CustomerNetwork Resolution Center contact information, from the menu located to the left of theLogin box. Alternatively if you do not have access to CNRC or the internet, contact the LocalMotorola Office.

6 68P09278A35-B

MAR 2007

Warnings and cautions

Warnings and cautions■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The following describes how warnings and cautions are used in this document and in alldocuments of this Motorola document set.

Failure to comply with warnings

Observe all warnings during all phases of operation, installation, and maintenance of theequipment described in the Motorola documents. Failure to comply with these warnings,or with specific warnings elsewhere in the Motorola documents, or on the equipmentitself, violates safety standards of design, manufacture, and intended use of theequipment. Motorola assumes no liability for the customer’s failure to comply withthese requirements.

Warnings

A definition and example follow in Definition of Warning on page 7 and Example and formaton page 7.

Denition of Warning

A warning is used to alert the reader to possible hazards that could cause loss of life, physicalinjury, or ill health. This includes hazards introduced during maintenance, for example, the useof adhesives and solvents, as well as those inherent in the equipment.

Example and format

Do not look directly into ber optic cables or data in/out connectors. Laser radiationcan come from either the data in/out connectors or unterminated ber optic cablesconnected to data in/out connectors.

Cautions

A definition and example follow below:

68P09278A35-B 7

MAR 2007

Warnings and cautions

Denition of Caution

A caution means that there is a possibility of damage to systems, software, or individual items ofequipment within a system. However, this presents no danger to personnel.

Example and format

Do not use test equipment that is beyond its due calibration date; arrange forcalibration to be carried out.

Notes

A definition and example follow below:

Denition of Note

A note means that there is a possibility of an undesirable situation or provides additionalinformation to help the reader understand a topic or concept.

Example and format

The UDR version number is configured at installation time by Motorola personneland is not accessible by the customer.

8 68P09278A35-B

MAR 2007

General Safety

General Safety■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Ground the equipment

To minimize shock hazard, the equipment chassis and enclosure must be connected to anelectrical ground. If the equipment is supplied with a three-conductor ac power cable, thepower cable must be either plugged into an approved three-contact electrical outlet or usedwith a three-contact to two-contact adapter. The three-contact to two-contact adapter musthave the grounding wire (green) firmly connected to an electrical ground (safety ground) atthe power outlet. The power jack and mating plug of the power cable must meet InternationalElectrotechnical Commission (IEC) safety standards.

Refer to Grounding Guideline for Cellular Radio Installations – 68P81150E62.

Do not operate in an explosive atmosphere

Do not operate the equipment in the presence of flammable gases or fumes. Operation of anyelectrical equipment in such an environment constitutes a definite safety hazard.

Keep away from live circuits

Operating personnel must:

• not remove equipment covers. Only Factory Authorized Service Personnel or otherqualified maintenance personnel may remove equipment covers for internal subassembly,or component replacement, or any internal adjustment.

• not replace components with power cable connected. Under certain conditions, dangerousvoltages may exist even with the power cable removed.

• always disconnect power and discharge circuits before touching them.

Do not service or adjust alone

Do not attempt internal service or adjustment, unless another person, capable of rendering firstaid and resuscitation, is present.

68P09278A35-B 9

MAR 2007

General Safety

Use caution when exposing or handling the CRT

Breakage of the Cathode–Ray Tube (CRT) causes a high-velocity scattering of glass fragments(implosion). To prevent CRT implosion, avoid rough handling or jarring of the equipment. Onlyqualified maintenance personnel wearing approved safety mask and gloves should handle theCRT.

Do not substitute parts or modify equipment

Because of the danger of introducing additional hazards, do not install substitute parts orperform any unauthorized modification of equipment. Contact Motorola Warranty and Repairfor service and repair to ensure that safety features are maintained.

Potentially hazardous procedure warnings

Warnings, such as the example below, precede potentially hazardous procedures throughoutthis document. Instructions contained in the warnings must be followed. Employ all other safetyprecautions necessary for the operation of the equipment in the operating environment.

Potentially hazardous voltages, capable of causing death, are present in thisequipment. Use extreme caution when handling, testing, and adjusting.

10 68P09278A35-B

MAR 2007

Devices sensitive to static

Devices sensitive to static■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Certain metal oxide semiconductor (MOS) devices embody in their design a thin layer ofinsulation that is susceptible to damage from electrostatic charge. Such a charge applied to theleads of the device could cause irreparable damage.

These charges can be built up on nylon overalls, by friction, by pushing the hands into highinsulation packing material or by use of ungrounded soldering irons.

MOS devices are normally dispatched from the manufacturers with the leads short-circuitedtogether, for example, by metal foil eyelets, wire strapping, or by inserting the leads intoconductive plastic foam. Provided the leads are short-circuited it is safe to handle the device.

Special handling techniques

In the event of one of these devices having to be replaced, observe the following precautionswhen handling the replacement:

• Always wear a ground strap which must be connected to the electrostatic point on theequipment.

• Leave the short circuit on the leads until the last moment. It may be necessary to replacethe conductive foam by a piece of wire to enable the device to be fitted.

• Do not wear outer clothing made of nylon or similar man made material. A cotton overallis preferable.

• If possible work on an grounded metal surface or anti-static mat. Wipe insulated plasticwork surfaces with an anti-static cloth before starting the operation.

• All metal tools should be used and when not in use they should be placed on an groundedsurface.

• Take care when removing components connected to electrostatic sensitive devices. Thesecomponents may be providing protection to the device.

When mounted onto printed circuit boards (PCBs), MOS devices are normally less susceptible toelectrostatic damage. However PCBs should be handled with care, preferably by their edgesand not by their tracks and pins, they should be transferred directly from their packing to theequipment (or the other way around) and never left exposed on the workbench.

68P09278A35-B 11

MAR 2007

Caring for the environment

Caring for the environment■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The following information is provided to enable regulatory compliance with the European Union(EU) Directive 2002/96/EC Waste Electrical and Electronic Equipment (WEEE) when usingMotorola Networks equipment in EU countries.

Disposal of Motorola Networks equipment in EU countries

Please do not dispose of Motorola Networks equipment in landfill sites.

In the EU, Motorola Networks in conjunction with a recycling partner will ensure that equipmentis collected and recycled according to the requirements of EU environmental law.

Please contact the Customer Network Resolution Center (CNRC) for assistance. The 24 hourtelephone numbers are listed at https://mynetworksupport.motorola.com/. Select CustomerNetwork Resolution Center contact information. Alternatively if you do not have accessto CNRC or the internet, contact the Local Motorola Office.

Disposal of Motorola Networks equipment in non-EU countries

In non-EU countries, dispose of Motorola Networks equipment in accordance with nationaland regional regulations.

12 68P09278A35-B

MAR 2007

Motorola document set

Motorola document set■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The Motorola document sets provide the information needed to operate, install, and maintainthe Motorola equipment.

Ordering documents and CD-ROMs

With internet access available, to view, download, or order documents (original or revised), visitthe Motorola Lifecycles Customer web page at https://mynetworksupport.motorola.com/, orcontact your Motorola account representative.

Without internet access available, order hard copy documents or CD-ROMs with your MotorolaLocal Office or Representative.

If Motorola changes the content of a document after the original printing date, Motorolapublishes a new version with the same part number but a different revision character.

Document banner denitions

A banner (oversized text on the bottom of the page, for example, PRELIMINARY — UNDERDEVELOPMENT) indicates that some information contained in the document is not yet approvedfor general customer use.

68P09278A35-B 13

MAR 2007

Third Party Computer Software and Trademarks

Third Party Computer Software and Trademarks■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Computer Software

The Motorola and 3rd Party supplied Software (SW) products described in this instructiondocument may include copyrighted Motorola and other 3rd Party supplied computer programsstored in semiconductor memories or other media. Laws in the United States and othercountries preserve for Motorola and other 3rd Party supplied SW certain exclusive rights forcopyrighted computer programs, including the exclusive right to copy or reproduce in anyform the copyrighted computer program. Accordingly, any copyrighted Motorola or other 3rdParty supplied SW computer programs contained in the Motorola products described in thisinstruction document may not be copied (reverse engineered) or reproduced in any mannerwithout the express written permission of Motorola or the 3rd Party SW supplier. Furthermore,the purchase of Motorola products shall not be deemed to grant either directly or by implication,estoppel, or otherwise, any license under the copyrights, patents or patent applications ofMotorola or other 3rd Party supplied SW, except for the normal non-exclusive, royalty freelicense to use that arises by operation of law in the sale of a product.

Vendor Copyright

Apache Software Foundation Copyright 2001, 2002, 2003, 2004 , 2004 AllRights Reserved

Artesyn Copyright All Rights Reserved

CMU * Copyright All Rights Reserved

Open Source Software Foundation * Copyright 2000 All Rights Reserved

Open Source Tools / Utilities * Copyright All Rights Reserved

GNOME Project * Copyright 2004 All Rights Reserved

iodbc.org * Copyright 2002 All Rights Reserved

Megastep * Copyright 2002 All Rights Reserved

NIST * Copyright 2002 All Rights Reserved

openBSD * Copyright 2006 All Rights Reserved

openSSL * Copyright 2006 All Rights Reserved

Performance Technologies Copyright All Rights Reserved

Postgres * Copyright 2005 All Rights Reserved

Sun Microsystems Inc. * Copyright 2002 All Rights Reserved

Telelogic Copyright All Rights Reserved

QNX * Copyright All Rights Reserved

*= May contain purchased SW and Open Source SW which may be subject to a license fee.

14 68P09278A35-B

MAR 2007


Trademarks

Java™ Technology and/or J2ME™: Java and all other Java-based marks are trademarks orregistered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.

UNIX®: UNIX is a registered trademark of The Open Group in the United States and othercountries.

68P09278A35-B 15

MAR 2007


16 68P09278A35-B

MAR 2007

Chapter

1

Conguring MTAS■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

■

■

The carrier implements a machine–to–machine interface using standard XML commands. Thesecommands are used to add, delete, and query subscriber information. The XML interface isprovisioned on the Active Directory EMS server using the Mobile Telephony API Service (MTAS)interface.

In the tables and fields that follow, the provisioning system of a carrier is referred to as anMTAS system. The MTAS_Adapter process must be provisioned to enable the XML interface.The database ensures that all MINs and MDNs are unique for any point in time.

The operator must ensure that Motorola preconfigures an MTAS process to provision theMTAS_Adapter for interfacing to the northbound provisioning system for the XML interface.

68P09278A35-B 1-1

MAR 2007

Preconguring the MTAS process Chapter 1: Conguring MTAS

Preconguring the MTAS process■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

From the Active Directory of the EMS interface, select Configuration > Chassis Setup >Processes. The Processes screen is displayed as shown in Figure 1-1. This screen displaysthat an MTAS process is configured on the system and is running.

Figure 1-1 Viewing MTAS process

ti-POC-Viewing_MTAS_process.eps

1-2 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Reconguring the timer

Reconguring the timer■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The MTAS_Adapter process receives XML transaction requests using TCP/IP socket connectionson port 6827. The MTAS_Adapter waits for a specified period of time to receive a completedXML request. The default value is 30 seconds.

Procedure 1-1 Specifying the number of secondsTo specify the number of seconds to wait, to receive a completed XML transaction request:

1 Select Configuration > OAMP > MTAS as shown in Figure 1-2.

2 Change the Request Timeout field and click Submit.

Figure 1-2 MTAS_Adapter timer conguration

ti-POC-MTAS_Adapter_Timer_Configuration.eps

68P09278A35-B 1-3

MAR 2007

Login/Logout Chapter 1: Conguring MTAS

Login/Logout■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

There is no login/logout process specific to XML provisioning. Login and Logout procedures areperformed related to starting the MTAS Adapter process. Detailed information on login/logoutprocedures is available in the Provisioning Guide.

1-4 68P09278A35-B

MAR 2007

Chapter

2

XML interface transaction format■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

■

■

The following XML formats are used to:

• Add subscribers

• Change subscribers

• Delete subscribers

• Query subscriber status

• Add enterprise

• Delete enterprise

• Modify enterprise

• Query enterprise

• Add enterprise administrator

• Modify enterprise administrator

• Modify enterprise administrator password

• Delete enterprise administrator

• Query enterprise administrator status

68P09278A35-B 2-1

MAR 2007

Transaction format Chapter 2: XML interface transaction format

Transaction format■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Table 2-1 Transaction format

Tag M/O Meaning Example

<Carrier:Request> Mandatory Root tag for requests <Carrier:Request>

Customize valueof the Carrierwith name of thecarrier.

<Carrier:Response> Mandatory Root tag for responses <Carrier:Response>

Customize valueof the Carrierwith name of thecarrier.

<Source> Mandatory Provisioning SystemName

<Source>MTAS</Source>

<TrnType> Mandatory Transaction Type(A/D/P/r/Q)

• A: Add subscriber

• D: Deletesubscriber

• r: Changesubscriber MINor MDN

• P: Permanentlydelete subscriberfrom database

• Q: Query to seeif subscriber isactive, suspended,or deleted.

<TrnType>A</TrnType>

Continued

2-2 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Transaction format

Table 2-1 Transaction format (Continued)


• C: Feature changemessage

See Note.

Transaction Type(EA/ED/ER/EQ)

• EA: Add enterprise

• ED: Purgeenterprise

• ER: Modifyenterprise

• EQ: Queryenterprise

<TrnType>EA</TrnType>

Transaction Type(EaA/EaD/EaR/EaM/EaQ)

• EaA: Addenterpriseadministrator

• EaD: Deleteenterpriseadministrator

• EaR: Modifyenterpriseadministratorname

• EaM: Modifyenterpriseadministratorpassword

• EaQ: Queryenterpriseadministrator

<TrnType>EaA</TrnType>

Continued

68P09278A35-B 2-3

MAR 2007




For transaction types A or r:

• Both MDN and MIN must be present.

• When values are provided for <Prepaid> or<EnterpriseName>, provided values are used for new orexisting subscribers.

• When values are NOT provided:

For new subscribers, <Prepaid> is set to 0 and<EnterpriseName> is set to NULL.

For existing subscribers, <Prepaid> and<EnterpriseName> current values are migrated.

For other transaction types, MDN or MIN must be present.

<MIN> Mandatory MIN number <MIN>9786542323</MIN>

<ReqId> Mandatory A unique transactionID (to identify thistransaction)

<ReqId>44352617</ReqId>

<MDN> Mandatory Mobile DirectoryNumber

<MDN>9786542323</MDN>

<OldMIN> Optional exceptmandatory forTrnType: r

Old MIN <OldMIN>5553334242</OldMIN>

<OldMDN> Optional exceptmandatory forTrnType: r

Old MDN <OldMDN>5553334242</OldMDN>

Optional

• If presentin thechangemessage,updateaccordingly.

• If presentin otherMTASmessages,ignore.

Class Of Servicenumber

• 1 – PTI Legacy Cos

• 2 – PTx Nopresence

• 3 – PTe Premium

Presence CosSee Note.

<ClassOfService>1</ClassOfService>

<ClassOfService>

Continued

2-4 68P09278A35-B

MAR 2007




These values are configurable using the EMS GUI interface, toany value the operator chooses. Default values are shown.

For example,

• Change 2– PTx No presence to PTx Presence off

• Add another option such as, 4 – Prepaid Prepaidcustomers

<Prepaid> Optional Determines whethersubscriber is a Prepaidcustomer or not.

<Prepaid>1</Prepaid>

• 1 (for a prepaidsubscriber)

• 0 (for a postpaidsubscriber)

<EnterpriseName> Optional inthe activationand changemessages.Ignore if itis present inother MTASmessages.

Associates subscriberwith the providedenterprise. Enterpriseadministrator providesthe account settings.

<EnterpriseName>XYZEnterprises</EnterpriseName>

• Valid values arethe names ofpreprovisionedenterprises

• NULL (no enterprise)

Period (.) is notallowed in theenterprise name.

<ReturnCode> Optional exceptmandatory for areturn message.

Return Code <ReturnCode>0</ReturnCode>

Continued

68P09278A35-B 2-5

MAR 2007




<ReturnMessage> Optional exceptmandatory for areturn message.

Return Message• If the value of

<ReturnCode> is 0,then <ReturnMessage>Success</ReturnMessage>

• If the value of<ReturnCode>is not 0, then<ReturnMessage>NNN:errormessage</ReturnMessage>where NNN is athree digit error code.For example, 001:Subscriber does notexist

<Version> Mandatory ifthe databaseversion is v4x orhigher.

MTAS uses thisinformation forhandling multipleversions of MTASclients.

<Version>v5x</Version>If the version is notv4x, v5x, or v6x therequest is rejected with a013: Tag <Version> hasillegal value %s

• v4x –identifies anMTAS clientcompatiblewith PoCrelease 4.x.



Continued

2-6 68P09278A35-B

MAR 2007




<Password> Optional inthe activationand changemessages.Ignore if presentin other MTASmessages.

Optional in theactivation and changemessages. Ignore ifpresent in other MTASmessages.

<Password>guesswho</Password>

• If present in anactivation messageand the activation issuccessful, add thesubscriber with thesupplied password.

• If present in the changemessage and thechange is successful,update the passwordof the subscriber in thedatabase.

Optional inthe activationand changemessages.Ignore if presentin other MTASmessages.

ESN of the subscribersmobile. The ESN can bespecified in decimal orhex format. See Note.

<EquipmentId>1234567</EquipmentId><EquipmentId>0x0123abcd</Equipment Id>

• If present in activationmessage and activationis successful, add thesubscriber with thesupplied ESN.

• If present in activationmessage and activationis successful, add thesubscriber with thesupplied ESN.

• If present in the changemessage and if thechange is successful,update the subscribersESN in the database.

If the <EquipmentId>tag is present, checkthe value to see if it isan integer.

If the value is not aninteger, an error of013: Tag <EquipmentId>has illegal value %s isreturned.

<EquipmentId>

If a subscriber has an associated ESN, it is returned in theQuery response in decimal format.

Continued

68P09278A35-B 2-7

MAR 2007




Optional inthe activationand changemessages.If present inother MTASmessages it isignored.

Name of wholesalecustomer. The valueis a string of up to 64characters. See Note.

<WholesaleCustomerName>XYZ</WholesaleCustomerName>

• If present in anactivation messageand the activation issuccessful, add thesubscriber with thesupplied wholesalecustomer name.

• If present in a changemessage and thechange message issuccessful, update thewholesale customername of the subscriberin the database.

If the tag is present, itsvalue is checked againstthe preprovisionedvalues in the databaseto decide whether thevalue is permissible.

If the value is notpermissible, an error of013: Tag<WholesaleCustomerName>has illegal value %s isreturned.

<WholesaleCustomerName>

If a subscriber has an associated wholesale customer name, itis returned in the query response message.

<RedirectInfo> Optional tagin the MTASresponse.

Use in response to anMTAS request, wherethe MDN prefix isnot configured on thelocal AD or the MINprefix is not configuredon any of the ADs.This tag is used toindicate the addressof the webserverand the NM host.The MTAS client usesthis information toredirect its MTASrequest to the correctNM host/webserveraddress.

<RedirectInfo><NMHostAddress>10.232.115.36</ NMHostAddress><WebServerAddress>http://10.232.115.3 6/gws/PTTProvServlet?Action=Generate&Xsl=new_index.xsl</ WebServerAddress>

Continued

2-8 68P09278A35-B

MAR 2007




<NMHostAddress> Optional tagin the MTASresponse.Can be 0.0.0.0if no NM hostis configuredfor MIN/MDNprefix.

Specifies a sub tagunder <RedirectInfo>tag to indicate the NMhost address the MTASto which the client mustredirect its request.

<NMHostAddress>10.232.115.36 </NMHostAddress>

Optional tagin the MTASresponse.Can be NULLif no web serveris configuredfor MIN/MDNprefix.

Specifies a sub tagunder <RedirectInfo>tag to indicate theWebserver addressthe MTAS client mustredirect its request to.This address must beginwith a http:// or https://and must be a validwebserver address. SeeNote.

<WebServerAddress>http://10.232.115.3 6/gws/PTTProvServlet?Action=Generate&Xsl=new_index.xsl</ WebServerAddress>

<WebServerAddress>

XML commands are sent asynchronously to the MTAS processand correlated by the sending system by use of the <RegID>field. Multiple commands may be outstanding at any giventime, although it is recommended that commands for a givensubscriber are serialized.

<OldEnterpriseName> In the changemessages ERfor enterprises,if OldDBNumand DBNumtags are notpresent,OldEnterpriseNameis mandatory.Ignore ifpresent inother MTASmessages.

Contains the oldenterprise name thathas to be changed.

<OldEnterpriseName>enterprise1</OldEnterpriseName>

Continued

68P09278A35-B 2-9

MAR 2007




<EnterpriseAdminName> Mandatoryin Enterpriseadminprovisioningrequests EaA,EaR, EaM , EaD.Ignore if presentin other MTASmessages.

Contains the enterpriseadmin name to beadded.

<EnterpriseAdminName>Admin1</EnterpriseAdminName>

<EnterpriseAdminPassword> Optional inthe activationmessages forenterprise withTransactiontype EaA.Ignore if presentin other MTASmessages.

Contains the enterpriseadmin password to beassociated with theadmin name.

<EnterpriseAdminPassword>passwd</EnterpriseAdminPassword>

<OldEnterpriseAdminName> Optional inthe changemessages forenterprise withTransactiontype EaR.Ignore if presentin other MTASmessages.

Contains the enterpriseadmin name to bechanged with thereplace operation.

<OldEnterpriseAdminName>Admin1</OldEnterpriseAdminName>

<NewEnterpriseAdminPassword>

Optional inthe changemessages forenterprise withTransactiontype EaM.Ignore if presentin other MTASmessages.

Contains the newenterprise adminpassword to beassociated with theadmin name usingthe enterprise replaceoperation.

<NewEnterpriseAdminPassword>passwd1</NewEnterpriseAdminPassword>

<CosList> Optional tagin the changemessages oractivationmessage forenterprise withTransactiontype ER or EA.Ignore if presentin other MTASmessages.

Contains list of class ofservice to be assignedto the enterprise.The Cos tag contains theclass of service value.The feature tag containsthe representation ofclass of service.

<CosList><Cos>1</Cos><Cos>2</Cos></CosList><CosList><Feature>PTI</Feature><Feature>PTX</Feature></CosList>

Continued

2-10 68P09278A35-B

MAR 2007




<SuperAdmin> Optional tagin the changemessages oractivationmessage forenterpriseAdminwithTransactiontype EaR orEaA. Ignoreif present inother MTASmessages.

Suggests ifthe enterpriseadministrator namethat has to be addedmust be considered assuper administrator ora normal administrator.

<SuperAdmin>1</SuperAdmin>

<Billingcode> Optional inthe activationand changemessages.Ignore if presentin other MTASmessages.

Allows only fourcharacters.

• If present inan activationmessage and ifthe activation issuccessful, addthe subscriberwith the suppliedbilling code.

• If present in thechange messageand if the changeis successful,update the billingcode in thedatabase.

<Billingcode> tagallows only hexadecimalcharacters that is, 0-9and a-f.

<Billingcode>abcd</Billingcode>

<Pui> It is mandatoryfor OMAsubscriber, addand replacemessages.

Indicates the publicuser Id of a subscriber.

<Pui>[email protected]</Pui>

<Pvi> It is mandatoryfor OMAsubscriber, addand replacemessages.

Indicates the privateuser Id of a subscriber.

<Pvi>12345</Pvi>

<Auth> Optional Indicates theauthentication schemeto be used for userauthentication.

<Auth>1</Auth>

Continued

68P09278A35-B 2-11

MAR 2007




<DigSecret> Optional, exceptif <Auth> isset to a nonzero value inadd and replacemessage.

Indicates the md5encoded password ofthe user.

<DigSecret>password</DigSecret>

<ClientType> Mandatory foradd and replacemessage, if<ExtendedParams>is present. Thedefault valueis 0, whichindicates MPTTsubscriber.

Indicates if thesubscriber is MPTTor OMA subscriber.

<ClientType>0</ClientType>

<AccountType> Optional Indicates if thesubscriber belongsto a corporate or is anindividual subscriber.

<AccountType>1</AccountType>

<CosDel> Optional In Enterprise replaceoperation, if <CosDel>is set to one, delete allthe class of servicesassociated with anenterprise.

<CosDel>1</CosDel>

<AuthVisited> Optional Indicates the roamingpolicy of a user

<AuthVisited>1</AuthVisited>

<FeatureList> Optional Indicates theprovisioning of featuretag.

<FeatureList><Featureop=“I”>PTI</Feature></FeatureList>

<Feature> Optional Contains the feature tagto be provisioned forsubscriber. Operation

• I: Add operation

• O: Deleteoperation. PTTserver ignoresthis.

• K: No change. PTTserver ignoresthis.

<Featureop=“I”>PTI</Feature>

Continued

2-12 68P09278A35-B

MAR 2007




<DBNum> Optional Used during Enterprise,Enterprise Admin,and subscriberaddition and replaceoperations. In Admin,Subscriber operations,<EnterpriseName>tag can be substitutedwith <DBNum> tag.Indicates the D and Bnumber of an enterpriseand is an optional tag inall operations.

<DBNum>dbnum123</DBNum>

<MinAdminNameLength> Optional Used during Enterpriseadds and replaceoperations. This tagindicates the minimumlength required forlogin Id of Enterpriseadmin belonging to thisenterprise.

<MinAdminNameLength>9</MinAdminNameLength>

<MinAdminPasswdLength> Optional Used during Enterpriseadds and replaceoperations. This tagindicates the minimumlength required forpassword of Enterpriseadmin belonging to thisenterprise.

<MinAdminPasswdLength>9</MinAdminPasswdLength>

<AdminNumSavedPasswds> Optional Used during Enterpriseadd and replaceoperations. Thistag indicates thenumber of mostrecent <AdministratorPasswords> not allowedto be reused.

<AdminNumSavedPasswds>4</AdminNumSavedPasswds>

<AdminAllowedWrngPasswdAttempts>

Optional Used during Enterpriseadds and replaceoperations. This tagindicates numberof times incorrectLogin Id/Passwordcombinations that areallowed to be entered

<AdminAllowedWrngPasswdAttempts>9</AdminAllowedWrngPasswdAttempts>

Continued

68P09278A35-B 2-13

MAR 2007




<AdminAcctLockOutPeriod> Optional Used during Enterpriseadds and replaceoperations. This tagindicates the durationof <Account LockoutPeriod> in minutesenforced when anadmin enters incorrectLogin Id/Passwordcombinationpre-configured numberof times.

<AdminAcctLockOutPeriod>9</AdminAcctLockOutPeriod>

<AdminPasswdExpiryPeriod> Optional Used during Enterpriseadds and replaceoperations. This tagindicates the numberof days after whichthe Admin passwordexpires from the daythe password wascreated.

<AdminPasswdExpiryPeriod>9</AdminPasswdExpiryPeriod>

<AdminPasswdExpiryNotifyPeriod>

Optional Used during Enterpriseadd and replaceoperations. This tagindicates the number ofdays before which theAdmin is to be notifiedof upcoming passwordexpiration day.

<AdminPasswdExpiryNotifyPeriod>9</AdminPasswdExpiryNotifyPeriod>

<EnterpriseAdminFirstName>

Mandatory inadmin add

Indicates the first nameof the Admin during<Enterprise Admin>add operation.

<EnterpriseAdminFirstName>ADMIN_06_FN</EnterpriseAdminFirstName>

<EnterpriseAdminLastName> Mandatory inadmin add

Indicates the last nameof the Admin during<Enterprise Admin>add operation.

<EnterpriseAdminLastName>ADMIN_06_LN</EnterpriseAdminLastName>

<EnterpriseAdminEmailId> Mandatory inadmin add

Indicates the Email Idof the Admin during<Enterprise Admin>add operation.

<EnterpriseAdminEmailId>[email protected]</EnterpriseAdminEmailId>

<OldDBNum> Optional Used during Enterprisereplace operation ER.This tag can be usedwith <DBNum> tag tomodify an enterprise.

<OldDBNum>dbnum1</OldDBNum>

2-14 68P09278A35-B

MAR 2007

Chapter

3

Maintaining subscribers■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

■

■

This section covers the following:

• Adding a subscriber using XML

• Deleting a subscriber using XML

• Modifying a subscriber MIN or MDN using XML

• Querying a subscriber status using XML

68P09278A35-B 3-1

MAR 2007

Adding a subscriber using XML Chapter 3: Maintaining subscribers

Adding a subscriber using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

This section describes the XML formats and requests.

Format

Add subscribers to the PoC database using the following XML request:<?xmlversion=“1.0”?><Carrier:Request><ReqId>000034756200001</ReqId><Source>MTAS</Source><TrnType>A</TrnType><MIN>7022329875</MIN><MDN>8453650000</MDN><ClassOfService>1</ClassOfService><Version>v5x</Version></Carrier:Request>

when <Prepaid> is used:<?xmlversion=“1.0”?><Carrier:Request><ReqId>000034756200001</ReqId><Source>MTAS</Source><TrnType>A</TrnType><MIN>7022329875</MIN><MDN>8453650000</MDN><ClassOfService>1</ClassOfService><Prepaid>1</Prepaid><Version>v5x</Version></Carrier:Request>

when <EnterpriseName> is used:<?xmlversion=“1.0”?><Carrier:Request><ReqId>000034756200001</ReqId><Source>MTAS</Source><TrnType>A</TrnType><MIN>7022329875</MIN><MDN>8453650000</MDN><ClassOfService>1</ClassOfService><EnterpriseName>XYZ Enterprises</EnterpriseName><Version>v5x</Version></Carrier:Request>

when <BillingCode> is used:<?xmlversion=“1.0”?><Carrier:Request><ReqId>000034756200001</ReqId><Source>MTAS</Source><TrnType>A</TrnType><MIN>7022329875</MIN><MDN>8453650000</MDN><BillingCode>abcd</BillingCode><ClassOfService><EnterpriseName>XYZ Enterprises</EnterpriseName></Carrier:Request>

when <Feature> is used:<?xmlversion="1.0"?><VZWsps:Request><ReqId>000034756200001</ReqId><Source>MTAS</Source><Version>v5x</Version><MIN>9147149999</MIN><MDN>9147149999</MDN><TrnType>A</TrnType><FeatureList><Feature op=”I”>PTI</Feature></FeatureList><ClassOfService>0</ClassOfService></VZWsps:Request>

3-2 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Adding a subscriber using XML

Requirement

This transaction must contain the following for the entry to be added:

• MIN

• MDN

• ClassofService – The value:

must equal to zero when running MTAS version prior to v3.x, as set via the TL1interface.

must match an existing, defined Class of Service when running MTAS version v3.xor later.

must match existing value in the directory when a suspended subscriber is changedto an active state or the command fails.

Defined Class of Services are numbered 1...N, and therefore when runningwith v3.x or later, the Class of Service field may not be 0.

Results for a new subscriber

Table 3-1 Adding a subscriber results

If... Then...

the subscriber database already contains theMIN and MDN as separate entities in thedatabase,

the request fails.

the MIN or MDN exist as a single entity, the current entry is removed and new entryis added.

the MIN and MDN exists as the same entry, the status of the subscriber changes fromsuspend to active.

the MIN and MDN are mandatory and bothtags are missing,

the error is reported for the first missingmandatory tag.

a mandatory tag is missing, the transaction fails and the transactionresponse contains Return Code 1with one of the following messages:

003: Mandatory Tag <tag> is missing

004: Tag <tag> tvalue is missing

005: Tab <tab> has null value

Continued

68P09278A35-B 3-3

MAR 2007

Adding a subscriber using XML Chapter 3: Maintaining subscribers

Table 3-1 Adding a subscriber results (Continued)

If... Then...

any of the <Prepaid>, <EnterpriseName>,<Version>, <EquipmentId>,<WholesaleCustomerName>,<AccountType> tags do not have permissiblevalues,

the transaction fails and the responsecontains the following message:

013: Tab <tag> has illegal value <value>

• the root tag for request contains VZWas prefix,

• the <feature> tag is included in thecommand, and

• the command is successful (ReturnCode= 0),

the <feature> tag provided is used for thenew subscriber.

IMSI is substituted for MIN and MSISDN is substituted for MDN.

Table 3-2 Adding subscriber XML transaction results

Transactiontype

Currentdatabase(MIN, MDN)

Transaction Result Returncode

Return message

NewSubscriber

(X,X) (X,Y) (X,X) is deleted and(X,Y) is added.

0Success

NewSubscriber

(Y,Y) (X,Y) (Y,Y) is deleted and(X,Y) is added.

0Success

NewSubscriber

(X,X) (X,X) If (X,X) is suspended,the state changes toactive.

0Success

NewSubscriber

(X,X) (Y,Y) (X,Y) Add fails 3 002: MIN andMDN exist inseparate rows

SuspendedSubscriber

(X,X) (X,Y) (X,Y) is addedbut inherits thedelete state.The buddy list is NOTpreserved.

0Success

SuspendedSubscriber

(Y,Y) (X,Y) (X,Y) is active.The buddy list is NOTpreserved.

0Success

Continued

3-4 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Adding a subscriber using XML

Table 3-2 Adding subscriber XML transaction results (Continued)

Transactiontype

Currentdatabase(MIN, MDN)

Transaction Result Returncode

Return message

SuspendedSubscriber

(X,X) (Y,Y) (X,Y) Add fails 3 002: MIN andMDN exist inseparate rows

SuspendedSubscriber

(X,X) (X,X) Add fails 3 009: DatabaseOperationFailure

To add an enterprise subscriber either <DBNum> or <EnterpriseName> tag or both can beused. If either of them do not exist or if they are not linked, appropriate error is thrown.

68P09278A35-B 3-5

MAR 2007

Deleting a subscriber using XML Chapter 3: Maintaining subscribers

Deleting a subscriber using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Subscribers can be deleted from the system by one of the following two ways:

• Delete the subscriber using transaction code D. This places the subscriber in a suspendedmode for a configurable period. The default is 30 days. After the suspension time haspassed, the subscriber is deleted if an Add request has not been received.

• Delete the subscriber using transaction code P which immediately removes the subscriberfrom the database.

Delete subscribers using transaction code D

Use this type of deletion to temporarily suspend a subscriber. For example, to place a subscriberin suspended state if payment is late.

To optimize system performance, only delete subscribers using transaction codeD to place the subscriber in suspend mode. Placing deleted subscribers into anunnecessary suspend mode creates more transactions which can have an affect onCPU utilization during cleanup.

Do NOT use transaction code D for permanent deletes or for reusing MIN/MDN ofsuspended subscribers.

Format

Delete subscribers from the system and put in suspend mode using the following XML request:

MDN only:<?xml version=“1.0”?><Carrier:Request><ReqId>324567112</ReqId><Source>MTAS</Source><TrnType>D</TrnType><MDN>8453650000</MDN><Version>v5x</Version></Carrier:Request>

MIN only:<?xmlversion=“1.0”?><Carrier:Request><ReqId>000034756200001</ReqId><Source>MTAS</Source><TrnType>D</TrnType><MIN>8453650001</MIN><Version>v5x</Version></Carrier:Request>

MIN and MDN:<?xmlversion=“1.0”?><Carrier:Request><ReqId>000034756200001</ReqId><Source>MTAS</Source><TrnType>D</TrnType><MIN>8453650001</MIN><MDN>8453650000</MDN><Version>v5x</Version></Carrier:Request>

3-6 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Deleting a subscriber using XML

A suspended subscriber is not able to access the webserver to add/remove groupsand buddies until they are reactivated. See Table 3-2 and Table 3-6 for more detailson reactivation scenarios.

Requirements

This transaction must contain a MIN, MDN, or both MIN and MDN.

Results

Table 3-3 Transaction Code D Results

If... Then...

the subscriber is placed in suspendstate and is not found,

the transaction response contains a ReturnCode of 0indicating success. The user is no longer an activesubscriber.

the subscriber exists, their group and buddy lists are maintained untilpermanently deleted from the system, either byexecution of P command or expiration of theconfigurable timer. The subscriber is NOT allowed touse the service.

The value of the suspension period isconfigurable from the EMS GUI or via TL1.

At the end of the configurable period, if the system has not received an Add request for thesuspended subscriber, that subscriber is permanently removed from the system and their buddyand group lists are removed.

Other deletion scenarios

If a carrier adds a new subscriber using the suspended subscribers MDN with a different MINor the suspended subscribers MIN with a different MDN, the following scenarios occur.

• x is the suspended subscribers MIN

• y is the suspended subscribers MDN

68P09278A35-B 3-7

MAR 2007

Deleting a subscriber using XML Chapter 3: Maintaining subscribers

Table 3-4 Other deletion scenarios

If... Then...

(x, y) exists (regardless of whether it issuspended or not) AND an activation requestcomes for (x, z)

• (x,y) is removed from the database,including buddies and groups.

• (x,z) is active but inherits the deletestate if the subscriber is marked fordeletion OR (x,z) is added immediately ifthe profile is NOT marked for deletion.

(x, y) exists (regardless of whether it issuspended or not) AND an activation requestcomes for (z, y)

• (x,y) is removed from the database,including buddies and groups.

• (z, y) is active after a purge if thesubscriber is marked for deletion OR(z,y) is added immediately if the profileis NOT marked for deletion.

Delete subscribers using transaction code P

Use this type of deletion to immediately delete a subscriber from the database.

Do NOT use this type of deletion if the subscriber is expected to be reactivated.Use transaction code D.

Format

The following XML command is used:

MDN only:<?xml version=“1.0”?><Carrier:Request><ReqId>324567112</ReqId><Source>MTAS</Source><TrnType>P</TrnType><MDN>8453650000</MDN><Version>v5x</Version></Carrier:Request>

MIN only:<?xmlversion=“1.0”?><Carrier:Request><ReqId>000034756200001</ReqId><Source>MTAS</Source><TrnType>P</TrnType><MIN>8453650001</MIN><Version>v5x</Version></Carrier:Request>

MIN and MDN:<?xmlversion=“1.0”?><Carrier:Request><ReqId>000034756200001</ReqId><Source>MTAS</Source><TrnType>P</TrnType><MIN>8453650001</MIN><MDN>8453650000</MDN><Version>v5x</Version></Carrier:Request>

3-8 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Deleting a subscriber using XML

Requirements

This transaction must contain a MIN, MDN or both MIN and MDN.

Results

Table 3-5 Transaction Code P results

If... Then...

MDN is specified and it is in the ActiveDirectory (AD),

the subscriber is deleted from the AD.

MIN is specified and it is in the AD, the subscriber is deleted from the AD.

MDN and MIN are specified and they bothexist on the same record,

the subscriber is deleted from the AD.

MDN and MIN are specified and only oneexists or both exist but on separate records,

the system returns Success because thesubscriber does not exist as specified in thequery. The subscriber is not deleted from theAD.

68P09278A35-B 3-9

MAR 2007

Modifying a subscriber MIN or MDN using XML Chapter 3: Maintaining subscribers

Modifying a subscriber MIN or MDN using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Modify MIN or MDN of subscribers using the following XML request:<?xmlversion=“1.0”?><Carrier:Request><ReqId>987654321234567</ReqId><Source>MTAS</Source><TrnType>r</TrnType><OldMIN>7654321111</OldMIN><MIN>7654321111</MIN><OldMDN>7654321111</OldMDN><MDN>9213456789</MDN><Version>v5x</Version></Carrier:Request>

when <ClassOfService> is used:<?xmlversion=”1.0”?><Carrier:Request><ReqId>987654321234567</ReqId><Source>MTAS</Source><TrnType>r</TrnType><OldMIN>7654321111</OldMIN><MIN>7654321111</MIN><OldMDN>7654321111</OldMDN><MDN>9213456789</MDN><ClassOfService>1</ClassOfService><Version>v5x</Version></Carrier:Request>

when <Prepaid> is used:<?xmlversion=“1.0”?><Carrier:Request><ReqId>044157617900001</ReqId><Source>MTAS</Source><TrnType>r</TrnType><OldMIN>8312475215</OldMIN><MIN>8313454605</MIN><OldMDN>8453650000</OldMDN><MDN>9143650000></MDN><Prepaid>0</Prepaid><Version>v5x</Version></Carrier:Request>

when <EnterpriseName> is used:<?xmlversion=“1.0”?><Carrier:Request><ReqId>044157617900001</ReqId><Source>MTAS</Source><TrnType>r</TrnType><OldMIN>8312475215</OldMIN><MIN>8313454605</MIN><OldMDN>8453650000</OldMDN><MDN>9143650000></MDN><EnterpriseName>XYZEnterprises</EnterpriseName><Version>v5x</Version></Carrier:Request>

when <BillingCode> is used:<?xmlversion=“1.0”?><Carrier:Request><ReqId>987654321234567</ReqId><Source>MTAS</Source><TrnType>r</TrnType><OldMIN>7654321111</OldMIN><MIN>7654321111</MIN><OldMDN>7654321111</OldMDN><MDN>9213456789</MDN><BillingCode>abcd</BillingCode><EnterpriseName>XYZ Enterprises</EnterpriseName></Carrier:Request>

when <FeatureList> is used:<?xmlversion=“1.0”?><VZWsps:Request><ReqId>987654321234567</ReqId><Source>MTAS</Source><Version>v5x</Version><MIN>9147149999</MIN><MDN>9147149999</MDN><TrnType>r</TrnType><OldMIN>9147149998</OldMIN><OldMDN>9147149998</OldMDN><FeatureList><Feature op="O">PTI</Feature></FeatureList></VZWsps:Request>

To add an enterprise subscriber either DBNum or EnterpriseName tag or both can be used. Ifeither of them do not exist or if they are not linked, appropriate error is thrown.

3-10 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Modifying a subscriber MIN or MDN using XML

Requirements

This transaction must contain the following:

• OldMIN

• OldMDN

• MIN

• MDN

• ClassofService value when specified:

must be equal to zero when running MTAS version prior to v3.x, as set via the TL1interface.

must match an existing, defined Class Of Service when running MTAS version v3.xor later.

Defined Class Of Services are numbered 1...N, and therefore when runningwith v3.x or later, the Class Of Service field may not be 0.

To add an enterprise subscriber either <DBNum> or <EnterpriseName> tag or both can beused. If either of them do not exist or if they are not linked, it throws appropriate error.

Results

The modification conditions listed in Table 3-6 are applied in the order shown.

Table 3-6 Modication conditions

Item If Then Returncode Return message

• New combo denotes (newMIN, newMDN)

• Old combo denotes (oldMIN, oldMDN)

Continued

68P09278A35-B 3-11

MAR 2007


Table 3-6 Modication conditions (Continued)


• (oldMIN, oldMDN) denotes items in the same row

• * is a wildcard that denotes any value

• <> denotes not equal to or does not match

the transaction issuccessful,

the database shows the newMIN and MDN, the old MINand old MDN are deleted.See Note

0Success

1

If the new (min, mdn) exist in the database as one entry, this entry is updated withthe following values (when available):

• PrePaid value

• EnterpriseName value

• ClassOfService value

• Password

• Equipment ID

• Wholesale Customer Name

• Account Type

a mandatory tag ismissing,

the transaction fails. SeeNote.

1 One of the followingReturnMessages:003: Mandatory Tag<tag> is missing004: Tag <tagvalue> valueis missing005: Tag <tagvalue> hasnull value006: Unknownmessage

If both the tags (MIN, MDN) are mandatory and both tags are missing, the error isreported for the first missing mandatory tag.

2

(oldMIN, oldMDN) doesnot exist, (newMIN,newMDN) does not exist,

the (new MIN, MDN) isentered in the database.

0Success

Continued

3-12 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Modifying a subscriber MIN or MDN using XML



3 (oldMIN, oldMDN) doesnot exist, (newMIN,newMDN) exist,

New combinationClassOfService, Prepaid,EnterpriseName fields areupdated, if available in themessage.

0Success

4 (oldMIN, oldMDN) doesnot exist(newMIN , *) doesnot exist, (*, newMDN)does not exist,

(newMIN, newMDN) isinserted.

0Success

5 (oldMIN, oldMDN) doesnot exist, (newMIN, *)exist, (*, newMDN) doesnot exist,

(newMIN, *) is deleted.Followed by activation of(newMIN, newMDN).

0Success

(oldMIN, oldMDN) doesnot exist, (newMIN,*) does not exist, (*,newMDN) exist,

(*, newMDN) is deleted.Followed by activation of(newMIN, newMDN).

0Success

6

For items 7 through 12, a subscriber who is in suspend mode has their webserverpassword transferred whenever the buddies are transferred, but the suspendedsubscriber is not able to log into the webserver until they are re–activated eitherby adding or modifying the subscriber.

7 (oldMIN, oldMDN) exist,newMIN=oldMIN, (*,newMDN) does not exist,

oldMDN getsupdated to newMDN,Buddy and grouplists are migrated,Suspend state is migrated.

0Success

8 (oldMIN, oldMDN) exist.(newMIN, *) does notexist,

newMDN=oldMDN, oldMINgets updated to newMIN,Buddy and grouplists are migrated,Suspend state is migrated.

0Success

9 (oldMIN, oldMDN) exist.newMIN=oldMIN, (*,newMDN) exist,

(*, newMDN) isremoved, (oldMIN,(oldMDN) gets updatedto (newMIN, newMDN),Buddy and group lists aremigrated from old combo,Suspend state is migrated.

0Success

Continued

68P09278A35-B 3-13

MAR 2007




10 (oldMIN, oldMDN) exist,(newMIN, *) does notexist, (*, newMDN) doesnot exist,

(oldMIN, oldMDN)is removed,(newMIN, newMDN)is inserted,Buddy and group lists aremigrated from old combo,Suspend state is migrated.

0Success

11 (oldMIN, oldMDN) exist,newMIN<>oldMIN,(newMIN, *) exist, (*,newMDN) does not exist,

(newMIN, *) is removed,(oldMIN, oldMDN)is removed,(newMIN, newMDN)is inserted,Buddy and group lists aremigrated from old combo,Suspend state is migrated.

0Success

12 (oldMIN, oldMDN) exist,newMDN<>oldMDN,(*, newMDN) exist,(newMIN, *) does notexist,

(*, newMDN) is removed,(oldMIN, oldMDN) is updatedto (newMIN, newMDN) ,Buddy and group lists aremigrated from old combo,Suspend state is migrated.

0Success

13 (oldMIN, oldMDN) exist,newMDN<>oldMDN,newmin<>oldMIN(newMIN, newMDN)exist,

(oldMIN, oldMDN) isremoved includingthe buddylist,(newMIN, newMDN)is removed includingthe buddylist,(newMIN, newMDN) isadded without buddy/grouplists.

0Success

14 (*,newMDN) exist,(newMIN,*) exist butin separate rows,

Request fails 3 002: MIN and MDNexist in separaterows

15 (oldMIN, oldMDN) existin separate records andeither MIN or MDN doesnot match,

Request fails 3 017: Old MIN andOld MDN exist ondifferent records

3-14 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Query a subscriber status using XML

Query a subscriber status using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Query the status of a subscriber using the following XML request:

MDN only:<?xmlversion=“1.0”?><Carrier:Request><ReqId>999888777666555</ReqId><Source>MTAS</Source><TrnType>Q</TrnType><MDN>9875431234</MDN><Version>v5x</Version></Carrier:Request>

MIN only:<?xmlversion=“1.0”?><Carrier:Request><ReqId>000034756200001</ReqId><Source>MTAS</Source><TrnType>Q</TrnType><MIN>8453650001</MIN><Version>v5x</Version></Carrier:Request>

MIN and MDN:<?xmlversion=“1.0”?><Carrier:Request><ReqId>000034756200001</ReqId><Source>MTAS</Source><TrnType>Q</TrnType><MIN>7022329875</MIN><MDN>8453650000</MDN><Version>v5x</Version></Carrier:Request>

Requirements

This transaction request must contain a MIN and/or an MDN.

If version is set to v6x, the response includes <DBNum> tag also if it was provisioned.>< Carrier:Response><ReqId>000034756200001</ReqId><MDN>8453650000</MDN><MIN>7022329875</MIN><FeatureList><Feature>PT2</Feature></FeatureList><ClassOfService>0</ClassOfService><Prepaid>1</Prepaid><WholesaleCustomerName>whole_sale123</WholesaleCustomerName><EnterpriseName>Ename123</EnterpriseName><DBNum>dbnum123</DBNum><ReturnCode>0</ReturnCode><ReturnMessage>Subscriber Exists</ReturnMessage></Carrier:Response>

68P09278A35-B 3-15

MAR 2007

Query a subscriber status using XML Chapter 3: Maintaining subscribers

Results

Table 3-7 Query a subscriber results

If... Return code Return message

the MIN and or MDN as listedin the query request is notactive,

2 001: Subscriber does not exist

the subscriber is found, 0 Subscriber exists

the subscriber exists in thedatabase but is in suspendedstate,

2 012: Subscriber does not exist dueto delete tag

MDN and MIN are specifiedand only one exists or both existbut on separate records,

2 001: Subscriber does not exist

If both MIN and MDN tags aremissing,

2 007: Both MIN and MDN tags aremissing

3-16 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Change features using transaction code C

Change features using transaction code C■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Change features using the following XML request:

<?xmlversion:”1.0”?><VZWsps:Request><ReqId>999888777666555</ReqId><Source>MTAS</Source><Version>v5x</Version><MIN>9147149999</MIN><MDN>9147149999</MDN><TrnType>C</TrnType><FeatureList><Feature op="O">PTx</Feature></FeatureList><ClassOfService>0</ClassOfService></VZWsps:Request>

Requirement

The transaction must contain the MIN and MDN.

Rules

Rules for processing the C request are as follows:

• If <OldMDN> and <OldMIN> tags are not present, then the MTAS processes the resultidentical to A transaction. Presence of <OldMDN> or <OldMIN> tag shows that thistransaction is a MIN change. This causes the processing to be identical to r transaction

• If the change involves a feature change, then <FeatureList> must be present.

• If a change feature code is sent to MTAS, and the feature code does not exist in the list ofsupport feature codes in the server, then an appropriate error message is returned.

All change feature codes sent to MTAS replace existing feature codes. In other words, currentchange events for feature codes supersede existing feature codes.

68P09278A35-B 3-17

MAR 2007

Change features using transaction code C Chapter 3: Maintaining subscribers

3-18 68P09278A35-B

MAR 2007

Chapter

4

Enterprise and admin provisioning■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

■

■

This section explains the MTAS provisioning support for enterprise and admin name.


• Adding an enterprise using XML

• Deleting an enterprise using XML

• Modifying an enterprise using XML

• Querying an enterprise using XML

• Adding an enterprise admin using XML

• Deleting an enterprise admin using XML

• Modifying an enterprise admin using XML

• Modifying or resetting an admin password using XML

• Querying an enterprise admin name using XML

68P09278A35-B 4-1

MAR 2007

Adding an enterprise using XML Chapter 4: Enterprise and admin provisioning

Adding an enterprise using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Add enterprise name to the PTT database using the following XML request:

<?xml version="1.0"?><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>EA</TrnType><EnterpriseName>e1</EnterpriseName></Carrier:Request>

Request:><Carrier:Request> <Source>MTAS</Source><ReqId>12353</ReqId><Version>v5x</Version> <TrnType>EA</TrnType><EnterpriseName>ENTR_13</EnterpriseName><DBNum>dbnum123</DBNum><MinAdminNameLength>8</MinAdminNameLength><MinAdminPasswdLength>8</MinAdminPasswdLength><AdminNumSavedPasswds>1</AdminNumSavedPasswds><AdminAllowdWrngPasswdAttempts>1</AdminAllowdWrngPasswdAttempts><AdminAcctLockOutPeriod>1</AdminAcctLockOutPeriod><AdminPasswdExpiryPeriod>1</AdminPasswdExpiryPeriod><AdminPasswdExpiryNotifyPeriod>1</AdminPasswdExpiryNotifyPeriod></Carrier:Request>

Response:

<?xml version="1.0"?><Carrier:Response><ReqId>34756</ReqId>

<ReturnCode>0</ReturnCode><ReturnMessage>Success</ReturnMessage>

</Carrier:Response>

This command .supports the tags <EnterpriseName></EnterpriseName>. This ismandatory.

4-2 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Adding an enterprise using XML

This MTAS command also supports listing of Class of service (Cos) to assign to the enterprisename using the following tags.

• <CosList>

<Cos> </Cos>

<Cos> </Cos>

</CosList>

or

• <CosList>

<Feature> </Feature>


</CosList>

Request when <CosList> is used:><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>EA</TrnType><EnterpriseName>enterprise2</EnterpriseName><CosList><Cos>1</Cos><Cos>2</Cos></CosList></Carrier:Request>or<?xml version="1.0"?><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>EA</TrnType><EnterpriseName>enterprise2</EnterpriseName><CosList><Feature>PTI</Feature><Feature>PTx</Feature></CosList></Carrier:Request>

Response when <CosList> is used:

><Carrier:Response><ReqId>34756</ReqId>


</Carrier:Response>

If feature tags are provided, MTAS converts to Cos as is done for subscriber ADD commands.

Requirements

This transaction must contain an enterprise name.

Results

If <EnterpriseName></EnterpriseName> tags are missing, the transaction fails, and anappropriate error response is sent.

68P09278A35-B 4-3

MAR 2007

Deleting an enterprise using XML Chapter 4: Enterprise and admin provisioning

Deleting an enterprise using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Delete enterprise name from the database using the following XML request:

<?xml version="1.0"?><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>ED</TrnType><EnterpriseName>e1</EnterpriseName></Carrier:Request>

Response:



</Carrier:Response>

This command supports the tags <EnterpriseName></EnterpriseName>. Thisis mandatory.

Requirements

This transaction must contain an enterprise name.

Enterprises can be purged using DBNum tag alone or in combination with EnterpriseName.

Request with DBNum:><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>ED</TrnType><DBNum>dbnum123</DBNum></Carrier:Request>

Request with both DBNum , EnterpriseName Tags<?xml version="1.0"?><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>ED</TrnType><DBNum> dbnum123</DBNum><EnterpriseName> e1</EnterpriseName></Carrier:Request>

An error is thrown if:

• both <DBNum> and <Enterprise> are present.

• both tags are not linked to each other.

• neither of the tags are present.

4-4 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Deleting an enterprise using XML

Results

If <EnterpriseName></EnterpriseName> tags are missing, the transaction fails, and anappropriate error message is returned in the response message.

68P09278A35-B 4-5

MAR 2007

Modifying an enterprise using XML Chapter 4: Enterprise and admin provisioning

Modifying an enterprise using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Modify enterprise name using the following XML request:

<?xml version="1.0"?><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>ER</TrnType><OldEnterpriseName>enterprise1</OldEnterpriseName><EnterpriseName>enterprise2</EnterpriseName></Carrier:Request>

Response:



</Carrier:Response>

This command supports the following tags:

• <OldEnterpriseName></OldEnterpriseName>

• <EnterpriseName></EnterpriseName>

The above tags are mandatory and is optional if <DBNum> and <OldDBNum>tags are present.

The <DBNum> and <OldDBNum> tags can be used instead of <EnterpriseName> and<OldEnterpriseName> tags. If all of the above tags are missing, an error message is thrown.

The XML request/response with <DBNum> and <OldDBNum>:<?xml version="1.0"?><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>ER</TrnType><OldDBNum>dbnum2</OldDBNum><DBNum>dbnum3</DBNum> </Carrier:Request>

Response:

<?xml version="1.0"?><Carrier:Response><ReqId>34756</ReqId><ReturnCode>0</ReturnCode>

<ReturnMessage>Success</ReturnMessage></Carrier:Response>

Request to update DBNum of an existing enterprise:<?xml version="1.0"?><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>ER</TrnType></OldEnterpriseName><EnterpriseName>enterprise2</EnterpriseName><DBNum>dbnum3</DBNum> </Carrier:Request>

4-6 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Modifying an enterprise using XML

Response:


<ReturnCode>0</ReturnCode><ReturnMessage>Success</ReturnMessage></Carrier:Response>

To dissociate a DBNum from an existing enterprise, empty DBNum tag can be sentin the request. This request would remove the DBNum entry from the system.Request:><VZWsps:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>ER</TrnType><OldEnterpriseName>enterprise2</OldEnterpriseName><EnterpriseName>enterprise2</EnterpriseName><DBNum></DBNum><OldDBNum>dbnum2</OldDBNum></VZWsps:Request>

Response:

><VZWsps:Response><ReqId>34756</ReqId><ReturnCode>0</ReturnCode>

<ReturnMessage>Success</ReturnMessage></VZWsps:Response>

The <OldDBNum> tag is not mandatory for <DBNum> updation requests.Appropriate error messages is thrown if <DBNum> exists and is associated witha different enterprise.

This MTAS command also supports listing of Cos to modify to the enterprise name usingfollowing tags:

• <CosList>

<Cos> </Cos>

<Cos> </Cos>

</CosList>

or

• <CosList>



</CosList>

Request when <CosList> is used:><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>ER</TrnType><OldEnterpriseName>enterprise1</OldEnterpriseName><EnterpriseName>enterprise2</EnterpriseName><CosList><Cos>1</Cos><Cos>2</Cos></CosList></Carrier:Request>

68P09278A35-B 4-7

MAR 2007

Modifying an enterprise using XML Chapter 4: Enterprise and admin provisioning

Response when <CosList> is used:



</Carrier:Response>

If feature tags are provided, MTAS converts to Cos as is done for subscriber ADD commands.

• All administrator accounts, subscriber settings, subscribers who belong to theenterprise, and so on, are maintained.

• To remove all the Class of services associated with an enterprise, set <CosDel>to 1 with <OldEnterpriseName> and <EnterpriseName> having the sameenterprise name. If it is set to 0, the tag is ignored.

Request when <CosDel> is used:><XYZ:Request><Source>MTAS</Source><ReqId>12345</ReqId><Version>v5x</Version><TrnType>ER</TrnType><OldEnterpriseName>enterprise1</OldEnterpriseName><EnterpriseName>e5</EnterpriseName><CosDel>1</CosDel></XYZ:Request>

Response when <CosDel> is used:

><XYZ:Response><ReqId>12345</ReqId>


</XYZ:Response>

Enterprise replace message ER can also be used to modify the other attributesof an enterprise like Min Admin length, Min Admin Password length, and so on.Request when optional tag is used:><Carrier:Request><Source>MTAS</Source><ReqId>12345</ReqId><Version>v5x</Version> <TrnType>ER</TrnType><EnterpriseName>ENTR_02</EnterpriseName> <SuperAdmin>0</SuperAdmin><OldEnterpriseName>ENTR_02</OldEnterpriseName><MinAdminNameLength>9</MinAdminNameLength><MinAdminPasswdLength>9</MinAdminPasswdLength><AdminNumSavedPasswds>4</AdminNumSavedPasswds><AdminAllowdWrngPasswdTrys>9</AdminAllowdWrngPasswdTrys><AdminAcctLockOutPeriod>9</AdminAcctLockOutPeriod><AdminPasswdExpiryPeriod>9</AdminPasswdExpiryPeriod><AdminPasswdExpiryNotifyPeriod>9</AdminPasswdExpiryNotifyPeriod></Carrier:Request>The above operations can be substituted with <DBNum> and <OldDBNum>.

Requirements

The transaction must contain an enterprise name.

4-8 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Modifying an enterprise using XML

Results

The tags, <OldEnterpriseName></OldEnterpriseName>, and <EnterpriseName></Enter-priseName>, if included in a successful ER (modify) command, results in the updating of theenterprise name.

An error is returned and modify is not performed:

• If either of the required tags are missing.

• If the old enterprise name does not exist.

• If the new enterprise name exists.

• If the new enterprise name is too long or has invalid characters.

68P09278A35-B 4-9

MAR 2007

Querying an enterprise using XML Chapter 4: Enterprise and admin provisioning

Querying an enterprise using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Query an enterprise name using the following xml request:

><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>EQ</TrnType><EnterpriseName>enterprise1</EnterpriseName></Carrier:Request>

Response when Version is set to v6x:


<ReturnCode>0</ReturnCode><ReturnMessage>Enterprise name exists

</ReturnMessage><CosList><Cos>1</Cos></CosList><MinAdminNameLength>8

</MinAdminNameLength><MinAdminPasswdLength>8</MinAdminPasswdLength>


<AdminAllowdWrngPasswdAttempts>1</AdminAllowdWrngPasswdAttempts>



<AdminPasswdExpiryNotifyPeriod>1</AdminPasswdExpiryNotifyPeriod></Carrier:Response>

Response for all other values of version in DB:

><Carrier:Response><ReqId>34756</ReqId><ReturnCode>0</ReturnCode>

<ReturnMessage>Enterprise Name exists</ReturnMessage>

<CosList> <Cos>1</Cos></CosList></Carrier:Response>

Requirement

This command supports the tag <EnterpriseName></EnterpriseName> which is mandatoryand is optional if DBNum is used.

Similar to all other enterprise operations, Enterprise query also can use DBNum insteadof Enterprise Name.><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>EQ</TrnType><DBNum>dbnum</DBNum></Carrier:Request>

4-10 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Querying an enterprise using XML

Response when version is set to v6x:

><Carrier:Response><ReqId>34756</ReqId><ReturnCode>0

</ReturnCode><ReturnMessage>DBNum exists</ReturnMessage><CosList>

<Cos>1</Cos></CosList><MinAdminNameLength>8</MinAdminNameLength>

<MinAdminPasswdLength>8</MinAdminPasswdLength>


<AdminAllowdWrngPasswdAttempts>1</AdminAllowdWrngPasswdAttempts>



<AdminPasswdExpiryNotifyPeriod>1</AdminPasswdExpiryNotifyPeriod></Carrier:Response>

Response when version is set below v6x:

><Carrier:Response><ReqId>34756</ReqId><ReturnCode>0</ReturnCode>

<ReturnMessage>Enterprise Name exists</ReturnMessage>

<CosList> <Cos>1</Cos></CosList></Carrier:Response>

An error is thrown, if:

• both DBNum and Enterprise are present in the request.

• both are not linked.

• neither of the tags are present.

Result

If... Then...

the enterprise name in the databaseexists,

it returns message code zero.

the enterprise name in the databasedoes not exist,

it returns a non-zero message codeor an error.

there is a missing tag, it returns an error.

68P09278A35-B 4-11

MAR 2007

Adding an enterprise admin using XML Chapter 4: Enterprise and admin provisioning

Adding an enterprise admin using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Add an enterprise admin name using the following XML request:

><Carrier:Request><Source>MTAS</Source><ReqId>12353</ReqId><EnterpriseAdminName>EADMIN_473</EnterpriseAdminName><EnterpriseAdminFirstName>ADMIN_FN</EnterpriseAdminFirstName><EnterpriseAdminLastName>ADMIN_LN</EnterpriseAdminLastName><EnterpriseAdminEmailId>[email protected]</EnterpriseAdminEmailId><EnterpriseAdminPassword>Passwd126%</EnterpriseAdminPassword><SuperAdmin>1</SuperAdmin> <TrnType>EaA</TrnType><EnterpriseName>ENTR_14</EnterpriseName> </Carrier:Request>

Response:



</Carrier:Response>

Requirement

This command supports the following tags in add enterprise commands for a particularenterprise:

• <EnterpriseAdminName></EnterpriseAdminName>

• <EnterpriseAdminPassword></EnterpriseAdminPassword>


• <EnterpriseAdminFirstName> </EnterpriseAdminFirstName>

• <EnterpriseAdminLastName> </EnterpriseAdminLastName>

• <EnterpriseAdminEmailId> </EnterpriseAdminEmailId>

• <SuperAdmin></SuperAdmin>

The tags <EnterpriseAdminName>, <EnterpriseAdminPassword>, <EnterpriseAdminFirst-Name>, <EnterpriseAdminLastName>, and <EnterpriseAdminEmailId> are mandatory.The tag <EnterpriseName> is mandatory and is optional if DBNum is provided. The tag<SuperAdmin> is optional.

4-12 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Adding an enterprise admin using XML

Result

If... Then...

any of the mandatory fields aremissing,

MTAS interface returns an errormessage.

the tag <SuperAdmin> is notprovided,

it is considered as false by default.

<EnterpriseAdminPassword> tag is supplied to MTAS in unencoded format, and AD converts itinto encrypted form and stores into the database.

An error is returned:

• If EnterpriseName or DBNum does not exist.

• If EnterpriseAdminName exists.

• If any mandatory field is missing.

• If any field exceeds the maximum length.

• If any field contains invalid characters.

<DBNum> can be used instead of <EnterpriseName>. If <DBNum> does not exist, an erroris thrown.

68P09278A35-B 4-13

MAR 2007

Deleting an enterprise admin using XML Chapter 4: Enterprise and admin provisioning

Deleting an enterprise admin using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Delete enterprise admin name using the following XML request:

<?xml version="1.0"?><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>EaD</TrnType><EnterpriseAdminName>admin1</EnterpriseAdminName><EnterpriseName>e1</EnterpriseName></Carrier:Request>

Response:



</Carrier:Response>

Requirement

This command supports the following tags in the add enterprise administrator command for aparticular enterprise:



The tags <EnterpriseAdminName> is mandatory and <EnterpriseName> is mandatory andis optional if DBNum is provided.

Result

If... Then...

the mandatory tags are missing, appropriate error code is returned.

<EnterpriseAdminName> and<EnterpriseName> does not exist,

appropriate error code is returned.

<EnterpriseName> exists and the<EnterpriseAdmin> is not found,

transaction response contains aReturnCode of 0 indicating success.

Successful deletion of an administrator does not affect the admin-created contacts, or anysubscribers.

The tag <DBNum> can be used instead of <EnterpriseName>. If <DBNum> does not exist oris not associated with <EnterpriseAdmin>, an error is thrown.

4-14 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Modifying an enterprise admin using XML

Modifying an enterprise admin using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Modify the admin enterprise name using the following XML request:

><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>EaR</TrnType><OldEnterpriseAdminName></OldEnterpriseAdminName><EnterpriseAdminName>enterpriseAdmin2enterpriseAdmin1</EnterpriseAdminName><EnterpriseName>enterprise1</EnterpriseName></Carrier:Request>

Response:

><Carrier:Response<ReqId>34756</ReqId>


</Carrier:Response>

Requirement

This command supports the following tags in the add enterprise administrator command for aparticular enterprise:

• <OldEnterpriseAdminName></OldEnterpriseAdminName>



• <SuperAdmin></SuperAdmin>

• <EnterpriseAdminFirstName></EnterpriseAdminFirstName>

• <EnterpriseAdminLastName></EnterpriseAdminLastName>

• <EnterpriseAdminEmailId></EnterpriseAdminEmailId>

The tags <OldEnterpriseAdminName> and <EnterpriseAdminName> are mandatory,<EnterpriseName> is mandatory and is optional if <DBNum> is provided. The tag<SuperAdmin>, <EnterpriseAdminFirstName>, <EnterpriseAdminLastName>, and<EnterpriseAdminEmailId> are optional. The above tags result in updating of the enterpriseadmin name, for that particular enterprise in the database.

68P09278A35-B 4-15

MAR 2007

Modifying an enterprise admin using XML Chapter 4: Enterprise and admin provisioning

Result

If... Then...

the optional tag <SuperAdmin> is provided, the level of admin (Super, or regularadmin) is updated.

mandatory tags are missing,<OldEnterpriseAdminName> doesnot exist for the provided Enterprise, the<NewEnterpriseAdminName> is a duplicate,or the EnterpriseName does not exist,

MTAS interface returns appropriatenon-zero return codes (unsuccessful)


4-16 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Modifying or resetting an admin password using XML

Modifying or resetting an admin password using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Modify an enterprise admin password using following XML request:

><Carrier:Request><Source>MTAS</Source><ReqId>12345</ReqId><EnterpriseAdminName>EADMIN_46</EnterpriseAdminName><NewEnterpriseAdminPassword>Passwd126%</NewEnterpriseAdminPassword><OldEnterpriseAdminPassword>Passwd125%</OldEnterpriseAdminPassword><SuperAdmin>1</SuperAdmin> <EnterpriseName>ENTR_14</EnterpriseName><TrnType>EaM</TrnType> </Carrier:Request>

Response:



</Carrier:Response>

Requirements

This command supports the following tags in the add enterprise administrator command:


• <NewEnterpriseAdminPassword></NewEnterpriseAdminPassword>


The tag <EnterpriseAdminName> and <NewEnterpriseAdminPassword> is mandatory, whereas <EnterpriseName> is mandatory and is optional if <DBNum> is provided. The above tagsresults in the updating of enterprise admin password for admin for that particular enterprisein the database.

Result

The MTAS interface returns appropriate non-zero return codes (unsuccessful) if any mandatorytag is missing, or if the EnterpriseName, or EnterpriseAdminName does not exist. TheNewAdminPassword data is unencoded. There is no need to know the existing password.


68P09278A35-B 4-17

MAR 2007

Querying an enterprise admin name using XML Chapter 4: Enterprise and admin provisioning

Querying an enterprise admin name using XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Query an enterprise admin name using the following XML request:

<?xml version="1.0"?><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>EaQ</TrnType><EnterpriseAdminName>admin1</EnterpriseAdminName><EnterpriseName>e1</EnterpriseName></Carrier:Request>

Response:


<ReturnCode>0</ReturnCode><ReturnMessage>Enterprise Admin Name exists

</ReturnMessage></Carrier:Response>

Request when <EnterpriseAdminName> is used:<?xml version="1.0"?><Carrier:Request><ReqId>34756</ReqId><Source>MTAS</Source><TrnType>EaQ</TrnType><EnterpriseName>e1</EnterpriseName></Carrier:Request>

Response when <EnterpriseAdminName> is used:


<EnterpriseName>e1</EnterpriseName><EnterpriseAdminList>

<EnterpriseAdmin><name>admin1</name><SuperAdmin>1</SuperAdmin>

</EnterpriseAdmin></EnterpriseAdminList><ReturnCode>0</ReturnCode>

<ReturnMessage>Enterprise Name exists</ReturnMessage></Carrier:Response>

Requirements

This command supports the following tags in the add enterprise administrator command:



The tag <EnterpriseName> is mandatory and is optional if <DBNum> is provided, where as<EnterpriseAdminName> is optional.

4-18 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Querying an enterprise admin name using XML

If enterprise admin name is not supplied, a list of admin names for the specified enterprisename along with information if that admin is superAdmin or not is sent in the response message.

<EnterpriseAdminList>..<EnterpriseAdmin>....<name>admin1</name>....<SuperAdmin>1</SuperAdmin>..<EnterpriseAdmin><EnterpriseAdminList>

Results

If... Then...

the enterprise name for thatparticular enterprise exists in thedatabase,

it returns a message code 0.

the enterprise name for thatparticular enterprise does not existin the database,

it returns a non-zero return code(unsuccessful).

the enterprise name does not exist, it returns an appropriate error.


68P09278A35-B 4-19

MAR 2007

Querying an enterprise admin name using XML Chapter 4: Enterprise and admin provisioning

4-20 68P09278A35-B

MAR 2007

Chapter

5

OMA subscriber provisioning■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

■

■


• Adding an OMA subscriber

• Suspending an OMA subscriber

• Querying an OMA subscriber

• Replacing an OMA subscriber

• Purging an OMA subscriber

68P09278A35-B 5-1

MAR 2007

OMA subscriber provisioning Chapter 5: OMA subscriber provisioning

OMA subscriber provisioning■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Following MTAS tags are relevant to the OMA subscriber MTAS operations.

Table 5-1 OMA subscriber format

TAG Meaning M/O Expected result

<Carrier:Response> Root tag for requests Mandatory ERROR

<ReqId> String 32 Mandatory ERROR

<Source> String 32 Mandatory ERROR

<Trn type>

Transaction Type(A/Q/r/P/D)

• A: Add

• Q: Query

• r: Changerequest

• P: Purge

• D: Delete

Mandatory ERROR

<MIN> 15 digits Depends on TRN NULL

<OldMIN> 15 digits Depends on TRN NULL

<MDN> 15 digits Depends on TRN NULL

<OldMDN> 15 digits Depends on TRN NULL

<Password> String 8 Optional Password

<ExtendedParams> ExtendedParams isa var string (no sizepredefined) and is anoptional tag.

Mandatory If it is not received,then MPTT logic isexecuted

<ExtendedParams> marks start of MTAS messagerequest for OMA subscriber and is closed with<ExtendedParams> to denote the end of the message.

<Pui> String 128 Depends on TRN/Mandatory forAdd/Replace

All operations arebased on PUI.

Continued

5-2 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide OMA subscriber provisioning

Table 5-1 OMA subscriber format (Continued)

TAG Meaning M/O Expected result

<Pvi> String 128 Depends on TRN/Mandatory forAdd/Replacè

NULL

<Auth> Integer (0 or 1) Optional 0

<DigSecret> String 41 Optional NULL

<ClientType> Integer Optional 0

<AuthVisited> Integer Optional 0

68P09278A35-B 5-3

MAR 2007

Adding an OMA subscriber Chapter 5: OMA subscriber provisioning

Adding an OMA subscriber■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Add an OMA subscriber using the following XML command:

><CarrierID:Request><ReqId>000000000000001</ReqId><Source>MTASclient</Source><Version>V5x</Version><TrnType>A</TrnType><MDN>1030000001</MDN><MIN>1030000001</MIN><ExtendedParams><ClientType>4</ClientType><Pui>[email protected]</Pui><Pvi>username</Pvi></ExtendedParams></CarrierID:Request>

Response:

><CarrierID:Response><ReqId>000000000000001</ReqId>


</CarrierID:Response>

Requirement

This transaction must contain a MIN, MDN, PUI, and PVI.

Result

If... Then...

the subscriber database contains theMIN and MDN as separate entitiesin the database,

the request fails and sends an appropriate errormessage.

the MIN and MDN exists as the sameentry,

the status of the subscriber changes from suspendto active and the values of other tags are updatedin the database from the values in the message.

a mandatory tag is missing, the transaction fails and the transactionresponse contains a ReturnCode of 1 withone of the following ReturnMessages:

003: Mandatory tag <tag> is missing

004: Tag <tag> value is missing

005: Tag <tag> has NULL value

5-4 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Suspending an OMA subscriber

Suspending an OMA subscriber■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Suspend an OMA subscriber using the following XML command:

><CarrierID:Request><ReqId>000000000000001</ReqId><Source>MTASclient</Source><Version>V5x</Version><TrnType>D</TrnType><ExtendedParams><Pui>[email protected]</Pui></ExtendedParams></CarrierID:Request>

Response:




Requirement

This transaction must contain a PUI, MIN, MDN or both PUI, MIN and MDN

Result

If the subscriber is not found, or if the MIN and MDN exist in two different rows, the transactionresponse contains a ReturnCode of 0 indicating success, as the user is not an active subscriber.

68P09278A35-B 5-5

MAR 2007

Querying an OMA subscriber Chapter 5: OMA subscriber provisioning

Querying an OMA subscriber■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Query an OMA subscriber using the following XML command:

><CarrierID:Request><ReqId>000000000000001</ReqId><Source>MTASclient</Source><Version>V5x</Version><TrnType>Q</TrnType><MDN>1030000001</MDN><MIN>1030000001</MIN><ExtendedParams><Pui>[email protected]</Pui></ExtendedParams></CarrierID:Request>

Response:


<MDN>1030000001</MDN><MIN>1030000001</MIN><Pui>[email protected]</Pui>

<Pvi>1030000001</Pvi><ReturnCode>0</ReturnCode><ReturnMessage>

Subscriber exists</ReturnMessage></CarrierID:Response>

Requirement

This transaction must contain a MIN and/or an MDN.

Response

If the subscriber is suspended, for example, delete tag set, the transaction response returns aReturnCode of 2 with a ReturnMessage of 012:Subscriber does not exist due to deletetag.

5-6 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Replacing an OMA subscriber MIN/MDN

Replacing an OMA subscriber MIN/MDN■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Replace an OMA subscriber MIN/MDN using the following XML command:

><CarrierID:Request><ReqId>000000000000001</ReqId><Source>MTASclient</Source><Version>V5x</Version><TrnType>r</TrnType><OldMDN>1030000001</OldMDN><OldMIN>1030000001</OldMIN><MDN>1030000001</MDN><MIN>1030000001</MIN><ExtendedParams><ClientType>4</ClientType><Pui>[email protected]</Pui><Pvi>newuser</Pvi></ExtendedParams></CarrierID:Request>

Response:




Requirement

This transaction must contain PUI, PVI, OldMIN, OldMDN, MIN, and MDN.

Request

If... Then...

a mandatory tag is missing, the transaction fails and the transactionresponse contains a ReturnCode of 1 withone of the following ReturnMessages:

003: Mandatory tag <tag> is missing

004: Tag <tag> value is missing

005: Tag <tag> has NULL value

006: Unknown message

the MINs and MDNs does not matchand the NewMIN or NewMDN exist,

the operation fails and displays followingerror message with return code 3.206: MIN or MDN cannot be changed

Continued

68P09278A35-B 5-7

MAR 2007

Replacing an OMA subscriber MIN/MDN Chapter 5: OMA subscriber provisioning

the MINs and MDNs match, and ifthe NewMIN, or NewMDN or thePUI exist,

the operation fails and displays followingerror message with return code 3.214: SIP URI, MDN or MIN cannot bechanged

none of the tags exist, a new subscriber with NewMIN, MDN and PUIis added.

the MINs and MDNs does not matchand the NewMIN or NewMDN doesnot exist,

the NewMIN and NewMDN replaces the OldMINand OldMDN.

5-8 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Purging an OMA subscriber

Purging an OMA subscriber■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Format

Purge an OMA subscriber from the database using the following XML request:

><CarrierID:Request><ReqId>000000000000001</ReqId><Source>MTASclient</Source><Version>V5x</Version><TrnType>P</TrnType><MDN>1030000001</MDN><MIN>1030000001</MIN><ExtendedParams><Pui>[email protected]</Pui></ExtendedParams></CarrierID:Request>

Response:




Requirement

This transaction must contain a PUI and/or MIN and/or an MDN.

Result

If the subscriber is not found, or if the MIN and MDN exist in two different rows, the transactionresponse contains a ReturnCode of 0 indicating success, as the user is not in the database.

68P09278A35-B 5-9

MAR 2007

Purging an OMA subscriber Chapter 5: OMA subscriber provisioning

5-10 68P09278A35-B

MAR 2007

Chapter

6

Result format for XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

■

■

There are two types of formats for the result messages. This section details the result messagesthat are NOT enhanced.

68P09278A35-B 6-1

MAR 2007

Result format Chapter 6: Result format for XML

Result format■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The tags listed are found in responses to a transaction request.

Table 6-1 XML result format

TAG Meaning M/O Example

<Carrier:Response> Root tag Mandatory <Carrier:Response>

<ReturnCode> Return code Mandatory <ReturnCode>0 </ReturnCode>

<ReturnMessage> If successful, textmessage of Success.If unsuccessful, ErrorNumber (3 characterslong) : Text messagerepresenting thereturn code.

Mandatory• Success:

<ReturnMessage>Success<Return Message>

• Unsuccessful:<ReturnMessage>006:UnknownMessage </ReturnMessage>

<ReqId> A unique transactionID – which is the sameID sent in the request.

Mandatory <ReqId>123456787654345</ReqId>

6-2 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Message examples

Message examples■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Successful

<?xml

version=“1.0”?><Carrier:Response><ReqId>555534756255551</ReqId>

<ReturnCode>0</ReturnCode><ReturnMessage>SUCCESS


Unsuccessful

<?xml

version=“1.0“?><Carrier:Response><ReqId>555534756255551</ReqId>

<ReturnCode>1</ReturnCode><ReturnMessage>003: Mandatory tag

’<TAG>’ is missing</ReturnMessage></Carrier:Response>

See the Query MIN/MDN Transactions section for examples of query responses.

68P09278A35-B 6-3

MAR 2007

Return codes and messages Chapter 6: Result format for XML

Return codes and messages■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The following table contains the Return Codes and Messages that are available in the PoCsystem:

Table 6-2 Return codes and messages – Not enhanced

Return message Return code When returned

Success0 Any successful transaction.

001: Subscriber does not exist3 In response to query message if MIN,

MDN, or the combination does notexist in the database.

002: MIN and MDN exist inseparate rows

3 In response to a change message ifthe new MIN and MDN exist in thedatabase but in separate rows.

003: Mandatory tag %s is missing1 In response to any message which

has mandatory tags missing (such as<Source>, <RequestID>, and so on).

004: Tag %s value is missing1 In response to a message which

omits the value for a mandatory tag.

005: Tag %s has NULL value1 In response to a message which

omits the value for a mandatory tag.

006: Unknown message 1If the <TrnType> value is notsupported.

007: Both MIN and MDN tags aremissing

1 In response to messages where atleast one of MIN and MDN tags aremandatory, for example, in a querymessage, where both these tags areomitted.

008: Connection to moServer down –3 If AD connection is down.

009: Database operation failure –3If the database update operationfails.

010: Database connection down –3If the connection to the database isdown.

011: Malformed XML–1 If the incoming request contains

malformed XML.

012: Subscriber does not existdue to delete tag

2 In response to a query for asuspended subscriber.

Continued

6-4 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Return codes and messages

Table 6-2 Return codes and messages – Not enhanced (Continued)


013: Tag %s has illegal value %s1

• If MIN, MDN are not numeric

• If <Prepaid> tag does not haveone of the values from 0,1

• If <EquipmentId> is notnumeric

• If <Version> is not v4x

• If <WholesaleCustomerName>is not valid

014: Redirect <ipaddress>–2 The MTAS client uses this information

to direct subsequent operations forthis subscriber to the specified AD.

001: Enterprise Name does notExists

2 In response to query message ifEnterprise Name does not exist inthe database.

001: Enterprise Admin Namedoes not Exists

2 In response to query message ifEnterprise Admin Name does notexist in the database.

001: Enterprise Admin Namedoes not Exists

2 In response to query message ifEnterprise Admin Name does notexist in the database.

001: Old Enterprise Name doesnot Exists

2 In response to enterprise replacemessage if Old Enterprise Name doesnot exist in the database.

001: Old Enterprise Admin Namedoes not Exists

2 In response to enterprise adminreplace message if Old EnterpriseAdmin Name does not exist in thedatabase.

Enterprise Name Exists 0 In response to query messageif Enterprise Name exist in thedatabase.

Enterprise Admin Name Exists 0 In response to query message ifEnterprise Admin Name exist in thedatabase.

001:Enterprise Name AlreadyExists

2 In response to add message ifEnterprise Name exist in thedatabase.

001:Enterprise Admin NameAlready Exists

2 In response to add message ifEnterprise Admin Name exist in thedatabase.

Continued

68P09278A35-B 6-5

MAR 2007

Return codes and messages Chapter 6: Result format for XML

Table 6-2 Return codes and messages – Not enhanced (Continued)


001: Non enterprise subscribercannot be associated withAccount type

2 If in a change message or activationmessage, account type is providedfor a non-enterprise subscriber, thenthis message is thrown.

014: This operation is allowedonly on a primary AD

-2 Enterprise and admin relatedoperations like Add, delete, replacemust be allowed only on primary AD.

210: List of provisionedService Profiles

0 Successful query on Service Profiles.

211: No service profilesprovisioned

0 There are no Service Profilesprovisioned in the system.

207: PUI PVI MIN and MDN tagsare missing

1 No PUI, PVI, MIN, or MDN receivedin add/replace operations.

202: PUI, MIN, and MDN existin different rows

3 The system could not identify aunique user with the received(PUI,MIN,MDN) values.

204: PUI and MDN exist indifferent rows

3 The received request on PUI/MDNcould not be completed because thenew PUI and MDN exist.

205: PUI and MIN exist indifferent rows

3 The received request on PUI/MINcould not be completed because thenew PUI and MIN exist.

212: Service profile does notexist

3 The received Service Profile inactivation request does not exist.

213: No such AuthenticationScheme

3 The received Authentication schemeis an invalid value.

206: MIN or MDN cannot bechanged

3 MIN or MDN of an OMA subscribercannot be changed

208: ClientType <tag value>cannot have SIP URI

3 ClientTypes 0 and 1 cannot have SIPURI.

209: Enterprise admin notassociated with the

2 Enterprise admin and enterprisename are not associated

214: SIP URI, MDN, or MINcannot be changed

3 This error message is thrown forOMA subscriber operation wherechange of URI, MDN, and MIN arenot allowed.

215: Only maximum of 4 classof service values allowed foreach enterprise

3 When enterprise addition or replaceoperation is tried with requestshaving more than 4 Cos values, thismessage is thrown.

216: Duplicate Cos valueprovided

3 If the Cos/feature tag in enterpriseadd or replace operation containsthe duplicate values, this message isthrown

6-6 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Add transactions

Add transactions■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The following table summarizes expected codes and messages for add transactions.

Table 6-3 Code/Messages for add transactions


the transaction is successful, 0 Success

Mandatory tag is missing, 1003: Mandatory tag <TAG> is missing

004: Tag <TAG> value is missing

005: Tag <TAG> has NULL value

007: Both MIN and MDN tags are missing

• MIN, MDN are notnumeric,

• <Prepaid> tag does nothave one of the valuesfrom 0,1,

• <EquipmentId> is notnumeric,

• <Version> is not v4x,

• <WholesaleCustomerName>is not valid,

1013: Tag %s has illegal value %s

the Active Directory (AD) doesnot own the subscriber in amulti –AD configuration,

The <ipaddress> inthe return messageis the IP address ofthe AD which ownsthe subscriber. Usethis IP address todirect subsequentoperations for thissubscriber to thespecified AD.

–2014: Redirect <ipaddress>

0.0.0.0 in the IP address field ofthe redirect message indicates theMDN prefix is not configured asa part of wms_mdn_prefix_routingtable.

Continued

68P09278A35-B 6-7

MAR 2007

Add transactions Chapter 6: Result format for XML

Table 6-3 Code/Messages for add transactions (Continued)


• the EnterpriseName isprovided, and not definedin the system,

• the Prepaid value isprovided and not equal to0 or 1,

–3009: Database operation failure

013: Tag <EnterpriseName> has illegalvalue

6-8 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Delete Transactions

Delete Transactions■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The following table summarizes expected codes and messages for delete transactions.

Table 6-4 Code/Messages for delete transactions


The transaction wassuccessful,

0 Success

Mandatory Tag is missing, 1003: Mandatory tag <TAG> is missing







Active Directory (AD) in amulti –AD configuration doesnot own the subscriber,



‘0.0.0.0’ in the IP address field ofthe redirect message indicates theMDN prefix is not configured as apart of wms_mdn_prefix_routingtable.

68P09278A35-B 6-9

MAR 2007

Change MIN/MDN transactions Chapter 6: Result format for XML

Change MIN/MDN transactions■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The following table summarizes expected codes and messages for change MIN/MDNtransactions.

Table 6-5 Code/Messages for change MIN/MDN transactions



0Success

(MIN.MDN) exists, but astwo separate entries in thedatabase,

1002: MIN and MDN exist in separaterows











0.0.0.0 in the IP addressfield of the redirect messageindicates the MDN prefix isnot configured as a part ofwms_mdn_prefix_routing table.

• the EnterpriseName isprovided, and not definedin the system,

• the Prepaid value isprovided and not equalto 0 or 1,

–3 009: Database operation failure

6-10 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Query transactions

Query transactions■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The following table summarizes expected codes and messages for query transactions.

Table 6-6 Code/Messages for Query transactions



0 Success








queried subscriber existsin the database, but is in asuspended state

2 012: Subscriber does not exist dueto delete tag

a MIN or MDN listed in theQuery is not active,

3001: Subscriber Does Not Exist




‘0.0.0.0’ in the IP addressfield of the redirect messageindicates the MDN prefix isnot configured as a part ofwms_mdn_prefix_routing table.

68P09278A35-B 6-11

MAR 2007

Query transactions Chapter 6: Result format for XML

Successful query examples

Query Response for a standard subscriber:

<?xml


<MDN>8453650000</MDN><MIN>7022329875</MIN>

<ClassOfService>1</ClassOfService><ReturnCode>0</ReturnCode>

<ReturnMessage>Subscriber Information Exists</ReturnMessage>

</Carrier:Response>

Query Response for a prepaid subscriber:

<?xml


<MDN>8453650000</MDN><MIN>7022329875</MIN>

<ClassOfService>1</ClassOfService><ReturnCode>0</ReturnCode>

<Prepaid>1</Prepaid><ReturnMessage>Subscriber Information

Exists</ReturnMessage></Carrier:Response>

Query Response for an enterprise subscriber:

<?xml


<MDN>8453650000</MDN><MIN>7022329875</MIN>

<ClassOfService>1</ClassOfService><EnterpriseName>

XYZ Enterprises</EnterpriseName></Carrier:Response>

Unsuccessful Query Example:

<?xml


<MDN>8453650000</MDN><MIN>7022329875</MIN>

<ReturnCode>111111111</ReturnCode><ReturnMessage>Subscriber

Information Does not Exist</ReturnMessage></Carrier:Response>

6-12 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Codes and messages for syntax errors

Codes and messages for syntax errors■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Table 6-7 Expected code/messages for syntax errors


the transaction request isunsupported,

1 006: Unknown Message

the XML request is malformed, –1 011: Malformed XML

there are problems with the database, –3009: Database operation failure

010: Database connection down

MTAS Adapter is unable to sendcorresponding Provisioned XML to theManaged Object server,

Managed Object Serverconverts XML to SQL forpurposes of communicatingwith the Active Directory.

–3008: Connection to moServer down

68P09278A35-B 6-13

MAR 2007

Codes and messages for syntax errors Chapter 6: Result format for XML

6-14 68P09278A35-B

MAR 2007

Chapter

7

Enhanced result format for XML■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

■

■

There are two types of formats for the result messages. This section details the result messagesthat are enhanced.

The enhanced format allows easier and quicker identification of provisioning errors.

68P09278A35-B 7-1

MAR 2007

Provisioning Chapter 7: Enhanced result format for XML

Provisioning■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Based on the error codes required, execute scripts to configure the error codes correctly.

Procedure 7-1 Execute scripts

1 Logon to nmhost01 as swuser.

To use... Then execute script...

Enhanced Error Codes /opt/WMS/rel/scripts/configure_mtas_error_codes.shenhancedXML

2

Legacy Error Codes /opt/WMS/rel/scripts/configure_mtas_error_codes.sh legacy

7-2 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Result format

Result format■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The tags listed are found in responses to a transaction request.

Table 7-1 XML result format

TAG Meaning M/O Example

<Carrier:Response> Root tag Optional <Carrier:Response>

<ReturnCode> Return code Optional <ReturnCode>0</ReturnCode>

<ReturnMessage> If successful,text messageof Success.If unsuccessful,Error Number:Text messagerepresenting thereturn code.

Optional• Success:

<ReturnMessage>Success<Return Message>

• Unsuccessful:<ReturnMessage>10:TAG MIN hasNULL value</ReturnMessage>

<ReqId> A uniquetransaction ID– which is thesame ID sent inthe request.

Mandatory <ReqId>123456787654345</ReqId>

68P09278A35-B 7-3

MAR 2007

Message examples Chapter 7: Enhanced result format for XML

Message examples■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Successful

<?xml


<ReturnCode>0</ReturnCode><ReturnMessage>SUCCESS


Unsuccessful

<?xml


<ReturnCode>1</ReturnCode><ReturnMessage>14: Mandatory TAG MDN is

missing</ReturnMessage>

See the Query MIN/MDN Transactions section for examples of query responses.

Table 7-2 Return codes and messages – Enhanced


Success0 Any successful transaction other than

Query is successful.

Subscriber exists0 Query for a subscriber with MIN and

MDN is successful.

10: TAG MIN has NULL value–1 Any MTAS operation without providing

value for MIN tag.

11: TAG MDN has NULL value–1 Any MTAS operation without providing

value for MDN tag.

Continued

7-4 68P09278A35-B

MAR 2007


Table 7-2 Return codes and messages – Enhanced (Continued)


12: Both MIN and MDN tagshave NULL value

–1 Any MTAS operation without providingvalue for MIN and MDN tag.

13: Mandatory TAG MIN ismissing

1 Add/replace without providing MIN inthe MTAS message.

14: Mandatory TAG MDN ismissing

1 Add/replace without providing MDN inthe MTAS message.

15: Both MIN and MDN tagsare missing

1 Add/replace without providing MINand MDN in the MTAS message.

16: Class of Service fieldis empty

–1 Add/replace operation withoutproviding value for Cos tag.

17: Mandatory TAGClassOfService is missing

1 Add operation without providing Costag.

20: TAG MIN does not existand MDN exists

3 Query with MIN and MDN and MIN ispresent in the PoC database and MDNis not present.

21: TAG MDN does not existand MIN exists

3 Query/delete/purge with MIN andMDN and MDN is present in the PoCdatabase and MIN is not present.

22: Both MIN and MDN tags donot exist


23: MIN and MDN exist inseparate rows


24: MIN does not exist 3 Query/delete/purge with MIN and MINis not present in the PoC database.

25: MDN does not exist 3 Query/delete/purge with MDN andMDN is not present in the PoCdatabase.

30: Old MIN and Old MDNexist on different records

3 Performing an r operation where theOldMIN and OldMDN tags exist inseparate entries.

31: MDN – Invalid type –2 Any MTAS operation without providingacceptable value for MDN.

32: MIN – Invalid type –2 Any MTAS operation without providingacceptable value for MIN.

33: MIN – Invalid length –2 Any MTAS operation without providingacceptable length for MIN.

34: MDN – Invalid length –2 Any MTAS operation without providingacceptable length for MDN.

35: Tag MDN value is missing –1 Any MTAS operation providing valuefor MDN tag.

Continued

68P09278A35-B 7-5

MAR 2007




36: Tag MIN value is missing –1 Any MTAS operation providing valuefor MIN tag.

37: Tag Class of Servicevalue is missing

–1 Add/replace operation withoutspecifying value for Cos tag.

38: MIN does not exist andMDN tag is missing

–2 Query/delete/purge based on MIN andMIN does not exist in the PoC database.

39: MDN does exist and MINtag is missing

–2 Query/delete/purge based on MDNand MDN does not exist in the PoCdatabase.

42: Database operationfailure –3 An operation on PoC database fails.

43: Database connection down –3 Connection to PoC database isunavailable.

45: Redirect –2 MDN prefix is not configured on thelocal AD or MIN prefix is not configuredon any of the ADs.

46: Malformed XML –1 When attempting to send a badlyformed XML message to MTAS.

47: Subscriber does notexist due to delete tag

3 Querying for a subscriber who is in thesuspended state.

48: Unknown message –2 Value for the TrnType tag is not any ofA, Q, D, P or r.

49: Mandatory TAG OldMDN ismissing

1 Performing a replace operation withoutspecifying the OldMDN tag.

50: Mandatory TAG OldMIN ismissing

1 Performing a replace operation withoutspecifying the OldMIN tag.

51: Feature tag is missing1 Performing an A or r operation by

specifying the FeatureList tag and notspecifying the Feature tag.

52: Feature tag has NULLvalue

1 Performing an A or r operation byspecifying the FeatureList tag and notspecifying the value for Feature tag.

54: Subscriber does notexist

3 Performing an MTASquery/delete/purge operation byspecifying the MIN and MDN and bothare not present in the PoC database.

55: Version tag has NULLvalue

1 Performing any MTAS operation byspecifying the Version tag and notspecifying the value for it.

58: Version tag has invalidvalue

–1 Version tag does not have value v4x orv5x.

59: Prepaid tag has invalidvalue –1 Prepaid tag does not have value 1 or 0.

Continued

7-6 68P09278A35-B

MAR 2007




60: Equipment id tag hasinvalid value –1

EquipmentId tag has non numericvalue.

61: Prepaid tag has nullvalue

–1 Prepaid tag is specified withoutspecifying the value for it in r or Amessage.

62: Equipment ID tag hasnull value

–1 EquipmentID tag is specified withoutspecifying the value for it in r or Amessage.

63: Operation failed!Internal server error

–3 MTAS adapter encounters a timeout orother errors and is not able to completethe MTAS operation.

71: OLDMIN – Invalid length –1 Performing an r operation by specifyingvalue for OldMIN tag that is not ofacceptable length.

72: OLDMDN – Invalid length –1 Performing an r operation by specifyingvalue for OldMDN tag that is not ofacceptable length.

73: OLDMIN – Invalid type –1 Performing an r operation by specifyingnon numeric value for OldMIN tag.

74: OLDMDN – Invalid type –1 Performing an r operation by specifyingnon numeric value for OldMDN tag.

75: TAG OLDMDN has NULLvalue

–1 Performing an r operation withoutspecifying value for OldMDN tag.

76: TAG OLDMIN has NULLvalue

–1 Performing an r operation withoutspecifying value for OldMIN tag.

77: Enterprise name id taghas invalid value

–1 Performing an r or A operation andEnterpriseName provided in the MTASmessage is not configured in the PoCdatabase.

78: Enterprise name tag hasnull value

–1 Performing an r or A operation andEnterpriseName value is not providedin the MTAS message.

79: Wholesale customer nametag has invalid value

–1 Performing an r or A operation andWholesaleCustomerName provided inthe MTAS message is not configured inthe PoC database.

80: Wholesale customer nametag has null value

–1 Performing an r or A operation andWholsaleCustomerName value is notprovided in the MTAS message.

82: Password tag has nullvalue

–1 Performing an r or A operation withoutspecifying the value for Password tag.

83: Mandatory Tag ReqId ismissing

–1 Performing any MTAS operationwithout specifying the ReqId tag.

Continued

68P09278A35-B 7-7

MAR 2007




84: ReqId tag has NULL value –1 Performing any MTAS operationwithout specifying the value for ReqIdtag.

85: ReqID tag has invalidvalue –1

ReqId tag contains non alpha-numericvalue .

86: Mandatory Tag Sourcemissing

–1 Performing any MTAS operationwithout specifying the Source tag.

87: Source tag has NULLvalue

–1 Any MTAS operation without specifyingthe value for Source tag.

88: Mandatory Tag TrnTypemissing

–1 Any MTAS operation without specifyingthe TrnType tag.

90: TrnType tag has NULLvalue

–1 Any MTAS operation without specifyingthe value for TrnType tag.

91: ClassOfService tag hasinvalid value

–1 Class of Service specified in the MTASmessage is not configured in the PoCdatabase.

92: Feature tag has invalidvalue

–1 Feature tag has value other than I, Kor O.

93: Mandatory tag Version isMissing

1 When MTAS version is set to v4x andabove and version tag is not suppliedin the request.

Enterprise Name exists 0 When query for enterprise name issuccessful.

94: Enterprise Name does notexists

2 When query for enterprise name whichdoes not exist in database is done.

95: Tag Old Enterprise Namehas invalid value

-1 If the enterprise name present inoldEnterpriseName tag is not a validvalue

96: Tag Old Enterprise Namehas NULL value

-1 If a null value is supplied in theoldEnterpriseName tag for replacemessage

97: Enterprise Name exists 2 When query for enterprise name whichexists in database is done.

99: Old Enterprise Name doesnot exists

-1 Replace operation is tried with anon-existent oldEnterpriseName,results in this.

100: Tag Enterprise AdminName has invalid value

-1 Invalid value in EntepriseAdminNametag results in this message.

101: Tag Enterprise AdminName has NULL value

-1 Enterprise admin name having NULLvalue results in this message

103: Tag Old EnterpriseAdmin Name has invalid value

-1 Invalid value inOldEntepriseAdminName tagresults in this message.

Continued

7-8 68P09278A35-B

MAR 2007




104: Tag Old EnterpriseAdmin Name has NULL value

-1 Old Enterprise admin name havingNULL value results in this message

105: Tag Enterprise AdminPassword has invalid value

1 Invalid value inEntepriseAdminpassword tagresults in this message.

106: Tag Enterprise AdminPassword has NULL value

-1 When enterpriseAdminPassword tag issupplied with NULL value.

107: Tag New EnterpriseAdmin Password has invalidvalue

1 Invalid value inNewEntepriseAdminpasswordtag results in this message.

108: Tag New EnterpriseAdmin Password has NULL value

-1 Enterprise admin password suppliedin NewEnterpriseAdminPassword taghaving NULL value results in thismessage

Enterprise Admin Name exists 0 When query for enterprise admin nameis successful.

109: Enterprise Admin Namedoes not exists

2 Query for a non-existent enterpriseadmin name

110: Old Enterprise AdminName does not exists

2 Query for a non-existent enterpriseadmin name in oldEnterpriseName tag

111: Mandatory tagEnterprise Name is missing

1 If EnterpriseName tag is not suppliedin the request where enterprise nameis mandatory

112: Mandatory tag OldEnterprise Name is missing

1 If OldEnterpriseName tag is notsupplied in the ER request

113: Mandatory tagEnterprise Admin Name ismissing

1 If EnterpriseAdminName tag isnot supplied in the request whereenterprise admin name is mandatory

114: Mandatory tagEnterprise Admin Passwordis missing

1If EnterpriseAdminPassword tag is notsupplied in the EaA request

115: Mandatory tag OldEnterprise Admin Name ismissing

1If OldEnterpriseAdminName tag is notsupplied in the request EaR

116: Mandatory tag NewEnterprise Admin Password ismissing

1If NewEnterpriseAdminPassword tag isnot supplied in the EaM request

117: Tag New EnterpriseAdmin Password has invalidlength

-1 If password length is greater than 256in the NewEnterpriseAdminPasswordtag of EaM request

118: Tag Enterprise AdminPassword has invalid length

-1 If password length is greater than 256in the NewEnterpriseAdminPasswordtag of EaA request

Continued

68P09278A35-B 7-9

MAR 2007




119: Tag Enterprise AdminName has invalid length

-1 If enterpriseAdminName lengthis greater than 64 in theEnterpriseAdminName tag.

120: Tag Enterprise Name hasinvalid length

-1 If enterprise name length is greaterthan 64 in the EnterpriseName tag.

121: Tag Old EnterpriseAdmin Name has invalid length

-1 If enterpriseAdminName lengthis greater than 64 in theOldEnterpriseAdminName tag.

122: Tag Cos Feature hasNULL value

-1 If the class of service for enterprisesupplied in Cos tag is NULL

123: Tag Cos Feature hasinvalid value

-1 If the class of service for enterprisesupplied in Cos tag is invalid

124: Tag Enterprise Cos orFeature is missing

-1 If enterprise Cos or feature tag is notsupplied in the request.

125: PUI PVI MIN and MDNtags are missing

-1 If none of the mandatory tags areprovided during add/replace

126: Mandatory tag Pui ismissing

-1 Add/Replace operations in whichPUI is mandatory.(Depending onEnableMdnAstelUri)

127: Mandatory tag Pvi ismissing

-1 Add/Replace operations in which PVIis mandatory.

128: Tag Pui has NULL value -1 Any MTAS operation without providingvalue for PUI tag

129: Tag Pvi has NULL value -1 Any MTAS operation without providingvalue for PVI tag

130: Tag Pui value ismissing

-1 When doing any MTAS operationproviding value for PUI tag

131: Tag Pvi value ismissing

-1 When doing any MTAS operationproviding value for PVI tag

132: Tag \’Pui\’ has illegalvalue <tag Value>

-1 Any MTAS operation providing illegalvalue for PUI tag

133: Tag \’Pvi\’ has illegalvalue <tag Value>

-1 Any MTAS operation providing illegalvalue for PVI tag

134: Tag Pui has invalidlength

-1 Any MTAS operation without providingacceptable length for PUI

135: Tag Pvi has invalidlength

-1 Any MTAS operation without providingacceptable length for PVI

136: Tag \’Auth\’ hasillegal value <tag value>

-1 Any MTAS operation providing illegalvalue for Auth tag

137: Tag \’BarrInd\’ hasillegal value <tag value>

-1 Any MTAS operation providing illegalvalue for BarrInd tag

Continued

7-10 68P09278A35-B

MAR 2007




138: Tag \’AuthSchemes\’ hasillegal value <tag value>

-1 Any MTAS operation providing illegalvalue for AuthSchemes tag

139: Tag DigSecret hasinvalid length

-1 Any MTAS operation without providingacceptable length for DigSecret.

143: Tag SecretCode hasinvalid length

-1 Any MTAS operation without providingacceptable length for SecretCode.

144: PUI MIN and MDN existin different rows

3 Any MTAS operation in which a uniqueuser with the received (PUI, MIN,MDN)could not be identified.

145: No service profilesprovisioned

0 Query operation returns this messageif no service profiles are provisioned inthe system.

146: No such AuthenticationScheme

3 The received Authentication scheme isan invalid value.

147: Tag Auth value ismissing

-1 Add and Replace operations whichprovides AuthSchemes tag withoutproviding Auth tag.

148: List of provisionedService Profiles

0 Query operation returns the list ofservice profiles provisioned in thesystem

149: Tag \’Attribute\’ hasillegal value <tag value>

-1 Any MTAS operation providing illegalvalue for Attribute tag

150: Service profile doesnot exist

3 The received service profiles in Add,Replace message does not exist.

151: PUI and MIN exist indifferent rows

3 Query, Purge, Delete operations inwhich a unique user with the received(PUI, MIN) could not be identified.

152: PUI and MDN exist indifferent rows

3 Query, Purge, Delete operations inwhich a unique user with the received(PUI, MDN) could not be identified.

154: Tag AuthSchemes valueis missing

-1 Add and Replace operations whichprovides Auth tag without providingAuthSchemes tag.

155: Tag\’EnableMdnAsTelUri\’has illegal value <tag value>

-1Any MTAS operation providing illegalvalue for EnableMdnAsTelUri tag

156: Tag \’TelUriBarrInd\’has illegal value <tag value>

-1 Any MTAS operation providing illegalvalue for TelUriBarrInd tag

157: Tag SvcProfile has NULLvalue

-1 Any MTAS operation without providingvalue for SvcProfile tag

158: Tag BarrInd has NULLvalue

-1 Any MTAS operation without providingvalue for BarrInd tag

Continued

68P09278A35-B 7-11

MAR 2007




159: Tag DigSecret has NULLvalue

-1 Any MTAS operation without providingvalue for DigSecret tag

163: Tag SecretCode has NULLvalue

-1 Any MTAS operation without providingvalue for SecretCode tag

164: Tag Auth has NULL value-1 Any MTAS operation without providing

value for Auth tag

165: Tag AuthSchemes hasNULL value

-1 Any MTAS operation without providingvalue for AuthSchemes tag

166: Tag Attribute has NULLvalue

-1 Any MTAS operation without providingvalue for Attribute tag

167: Tag TelUriBarrInd hasNULL value

-1 Any MTAS operation without providingvalue for TelUriBarrInd tag

168: Tag EnableMdnAsTelUrihas NULL value

-1 Any MTAS operation without providingvalue for EnableMdnAsTelUri tag

169: Tag ClientType hasillegal value <tag value>

-1 Any MTAS operation providing illegalvalue for ClientType tag

170: Tag ClientType has NULLvalue

-1 Any MTAS operation without providingvalue for ClientType tag

171: Tag AuthVisited hasillegal value <tag value>

-1 Any MTAS operation providing illegalvalue for AuthVisited tag

172: Tag AuthVisited hasNULL value

-1 Any MTAS operation without providingvalue for AuthVisited tag

173: Enterprise Admin Exists -1 If enterprise admin name is alreadypresent in the DB and add operation onthis results in the message.

174: Tag Account type hasNULL value

-1 A or r MTAS operation withoutproviding value for Account type tag

175: Tag Account type hasinvalid value

-1 Invalid value for Account type tag in ror A message results in this message.

176: Non enterprisesubscriber cannot beassociated with the Accounttype

2 If in a change message or activationmessage, account type is provided fora non-enterprise subscriber, then thismessage is thrown.

177: This operation isallowed only on a primary AD

–2 Enterprise and admin relatedoperations like Add, delete, replacemust be allowed only on primary AD.

178: MIN or MDN cannot bechanged

3 MIN or MDN of an OMA subscribercannot be changed

179: ClientType <tag value>cannot have SIP URI

3 ClientTypes 0 and 1 cannot have SIPURI.

180: Enterprise adminnot associated with theenterprise name

2Enterprise admin and enterprise nameare not associated

Continued

7-12 68P09278A35-B

MAR 2007




181: Mandatory TagClientType is missing

1 Mandatory Tag ClientType is missingfor OMA subscriber add/replacemessage.

182: Tag Old Enterprise Namehas invalid length

-1 The EnterpriseName provided in theoldEnterpriseName tag has invalidlength

183: Tag SecretCode value ismissing

-1The SecretCode tag value is missing

184: Tag DigSecret value ismissing

-1 Add and Replace operations whichprovides Auth tag without providingDigSecret tag.

185: SIP URI, MDN or MINcannot be changed

3 This error message is thrown for OMAsubscriber operation where change ofURI, MDN, and MIN are not allowed.

186: Only maximum of 4 classof service values allowed foreach enterprise

3 When enterprise addition or replaceoperation is tried with requests havingmore than 4 Cos values, this messageis thrown.

187: Duplicate Cos valueprovided

3 If the Cos/feature tag in enterpriseadd or replace operation containsthe duplicate values, this message isthrown

188: Tag Source has invalidlength

-1 Message is seen, if invalid length of thevalue is provided in the source tag.

189: Tag ReqId has invalidlength

-1 Message is seen, if invalid length of thevalue is provided in the ReqId tag.

190: Tag SuperAdmin has NULLvalue

-1 MTAS operation without providingvalue for SuperAdmin tag.

191: Tag \’SuperAdmin\’ hasillegal value \’%s\’

-1 MTAS operation providing illegal valuefor SuperAdmin tag.

192: Tag Password hasinvalid length

-1 Message is seen, if invalid length of thevalue is provided in the Password tag.

193: Tag CosDel has NULLvalue

-1 MTAS ER operation without providingvalue for CosDel tag.

194: Tag \’CosDel\’ hasillegal value \’%s\’

-1 MTAS ER operation providing illegalvalue for CosDel tag.

196: Mandatory tagEnterpriseAdminFirstNameis missing

1Add message, if the tag is missing inEnterpriseAdmin.

197: Mandatory tagEnterpriseAdminLastNameis missing


Continued

68P09278A35-B 7-13

MAR 2007




198: Mandatory tagEnterpriseAdminEmailId ismissing


199: TagEnterpriseAdminFirstNamehas NULL value

-1Add and replace message, if the taghas null value in EnterpriseAdmin.

200: TagEnterpriseAdminLastNamehas NULL value


201: TagEnterpriseAdminEmailIdhas NULL value


202: TagEnterpriseAdminFirstNamehas illegal value %s

-1Add and replace message, if the taghas illegal value in EnterpriseAdmin.

203: TagEnterpriseAdminLastNamehas illegal value %s


204: TagEnterpriseAdminEmailIdhas illegal value %s


205: TagEnterpriseAdminFirstNamehas invalid length

-1Add and replace message, if the taghas invalid length in EnterpriseAdmin.

206: TagEnterpriseAdminLastNamehas invalid length


207: TagEnterpriseAdminEmailIdhas invalid length


208: TagOldEnterpriseAdminPasswordhas NULL value

-1Modify password message, if the taghas null value in EnterpriseAdmin.

209: Mandatory tagOldEnterpriseAdminPassword ismissing

1 In Enterprise admin password modifymessage EaM, if Old Admin passwordis not provided.

210:NewEnterpriseAdminPassword %sused previously by Admin

-1In EnterpriseAdmin modify password,if Admin already used the password.

211:OldEnterpriseAdminPassword %sdoes not match Admin Passwd

-1 In EnterpriseAdmin modify password,if password of the Admin does notmatch old password.

212: Tag MinAdminNameLengthhas illegal value %s

-1 Add and replace message, if the taghas illegal value in Enterprise.

Continued

7-14 68P09278A35-B

MAR 2007




213: Tag MinAdminNameLengthhas invalid length

-1 Add and replace message, if the taghas invalid length or is out of range inEnterprise.

214: Tag MinAdminNameLengthhas NULL value

-1 Add and replace message, if the taghas NULL value in Enterprise.

215: TagMinAdminPasswdLength hasillegal value %s

-1Add and replace message, if the taghas illegal value in Enterprise.

216: TagMinAdminPasswdLength hasinvalid length


217: TagMinAdminPasswdLength hasNULL value

-1Add and replace message, if the taghas NULL value in Enterprise.

218: TagAdminNumSavedPasswds hasillegal value %s


219: TagAdminNumSavedPasswds hasinvalid length


220: TagAdminNumSavedPasswds hasNULL value


221: TagAdminAllowdWrngPasswdAttemptshas illegal value %s


222: TagAdminAllowdWrngPasswdAttemptshas invalid length

-1Add and replace message, if the taghas invalid length in Enterprise.

223: TagAdminAllowdWrngPasswdAttemptshas NULL value


224: TagAdminAcctLockOutPeriodhas illegal value %s


225: TagAdminAcctLockOutPeriodhas invalid length


226: TagAdminAcctLockOutPeriodhas NULL value


227: TagAdminPasswdExpiryPeriodhas illegal value %s


Continued

68P09278A35-B 7-15

MAR 2007




228: TagAdminPasswdExpiryPeriodhas invalid length


229: TagAdminPasswdExpiryPeriodhas NULL value


230: TagAdminPasswdExpiryNotifyPeriodhas illegal value %s


231: TagAdminPasswdExpiryNotifyPeriodhas invalid length


232: TagAdminPasswdExpiryNotifyPeriodhas NULL value


235: Tag DBNum has NULLvalue

-1 Add and replace message, if the taghas NULL value in Enterprise.

236: Tag \’DBNum\’ hasillegal value ’%s’

-1 Add and replace message, if the taghas invalid value in Enterprise.

237: Tag DBNum has invalidlength

-1 Add and replace message, if the taghas invalid length value in Enterprise.

238: DBNum Exists -1 If DBNum exists, this message isthrown in enterprise add and replaceoperations.

239: DBNum exists -1 If DBNum exists, this message isthrown in enterprise query operation.

240: DBNum does not exists -1 If DBNum does not exist, this messageis thrown in enterprise query operation.

241: Enterprise Name andDBNum mismatch

-1 If both DBNum and EnterpriseNametags are given and they do not exist inthe same row, this message is thrown.

242: Both tags EnterpriseName and DBNum missing

-1 If both DBNum and EnterpriseNametags are not provided, this errormessage is thrown.

243: Tag Old DBNum missing -1 If DBNum is present and OldDBNumtag is missing in Enterprise replacemessage.

244: Tag Old DBNum missing 1 In Enterprise Replace operation, ifDBNum is provided and Old DBNumis missing.

245: Tag Old DBNum hasinvalid length

-1 If tag has invalid length in Enterprisereplace message.

246: Tag ‘OldDBNum’ hasillegal value ‘%s’

-1 If tag has illegal value in Enterprisereplace message.

Continued

7-16 68P09278A35-B

MAR 2007




247: Tag Old DBNum has NULLvalue

-1 If tag has NULL value in Enterprisereplace message.

248: Tags Old EnterpriseName and Old DBNum missing

-1 If both DBNum and EnterpriseNametags are not provided in Enterprisereplace operation, the error message isthrown.

249: Old DBNum does notexists

2 If OldDBNum does not exist, thismessage is thrown in enterprisereplace operation.

250: Old DBNum and OldEnterpriseName mismatch

-1 If both OldDBNum andOldEnterpriseName are given inenterprise replace operation and theydo not exist in the same row, thismessage is thrown.

251: TagAdminPasswdExpiryNotifyPeriodmust be set to 0

-1 In enterprise add andreplace operations, ifAdminPasswdExpiryPeriod is setto 0. This tag also must be set to0 indicating that the expiry andnotify feature depends on globalconfiguration.

252: TagAdminPasswdExpiryNotifyPeriodmust be set to -1

-1 In enterprise add andreplace operations, ifAdminPasswdExpiryPeriod is setto -1. This tag also must be set to -1indicating that the expiry and notifyfeature is disabled.

253: TagAdminPasswdExpiryNotifyPeriodcan take values -1, greaterthan 0 and less than tagAdminPasswdExpiryPeriod

-1 In enterprise Add andreplace operations, ifAdminPasswdExpiryPeriod areset to a value greater than 0,AdminPasswdExpiryNotifyPeriod mustbe less than AdminPasswdExpiryPeriodor it could be set to -1 indicatingnotification feature is disabled. Itcannot take the value 0, because zeroindicates that it refers to the globalconfiguration which is not allowed.

255: Enterprise admin notassociated with the DBNum

2 In EntepriseAdmin replace operations,if DBNum is not associated withEnterprise Admin.

256: Enterprise admin notassociated with EnterpriseName and DBNum

2 In EntepriseAdmin replace operationsif both DBNum and EnterpriseNameare present and are not associated withEnterpriseAdmin.

68P09278A35-B 7-17

MAR 2007

Enhanced error codes for query Chapter 7: Enhanced result format for XML

Enhanced error codes for query■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Table 7-3 Enhanced error codes for query

UniqueErrorCode

If Then ExpectedResult

SuggestedReturnCode

Suggested ReturnMessage

55 MDN does existand MIN does notexist,

it must showthe errorcorresponding tothe MIN and theassociated datawith the MDN.

Failure 20 TAG MIN does notexist and MDNexists.

56 MDN does notexist and MINdoes exist,

it must showthe errorcorresponding tothe MDN and theassociated datawith the MIN.

Failure 21 TAG MDN doesnot exist and MINexists.

58 MDN and MINexist but indifferent records,

show thecorrespondingerror and showdata for bothregisters.

Failure 23 MIN and MDNexist in separaterows.

59MDN and MIN donot exist,

show thecorrespondingerror.

Failure 22 Both MIN andMDN tags doesnot exist.

60 MIN does notexist (MDN fieldis empty in thecommand),


Failure 24 MIN does notexist.

61 MDN does notexist (MIN fieldis empty in thecommand),


Failure 25 MDN does notexist.

7-18 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Enhanced error codes when adding subscribers

Enhanced error codes when adding subscribers■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Table 7-4 Enhanced error codes for add

Uniqueerror code If Then Expected

resultSuggestedreturn code

Suggestedreturn

message

2 MIN is emptyand MDNspecified,

add operation is notcompleted.

Failure 10TAG MIN hasNULL value.

4 MDN is emptyand MINspecified,


Failure 11TAG MDN hasNULL value.

5 MIN andMDN areempty,


Failure 12 Both MIN andMDN tagshave NULLvalue.

–– MIN TAG isnot in thecommand,


Failure 13 MandatoryTAG MIN ismissing.

–– MDN TAGis not in thecommand,


Failure 14 MandatoryTAG MDN ismissing.

–– MIN andMDN TAGsare not in thecommand,


Failure 15 Both MIN andMDN tags aremissing.

–– ClassOfServiceField empty,


Failure 16 ClassOfServicefield is empty.

–– ClassOfServiceField not incommand,


Failure 17 ClassOfServicefield ismissing.

68P09278A35-B 7-19

MAR 2007

Enhanced error codes when deleting subscribers Chapter 7: Enhanced result format for XML

Enhanced error codes when deleting subscribers■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Table 7-5 Enhanced error codes for delete

Uniqueerrorcode

If Then Expectedresult

Suggestedreturn code

Suggested returnmessage

19 MIN does not existand MDN does exist,

delete operationis not completedand returnerror messageregarding theMIN.

Failure 20 TAG MIN doesnot exist andMDN exists.

20 MDN does not existand MIN does exist,

delete operationis not completedand returnerror messageregarding theMIN.

Failure 21 TAG MDN doesnot exist andMIN exists.

–– MIN and MDN donot exist,

delete operationis not completedand returnerror messageregarding theMIN and MDN.

Failure 22 Both MIN andMDN tags doesnot exist.

22 MIN and MDN existbut in different row,

delete operationis not completedand returncorrespondingerror message.

Failure 23 MIN and MDNexist in separaterows.

23, 25 MIN and MDN areempty,

delete operationis not completedand returncorrespondingerror.

Failure 12 Both MIN andMDN tags haveNULL value.MIN TAG is notin the command.

–– MIN TAG is not inthe command,


Failure 13 Mandatory TAGMIN is missing.

–– MDN TAG is not inthe command,


Failure 14 Mandatory TAGMDN is missing.

Continued

7-20 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Enhanced error codes when deleting subscribers

Table 7-5 Enhanced error codes for delete (Continued)

Uniqueerrorcode




–– MIN and MDNTAGs are not in thecommand,


Failure 15 Both MIN andMDN tags aremissing.

–– MIN does not existand MDN TAG is notin the command,


Failure 24 MIN does notexist.

–– MDN does not existand MIN TAG is notin the command,


Failure 25 MDN does notexist.

68P09278A35-B 7-21

MAR 2007

Enhanced error codes when modifying subscribers Chapter 7: Enhanced result format for XML

Enhanced error codes when modifying subscribers■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Table 7-6 Enhanced error codes for modify

Uniqueerrorcode




33 oldMIN andoldMDN do existin differentrecords.newMIN doesnot exist.oldMDN=newMDN(imsi change)

When bothMINold andMDNold existin differentrecords, thechange operationmust NOTbe completedand returncorrespondingerror message.Currently (3.0) isa success.

Failure 30 oldMIN andoldMDN existin separate rows

35 oldMIN doesnot exist,oldMDN doesexist. newMINdoes not exist.oldMDN=newMDN(imsi change)

It is expectedthat the oldMINis updated withthe newMIN,that buddy andgroup lists aremigrated andsuspend state(if applicable) iskept.

Success 0 ––

38 oldMIN andoldMDN do existin differentrecords.newMINdoes existoldMDN=newMDN(imsi change)

When both theoldMIN andoldMDN existin differentrecords, thechange operationmust NOTbe completedand returncorrespondingerror message.


Continued

7-22 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Enhanced error codes when modifying subscribers

Table 7-6 Enhanced error codes for modify (Continued)

Uniqueerrorcode




39 oldMIN andoldMDN do existin the samerecord. newMINdoes exist.oldMDN=newMDN(imsi change)

It is expectedthat (*,newMIN)was deleted,that oldMDNis updated withthe new withnewMIN, thatbuddy andgroup lists aremigrated andsuspend state(if applicable) iskept.

Success 0 ––

40 oldMIN doesnot exist,oldMDN doesexist. newMINdoes exists.oldMDN=newMDN(imsi change)

It is expected thatthe (*,newMIN)was deleted,that oldMIN isupdated withnewMIN, Thatbuddy andgroup list aremigrated andsuspend state(if applicable) iskept.

Success 0 ––

43 oldMIN andoldMDN do existin differentrecord. newMDNdoes not exist.oldMIN=newMIN(imsi change)

When both theoldMIN andoldMDN exist indifferent records,the changeoperation mustNOT completedand returncorrespondingerror message.


48 oldMIN andoldMDN exist indifferent records.newMDNdoes existoldMIN=newMIN(msisdn change)

When both theoldMIN andoldMDN exist indifferent records,the changeoperation mustNOT completeand must returncorrespondingerror message.


68P09278A35-B 7-23

MAR 2007

Invalid MIN and MDN validation for any operation/action Chapter 7: Enhanced result format for XML

Invalid MIN and MDN validation for any operation/ac-tion■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

Table 7-7 Invalid MIN and MDN validation codes




Invalid MDN type(invalid type)

Action does notexecute andreturns thecorrespondingerror message.

Failure 31 MDN – Invalidtype

Invalid MIN type Action does notexecute andreturns thecorrespondingerror message.

Failure 32 MIN – Invalidtype

Invalid MDN length Action does notexecute andreturns thecorrespondingerror message.

Failure 34 MDN – Invalidlength

Invalid MIN length Action does notexecute andreturns thecorrespondingerror message.

Failure 33 MIN – Invalidlength

7-24 68P09278A35-B

MAR 2007

PoC XML Subscriber Provisioning Guide Basic communication error codes

Basic communication error codes■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

The following events occur in the communication between the EMA v.3.1 and the provisioninginterface:

• Invalid Wait Time: Time out for the command sent.

• PoC database error

Table 7-8 Enhanced error codes for basic communication




Database operationfailure

PoC Server returnsthe correspondingerror message.

Failure 42 DatabaseOperationFailure

Database accesserror (Databaseconnection downor MTAS down)

PoC Server returnsthe correspondingerror message.

Failure 43 DatabaseConnectionDown

68P09278A35-B 7-25

MAR 2007

Basic communication error codes Chapter 7: Enhanced result format for XML

7-26 68P09278A35-B

MAR 2007

Chapter

8

Acronyms and abbreviations■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■

■

■

■

■

The following are acronyms and abbreviations found in this manual.

AD Active Directory

CPU Central Processing Unit

EMS Element Management Server

GIR Global Instant Rendezvous

GPRS General Packet Radio Service

GUI Graphical User Interface

IMSI International Mobile Station Identification

MDN Mobile Directory Number

MIN Mobile Identification Number

MSISDN Mobile Station ISDN Number

MTAS Mobile Telephony API Service

PoC Push–to–Talk over Cellular

PTT Push–to–Talk

TCP/IP Transfer Control Protocol/Internet Protocol

TL1 Transaction Language 1

XML Extensible Markup Language

68P09278A35-B 8-1

MAR 2007

Basic communication error codes Chapter 8: Acronyms and abbreviations

8-2 68P09278A35-B

MAR 2007

Appendix

A

Customized transaction formatThis appendix describes the customized transaction format for the <version> tag when the<request> tag is set to <custom>. Here <custom> refers to a customer specific variable.

Table A-1 Custom transaction format

IF: THEN...

the <request> tagcontains <custom>, • the MTAS considers the <version> tag as

optional from version v4x and above.

• for the MTAS provisioning queries, the responsealways includes the <prepaid>, <wholesale>,and <enterprise name> tags when a query ismade.

These tags are included even if theyare not configured with any specificvalue.

the <request> tagcontains <custom> andnot the <version> tag,

the MTAS does not consider it as an error.

the <request> tagdoes not contain<custom>,

• the MTAS considers the <version> tag asmandatory.

• it handles any request that does not include thistag as an error.

Configuration of the MTAS version is possible through the TL1 interface.

The Active Directory (AD) implements backward compatible implementation. Any additionaltags that are included in future releases are optional. If there is a mismatch between MTASversion of <custom> IT and AD systems, the MTAS requests are processed based on the versionsetting in the AD.

68P09278A35-B A-1

MAR 2007

A-2 68P09278A35-B

MAR 2007

Appendix

B

Enabling MTAS versions

Procedure B-1 Enabling MTAS versionsTo enable MTAS versions, perform the following steps:

1 Perform the following step at the active directory as the TL1 user to changethe MTAS version to v4x:ED-app_mtas_adapter::MTAS01:C4::mtas_version=v5x;

2 Verify the change.RTRV-app_mtas_adapter::MTAS01:C3::mtas_version;

mtas_version=v5x,

68P09278A35-B B-1

MAR 2007

B-2 68P09278A35-B

MAR 2007

*68P09278A35-B* 68P09278A35-B

Technical Information

POC XML SUBSCRIBER PROVISIONING GUIDE

POC

SOFTWARE RELEASE 6.1.X.X

US/HONG KONG, ROW

ENGLISH MAR 2007 68P09278A35-B

PO

C X

ML S

UB

SC

RIB

ER

PR

OV

ISIO

NIN

G G

UID

E

SOFTW

AR

E RELEA

SE 6.1.X.X

US

/HO

NG

KO

NG

, RO

W

ENGLISHMAR 2007

68P09278A35-B

PO

C

Standard Printing Instructions

Part Number 68P09278A35-B

Manual Title PoC XML Subscriber Provisioning Guide

Date MAR 2007

CSD/CND (US)

Binder • 3 Slant D-ring binder - letter size (11.75 in x 11.5 in) white PVC.

• Capacity depends on size of document. (no larger than 3 in).

• Clear pockets on front and spine.

Printing • Cover / spine text overprinted onto Motorola cover stock.

• Body- printed double sided onto white letter size (8.5 in x 11 in) 70 lb.

Finishing • Shrink wrap contents.

Documents

XML MTAS 68p09278a35