Beruflich Dokumente
Kultur Dokumente
68P09278A36-A
2004-2007 Motorola, Inc.
FEB 2007
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, or
from use of the information obtained herein. The information in this document has been
carefully checked and is believed to be entirely reliable. However, no responsibility is assumed for inaccuracies or omissions. Motorola, Inc. reserves the right to make changes to
any products described herein and reserves the right to revise this document and to make
changes from time to time in content hereof with no obligation to notify any person of revisions or changes. Motorola, Inc. does not assume any liability arising out of the application
or use of any product, software, or circuit described herein; neither does it convey license
under its patent rights or the rights of others.
It is possible that this publication may contain references to, or information about Motorola
products (machines and programs), programming, or services that are not announced in
your country. Such references or information must not be construed to mean that Motorola
intends to announce such Motorola products, programming, or services in your country.
Copyrights
This instruction manual, and the Motorola products described in this instruction manual may
be, include or describe copyrighted Motorola material, such as computer programs stored
in semiconductor memories or other media. Laws in the United States and other countries
preserve for Motorola and its licensors certain exclusive rights for copyrighted material, including the exclusive right to copy, reproduce in any form, distribute and make derivative
works of the copyrighted material. Accordingly, any copyrighted material of Motorola and its
licensors contained herein or in the Motorola products described in this instruction manual
may not be copied, reproduced, distributed, merged or modied in any manner without the
express written permission of Motorola. 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 of Motorola, as arises by operation 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 with
the terms of such an agreement.
Copyrighted Materials
Software and documentation are copyrighted materials. Making unauthorized copies is prohibited 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 language, 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 NOT
fault-tolerant and are NOT designed, manufactured, or intended for use as on-line control
equipment in the following hazardous environments requiring fail-safe controls: the operation of Nuclear Facilities, Aircraft Navigation or Aircraft Communication Systems, Air Trafc
Control, Life Support, or Weapons Systems (High Risk Activities). Motorola and its supplier(s) specically disclaim any expressed or implied warranty of tness for such High Risk
Activities.
Trademarks
Motorola and the Stylized M Logo are registered in the US Patent & Trademark Ofce. All
other product or service names are the property of their respective owners.
FEB 2007
Table
of
Contents
Contents
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
2
2
3
3
4
4
5
5
5
5
6
7
7
7
8
8
9
9
9
9
9
10
10
10
11
11
12
12
12
13
13
13
14
14
15
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
1-3
1-4
1-4
1-4
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
Contents
Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1-4
ii
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
contact
. . . .
. . . .
. . . .
. . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
2-2
2-2
2-3
2-4
2-5
2-6
2-8
2-8
2-9
2-10
2-10
2-11
2-11
2-12
2-14
2-14
2-14
2-15
2-16
2-18
2-18
2-18
2-19
2-20
2-21
2-21
2-22
2-24
2-24
2-25
2-26
2-26
2-26
2-28
2-28
2-29
2-29
2-30
2-32
2-32
2-32
2-32
2-33
2-33
2-34
2-34
2-35
2-35
2-36
2-36
2-37
2-38
2-38
2-39
68P09278A36-A
FEB 2007
Contents
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
2-39
2-41
2-41
2-42
2-42
2-43
2-43
2-44
2-44
2-45
2-46
2-47
2-47
2-47
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
3-2
3-3
3-5
3-6
3-7
3-7
3-8
3-9
3-9
3-9
3-10
3-10
3-11
3-11
3-11
3-12
3-12
3-12
3-13
3-13
3-14
3-14
3-16
3-16
3-16
3-17
3-17
3-18
3-18
3-18
3-19
3-19
3-20
3-20
3-21
3-21
3-21
3-22
3-22
3-23
3-25
68P09278A36-A
FEB 2007
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
iii
Contents
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
3-25
3-26
3-26
3-26
3-27
3-27
3-28
3-28
3-28
3-29
3-29
3-29
3-30
3-30
3-31
3-31
3-31
3-32
3-32
3-32
3-33
3-33
3-34
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
A-2
A-2
A-4
A-5
A-6
A-8
A-10
A-10
A-12
A-13
A-14
A-15
A-15
A-16
A-20
A-24
A-26
A-26
A-28
A-30
A-32
A-34
A-36
A-39
A-41
A-41
A-43
A-44
A-45
A-46
A-46
A-48
<ALLOW_DENY_CONTACT> . . . . . . . . . .
<OWNER_MDN> . . . . . . . . . . . . . . . .
<BUDDY_ADDITION> . . . . . . . . . . . . . .
<GROUP_ADDITION> . . . . . . . . . . . . . .
<ENTERPRISE_CONTACT_OWNERS> . . . . .
<ENTERPRISE_GROUP_OWNERS> . . . . . . .
<ENTERPRISE_CONTACT_NO_OWNERS> . . .
<ENTERPRISE_GROUP_NO_OWNERS> . . . .
<REMOVE_ENTERPRISE_CONTACT> . . . . .
<REMOVE_ENTERPRISE_GROUP> . . . . . . .
<ADD_ENTERPRISE_CONTACT> . . . . . . . .
<ADD_ENTERPRISE_GROUP> . . . . . . . . .
<UPDATE_ENTERPRISE_CONTACT> . . . . . .
<ENTERPRISE_GROUP_AVAILABLE_BUDDIES>
<ENTERPRISE_GROUP_ASSIGNED_BUDDIES>
<ADD_ENTERPRISE_GROUP_BUDDIES> . . . .
<REMOVE_ENTERPRISE_GROUP_BUDDIES> .
<ENTERPRISE_SUBSCRIBERS_LIST> . . . . .
<ENTERPRISE_MDNS_LIST> . . . . . . . . . .
<OWNERS_LIST> . . . . . . . . . . . . . . . .
<ENTERPRISE_GROUP_LIST> . . . . . . . . .
<ENTERPRISE_CONTACT_LIST> . . . . . . . .
<GET_ENTERPRISE_NAME> . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
iv
68P09278A36-A
FEB 2007
Contents
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
A-49
A-51
A-52
A-53
A-55
A-55
A-57
A-58
A-58
A-60
A-60
A-62
A-63
A-64
A-65
A-67
A-69
A-70
A-73
A-74
A-75
A-75
A-77
A-79
A-81
A-83
A-85
A-86
A-88
A-90
A-91
A-92
A-93
A-94
A-95
68P09278A36-A
FEB 2007
Contents
vi
68P09278A36-A
FEB 2007
List
of
Figures
List of Figures
68P09278A36-A
FEB 2007
1-2
vii
List of Figures
viii
68P09278A36-A
FEB 2007
List
of
Tables
List of Tables
Table
Table
Table
Table
Table
1-1:
2-1:
3-1:
3-2:
3-3:
Protocol stack . . . . . . . . . . . . . . . . . . .
Send request to active directory database values .
Manipulated objects for each request type . . . .
Encoding rules . . . . . . . . . . . . . . . . . .
Return code denitions . . . . . . . . . . . . . .
68P09278A36-A
FEB 2007
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
1-3
2-6
3-3
3-6
3-15
ix
List of Tables
68P09278A36-A
FEB 2007
About
This
Manual
This manual is intended for Push to Talk over Cellular (PoC) XML web provisioning operators,
enterprise administrators, subscribers, account team, and marketing team. To congure and
customize the PoC XML Web Provisioning, the Operators must have the basic knowledge of
HTML, XML, XSL, and text editors.
68P09278A36-A
FEB 2007
Revision history
Revision history
The following shows the status of this document since it was rst released.
Version information
Document
issue
Date of issue
FEB 2007
Remarks
Initial release
68P09278A36-A
FEB 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 the
failure of the customer, or anyone acting on the customers behalf, to abide by the
instructions, system parameters or recommendations made in this document.
Purpose
Motorola cellular communications documents are intended to instruct and assist personnel in
the operation, installation and maintenance of the Motorola cellular infrastructure equipment
and ancillary devices. It is recommended that all personnel engaged in such activities be
properly trained by Motorola.
68P09278A36-A
FEB 2007
General information
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 and
section name cross references are emphasized in blue text in electronic versions. These are
active links to the references.
This document is divided into uniquely identied and numbered chapters that, in turn, are
divided into sections. Sections are not numbered, but are individually named at the top of each
page, and are listed in the table of contents.
Text conventions
The following conventions are used in the Motorola cellular infrastructure documents to
represent keyboard input text, screen output text and special key sequences.
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.
CTRL-c
ALT-f
CR or RETURN
68P09278A36-A
FEB 2007
Contacting Motorola
Contacting Motorola
Errors
To report a documentation error, call the CNRC (Customer Network Resolution Center) and
provide the following information to enable CNRC to open an SR (Service Request):
24 hour support
If you have problems regarding the operation of your equipment, please contact the Customer
Network Resolution Center (CNRC) for immediate assistance. The 24 hour telephone numbers
are listed at https://mynetworksupport.motorola.com. Select Customer Network Resolution
Center contact information. For additional CNRC contact information, contact your Motorola
account representative.
For additional CNRC contact information, contact your Motorola account representative.
68P09278A36-A
FEB 2007
Security Advice
Security Advice
Motorola systems and equipment provide congurable security parameters to be set by the
operator based on their particular operating environment. Motorola recommends setting and
using these parameters following industry recognized security practices. Security aspects
to be considered are protecting the condentiality, integrity, and availability of information
and assets. Assets include the ability to communicate, information about the nature of the
communications, and information about the parties involved.
In certain instances Motorola makes specic recommendations regarding security practices,
however the implementation of these recommendations and nal responsibility for the security
of the system lies with the operator of the system.
Please contact the Customer Network Resolution Center (CNRC) for assistance. The 24 hour
telephone numbers are listed at https://mynetworksupport.motorola.com/. Select Customer
Network Resolution Center contact information, from the menu located to the left of the
Login box. Alternatively if you do not have access to CNRC or the internet, contact the Local
Motorola Ofce.
68P09278A36-A
FEB 2007
The following describes how warnings and cautions are used in this document and in all
documents of this Motorola document set.
Warnings
A denition and example follow below:
Denition of Warning
A warning is used to alert the reader to possible hazards that could cause loss of life, physical
injury, or ill health. This includes hazards introduced during maintenance, for example, the use
of adhesives and solvents, as well as those inherent in the equipment.
Do not look directly into ber optic cables or data in/out connectors. Laser radiation
can come from either the data in/out connectors or unterminated ber optic cables
connected to data in/out connectors.
68P09278A36-A
FEB 2007
Cautions
A denition and example follow below:
Denition of Caution
A caution means that there is a possibility of damage to systems, software or individual items of
equipment within a system. However, this presents no danger to personnel.
Do not use test equipment that is beyond its due calibration date; arrange for
calibration to be carried out.
Notes
A denition and example follow below:
Denition of Note
A note means that there is a possibility of an undesirable situation or provides additional
information to help the reader understand a topic or concept.
68P09278A36-A
FEB 2007
General Safety
General Safety
not remove equipment covers. Only Factory Authorized Service Personnel or other
qualied 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, dangerous
voltages may exist even with the power cable removed.
68P09278A36-A
FEB 2007
General Safety
10
68P09278A36-A
FEB 2007
Certain metal oxide semiconductor (MOS) devices embody in their design a thin layer of
insulation that is susceptible to damage from electrostatic charge. Such a charge applied to the
leads of the device could cause irreparable damage.
These charges can be built up on nylon overalls, by friction, by pushing the hands into high
insulation packing material or by use of ungrounded soldering irons.
MOS devices are normally dispatched from the manufacturers with the leads short-circuited
together, for example, by metal foil eyelets, wire strapping, or by inserting the leads into
conductive plastic foam. Provided the leads are short-circuited it is safe to handle the device.
Always wear a ground strap which must be connected to the electrostatic point on the
equipment.
Leave the short circuit on the leads until the last moment. It may be necessary to replace
the conductive foam by a piece of wire to enable the device to be tted.
Do not wear outer clothing made of nylon or similar man made material. A cotton overall
is preferable.
If possible work on an grounded metal surface or anti-static mat. Wipe insulated plastic
work 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 grounded
surface.
Take care when removing components connected to electrostatic sensitive devices. These
components may be providing protection to the device.
When mounted onto printed circuit boards (PCBs), MOS devices are normally less susceptible to
electrostatic damage. However PCBs should be handled with care, preferably by their edges
and not by their tracks and pins, they should be transferred directly from their packing to the
equipment (or the other way around) and never left exposed on the workbench.
68P09278A36-A
FEB 2007
11
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 using
Motorola Networks equipment in EU countries.
12
68P09278A36-A
FEB 2007
The Motorola document sets provide the information needed to operate, install, and maintain
the Motorola equipment.
68P09278A36-A
FEB 2007
13
Computer Software
The Motorola and 3rd Party supplied Software (SW) products described in this instruction
document may include copyrighted Motorola and other 3rd Party supplied computer programs
stored in semiconductor memories or other media. Laws in the United States and other
countries preserve for Motorola and other 3rd Party supplied SW certain exclusive rights for
copyrighted computer programs, including the exclusive right to copy or reproduce in any
form the copyrighted computer program. Accordingly, any copyrighted Motorola or other 3rd
Party supplied SW computer programs contained in the Motorola products described in this
instruction document may not be copied (reverse engineered) or reproduced in any manner
without 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 of
Motorola or other 3rd Party supplied SW, except for the normal non-exclusive, royalty free
license to use that arises by operation of law in the sale of a product.
Vendor
Copyright
Artesyn
CMU *
GNOME Project *
iodbc.org *
Megastep *
NIST *
openBSD *
openSSL *
Performance Technologies
Postgres *
Telelogic
QNX *
*= May contain purchased SW and Open Source SW which may be subject to a license fee.
14
68P09278A36-A
FEB 2007
Trademarks
Java Technology and/or J2ME: Java and all other Java-based marks are trademarks or
registered 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 other
countries.
68P09278A36-A
FEB 2007
15
16
68P09278A36-A
FEB 2007
Chapter
1
Overview of XML web provisioning
The PoC web server provides a TCP/IP interface for clients to access the provisioning data
stored in the Active Directory. The XML APIs help the operators and the administrators to:
Develop or customize the client web server (if the client develops a web server according
to client requirements).
68P09278A36-A
FEB 2007
1-1
Figure 1-1
ti_cn_POC_6-0_WebServerProvisioningInterface.eps
The IP network of the subscriber must be connected to the service provider network. There are
different means to connect provisioning clients to the service provider IP network.
PoC 6.1 web server does not support provisioning of buddies and groups for OMA
subscribers.
1-2
68P09278A36-A
FEB 2007
Protocol stack
Protocol stack
Application
XML
HTTP/1.1
Transport Layer
TCP
Network Layer
IPv4
Ethernet
Physical Layer
Ethernet
68P09278A36-A
1-3
FEB 2007
The provisioning client sends messages to the PoC web server, as XML documents in the
message body of HTTP POST requests. Due to the nature of HTTP/1.1, there is no clear
separation between the session and the presentation layer. Two layers of error conditions are
dened in this protocol, specically errors that pertain to the HTTP layer and the XML layer.
Provisioning services
The PoC web server advertises one type of provisioning service for client applications.
Provisioning clients must connect to the HTTP trafc port 80 to submit provisioning requests.
The PoC web server acknowledges only the provisioning requests and rejects all other messages.
Connections
The provisioning client is responsible for establishing the TCP/IP connection to the PoC web
server. The PoC web server limits the maximum number of provisioning connections that can
be opened simultaneously.
The maximum number of connections is a parameter that the operator can congure. The
PoC web server accepts simultaneous provisioning connections on its service ports. The web
server does not accept any additional connections, when the maximum number of provisioning
connections is reached. In this case, the client receives an error from TCP indicating that a new
connection cannot be established, or an HTTP response message containing the error code, 503
- Service Unavailable error code, displayed.
Authentication
During authentication, the client identies itself with the PoC web server, using a login name
and password (see section Subscriber login on page 2-10 for more details). The provisioning
client is prompted to enter the client credentials. The CSR is not authenticated within the
PoC web server.
1-4
68P09278A36-A
FEB 2007
Chapter
2
Interface procedures
The operators perform the following functions through the XML web interface:
Add a subscriber.
68P09278A36-A
FEB 2007
2-1
Initial provisioning of the AD through the web interface includes the following functions to
manage the entries for subscribers, contacts, and private talk groups.
Input
New subscriber MIN (new-MIN): This is optional. If the new-MIN is not present, new-MDN
is set to default.
Password for new subscriber: This is optional. If password is not available, the password is
generated (if SMS notication capability is enabled), or the value is set to default value (if
SMS notication capability is not enabled).
Processing
If the system does not provide a password, and if:
The following apply to the condition, where new-MDN and new- MIN are
different.
IF
THEN
Continued
2-2
68P09278A36-A
FEB 2007
Output
Output displays one of the following messages:
Success
If no password was provided and the SMS notication capability is enabled, SMS
notication containing generated password is sent to the new subscriber.
Failure
DB elements new-MDN and new-MIN exist in two separate entries.
SMS notication failure (password reset is necessary).
Invalid format for provided password (password update is necessary).
Input
Subscriber MDN
68P09278A36-A
2-3
FEB 2007
Processing
Search the Active Directory database for subscriber MDN
The following rule applies:
If the subscriber is suspended (see section Removing the subscriber on page 2-4), the request
returns a message: the subscriber is not found.
Output
Output provides either of the following messages:
Success
For successful query.
Failure
If MDN of the subscriber does not exist in the database.
Input
MDN of subscriber to remove (rem-MDN).
Processing
THEN
2-4
68P09278A36-A
FEB 2007
Output
Output provides the message, Success, as the subscriber is removed from the PoC/GIR service.
Purge subscriber
The PoC provisioning web interface allows the operator to delete a subscriber from database.
Input
MDN of subscriber to purge (purge-MDN)
Processing
Send request to Active Directory database
The following rules apply:
If the database does not contain subscriber purge-MDN, the request automatically returns
successfully.
If the database contains subscriber purge-MDN, the subscriber is deleted from the
database permanently. Moreover, the deletion removes the subscriber from the contact
and group lists of the subscribers who had this subscriber in their lists.
Output
Output contains the message, Success, as the subscriber id deleted from the database.
68P09278A36-A
2-5
FEB 2007
Input
Outdated subscriber MIN (old-MIN): (optional). If not present, old-MIN is set to old-MDN
as default.
Processing
Send request to Active Directory database.
The rules described in the Table 2-1 apply.
The terms, created and removed, used in this table, describe the existence or absence of the
(MIN, MDN) entry in the Active Directory database.
Results
Old
New
(x1, y1)
(x1, y1)
(x1, y3)
(x1, y1)
(x1, y1)
(x3, y1)
(x1, x1)
(y1, y1)
(x1, x1)
(x1, y1)
(x1, x1)
(y1, y1)
(y1,y1)
(y1, x1)
2-6
68P09278A36-A
FEB 2007
Table 2-1
Current
database
Results
Old
New
(x1, x1)
(y1, y1)
(x2, y2)
(x1, y1)
(x1, x1)
(y1, y1)
(y1, x1)
(x1, y1)
(x1, y1)
(x1, y1)
(x2, y2)
(x1, y1)
(x1, y3)
(x2, y2)
(x1, y1)
(x3, y1)
(x2, y2)
(x1, y1)
(x2, y2)
(x1, y1)
(x2, y3)
(x1, y1)
(x2, y2)
(x1, y1)
(x3, y2)
(x2, y2),
(x3, y3)
(x1, y1)
(x2, y3)
(x5, y5)
(x1, y1)
Output
Output displays one of the following messages:
Success
For successful updating.
Failure
DB elements update-MDN and update-MIN exist in two separate entries.
DB elements old-MDN and old-MIN exist in two separate entries.
68P09278A36-A
2-7
FEB 2007
2-8
68P09278A36-A
FEB 2007
68P09278A36-A
2-9
FEB 2007
Subscriber login
The PoC provisioning web interface controls access to the Active Directory database by
validating the MDN and password.
Input
Subscriber MDN
Subscriber password
Processing
Check whether the subscriber is created on the local AD. If not, retrieve the IP of the web
server corresponding to the AD, where the subscriber is created.
Query the Active Directory database for subscriber MDN; search whether the subscriber
MDN is attached to any enterprise; If found, reject the request.
Output
Output provides one of the following messages:
Success
Web server IP if subscriber is created on a foreign AD.
Successful login.
Failure
Subscriber MDN belongs to an enterprise.
Password validation failure.
2-10
68P09278A36-A
FEB 2007
Subscriber logout
The PoC provisioning web interface allows a client to log out. Logging out disconnects the
Active Directory for the subscriber.
Input
Subscriber MDN.
Processing
None.
Output
Output displays the message, Success, as the subscriber successfully logged out.
Update password
The PoC provisioning web interface allows the operator to update the password associated to
an MDN.
Input
Subscriber MDN
Processing
Validate old-passwd against the Active Directory database.
If the old-passwd is validated, validate the format of new-passwd, and update the Active
Directory database with the new-passwd for the subscriber MDN.
68P09278A36-A
2-11
FEB 2007
Output
Output displays one of the following messages:
Success
Successfully updated the password. The new password is the current password for MDN of
the subscriber.
Failure
Password validation for old password of the subscriber, failed.
Invalid format of the new password of the subscriber.
Password reset
Password Reset is accessible only when the SMS notication capability is enabled.
The PoC provisioning web interface allows the operator to reset the password associated with
an MDN. The password is randomly generated. The format of the generated password conforms
to the Password Format requirement that species a minimum length of ve characters. The
characters omitted from the generated password are:
Input
Subscriber MDN.
Processing
2-12
If no apparent SMS failures occurred, update the Active Directory database with the
generated password for the subscriber MDN.
68P09278A36-A
FEB 2007
Output
Output displays one of the following messages:
Success
For successful updating
Failure
SMS notication feature is disabled.
SMS notication failure (subscribers old password is still in effect).
68P09278A36-A
2-13
FEB 2007
The operator manages the list of contacts through the XML web provisioning interface. The
interface allows to:
Add a contact.
Input
Subscriber MDN.
Processing
Query the Active Directory database for the list of contacts.
Output
Output displays the message, Success, as the system provides a list of unique contacts for
the subscriber.
Input
2-14
Subscriber MDN
68P09278A36-A
FEB 2007
Processing
Query the Active Directory database for the list of contacts for subscriber MDN.
Search for new-MDN in the contact list for subscriber MDN; if found, reject the request.
If the list of contacts for subscriber MDN contains <max_limit> records already, reject
the request where <max_limit> is CoS based maximum contacts limit for this subscriber.
Check whether the subscriber new-MDN has blocked the subscriber MDN from adding to
the contact list; if yes, reject the request.
Check whether the subscriber new-MDN has opted to receive notication messages.
Update the Active Directory database with new contact for subscriber MDN.
Output
Output displays one of the following messages:
Success
Successfully added the contact to the subscriber list.
Failure
Attempting to add self to the contact list.
Subscriber new-MDN not a valid PoC subscriber.
Invalid format for new-name.
MDN: new-MDN exists.
CoS based maximum contacts limit reached.
Subscriber new-MDN has blocked subscriber MDN from adding as a buddy.
68P09278A36-A
2-15
FEB 2007
Input
Subscriber MDN
Processing
If old-MDN and update-MDN are different, validate update-MDN as being a valid PoC
subscriber, and validate that the update-MDN is not the same as subscriber MDN.
Update the Active Directory database for all groups created by subscriber MDN that
contains that contact (MDN=old-MDN) to the updated information (for example,
MDN=update-MDN).
Output
Output displays one of the following messages:
Success
Successfully updated the contact name and MDN.
Failure
Contact that needs updating does not exist
Invalid format for contact name update-name
Attempting to add self to contact list by modifying existing contact
Subscriber update-MDN not a valid PoC subscriber
2-16
68P09278A36-A
FEB 2007
Input
Subscriber MDN
Processing
Update the Active Directory database for subscriber MDN by deleting contact with MDN
equals del-MDN.
Update the Active Directory database for all groups created by the subscriber MDN that
contains the specic contact to be deleted (whose MDN equals del-MDN).
Output
Output displays the message, Success, as the system removed the contact from the contact list.
68P09278A36-A
2-17
FEB 2007
The operator manages the Private Talk Groups through the XML web provisioning interface.
The interface allows to:
Input
Subscriber MDN
Processing
Query the Active Directory database for all groups created by subscriber MDN.
Output
Output displays the message, Success, as the system provides the list of Private Talk Group for
the subscriber.
2-18
68P09278A36-A
FEB 2007
Input
Subscriber MDN
Processing
Query the Active Directory database for all groups created by subscriber MDN.
Search for group new-name in the group list; if found, reject the request.
If the list of groups for subscriber MDN contains <max_limit> records already, reject the
request, where <max_limit> is CoS based maximum groups limit for this subscriber.
Update the Active Directory database with new Private Talk Group new-name for
subscriber MDN.
Output
Output displays one of the following messages:
Success
Successfully created a Private Talk Group
Failure
Invalid format of the Private Talk group new-name.
Private Talk group new-name exists.
CoS based maximum groups limit reached.
Input
Subscriber MDN
68P09278A36-A
2-19
FEB 2007
Processing
Query the Active Directory database for group old-name created by subscriber MDN.
Query the Active Directory database for group update-name created by subscriber MDN.
Update the Active Directory database for subscriber MDN Private Talk Group old-name
with update-name.
Output
Output displays one of the following messages:
Success
Successfully updated Private Talk Group name.
Failure
Private Talk Group old-name does not exist.
Invalid format for Private Talk Group update-name.
Private Talk Group update-name exists.
Input
Subscriber MDN
Processing
Update the Active Directory database by deleting group del-name created by subscriber MDN.
Output
Output displays the message, Success, as the system removed Private Talk Group from the
Private Talk Group list.
2-20
68P09278A36-A
FEB 2007
Input
Subscriber MDN
Processing
Query the Active Directory database for group sel-name created by subscriber MDN.
Output
Output displays one of the following messages:
Success
List of unique contacts for Private Talk Group (sel- name) created by subscriber MDN.
Failure
Private Talk Group sel-name does not exist.
Input
Subscriber MDN
MDNs of all PoC subscribers to add to Private Talk Group (list of new- MDN)
68P09278A36-A
2-21
FEB 2007
Processing
For each new-MDN:
Query the Active Directory database for group sel-name created by subscriber MDN.
Query the selected group for PoC subscriber new-MDN; if found, reject the request.
If selected group contains <max_limit> contacts already, reject the request, where
<max_limit> is CoS based maximum group size (members in group).
Check whether the subscriber new-MDN has opted to receive notication messages.
Whenever the subscriber is added as a buddy or a member in a group, update the Active
Directory database with appropriate notication message.
Update the Active Directory database by appending new-MDN to group sel-name created
by subscriber MDN.
Check whether the subscriber new-MDN has blocked the subscriber MDN from adding to
group members list; if yes, reject the request.
Output
Output displays one of the following messages:
Success
Successfully added the entire list of new-MDNs.
Failure
Possible errors for adding each new-MDN:
Attempting to add self to contact list
Subscriber new-MDN not a valid PoC subscriber
Private Talk Group sel-name does not exist
Subscriber new-MDN already in Private Talk Group sel-name
Private Talk Group reached its CoS based maximum size (members in group)
Subscriber new-MDN has blocked subscriber MDN from adding as group member
2-22
68P09278A36-A
FEB 2007
Input
Subscriber MDN
MDNs of all PoC subscribers to remove from Private Talk Group (list of rem-MDN)
Processing
Query the Active Directory database for group sel-name created by subscriber MDN.
For each rem-MDN, update the Active Directory database by removing {rem-MDN} from the
record of group sel-name created by subscriber MDN.
Output
Output displays one of the following messages:
Success
Successfully removed the PoC subscriber from the Private Talk Group.
Failure
Private Talk Group sel-name does not exist.
68P09278A36-A
2-23
FEB 2007
The operator manages the subscriber preferences through the XML web provisioning interface.
The interface allows the operator to query and update the preference settings.
Query preferences
The PoC provisioning web interface displays the settings for the subscriber preferences.
The subscriber preferences are:
Presence Privacy
Caller ID Blocking
Receive Notication
Each one carries two values: on or off. The subscriber sets the value, and for a new subscriber,
the value is set to default (off).
Input
Subscriber MDN
Processing
Query the Active Directory database for the preference settings of a subscriber.
Extract the rst bit of the Option settings, as the value for the Presence Privacy is 1: On and
0: Off.
Extract the second bit of the Option settings, as the value for the Caller ID Blocking is 1: On,
0: Off.
Query the Active Directory database for the receive notication settings of a subscriber.
The value (t or f) of the Option setting provides the value for the Receive Notication: t - on, f
- off.
2-24
68P09278A36-A
FEB 2007
Output
Output contains the message:
Success
Successfully displays the settings for the subscriber preferences:
Receive Noticationon/off
Update preferences
The PoC provisioning web interface updates the subscriber preferences (Presence Privacy,
Caller ID Blocking, and Receive Notication) in the Active Directory database to the value
set by a subscriber.
Input
Subscriber MDN
Processing
Construct a value by combining the preferences - Presence Privacy and Caller ID Blocking.
The rst bit of the value represents the Presence Privacy preference: on -> 1, off -> 0
The second bit of the value represents the Caller ID Blocking preference: on -> 1, off -> 0
Output
Output displays the message, Success, as the system successfully updates the subscriber
preferences.
68P09278A36-A
2-25
FEB 2007
The operator manages the settings of the Allow/Block mode settings of a subscriber through
the XML web provisioning interface. The interface allows the operator to query and update
the settings.
Input
Subscriber MDN
Processing
Query the Active Directory database for the Allow/Block Mode settings of a subscriber.
The values of Allow/Block mode settings are interpreted as:
Allow: allows all subscribers to add current subscriber as their contact and member in
the group.
Block: blocks all subscribers from adding current subscriber as their contact and member
in the group.
Allow: allows all subscribers to add current subscriber as their contact and member in the
group, but excludes the subscribers listed in the Block Contact List.
Block: blocks all subscribers from adding current subscriber as their contact and member
in the group, but excludes the subscribers listed in the Allow Contact List.
Output
Output displays the message, Success, as the system displays the Allow/Block mode settings of
the subscriber.
2-26
68P09278A36-A
FEB 2007
Input
Subscriber MDN
Processing
Construct a value based on the Allow/Block mode:
Allow Mode - 1
Block Mode - 2
Exclude Mode - 3.
Update the Active Directory database with the values of the Allow/Block mode settings of a
subscriber.
Output
Output displays the message, Success, as the system updates the subscriber Allow/Block mode
settings in the Active Directory database.
68P09278A36-A
2-27
FEB 2007
The operator manages the list of allowed or blocked contacts for a subscriber, through the XML
web provisioning interface. The interface allows to:
Input
Subscriber MDN
Processing
2-28
Update the Active Directory database with the contact added to the Allow/Block Contact
List.
68P09278A36-A
FEB 2007
Output
Output displays one of the following messages:
Success
Successfully added the contact to Allow/Block list.
Failure
Attempting to add self to allow/block list
Subscriber new-MDN not a valid PoC subscriber
Invalid format for new-name
MDN new-MDN exists in allow/block list
Input
Subscriber MDN
Processing
Query the Active Directory database for the Allow/Block list of contacts based on the Allow/Block
mode setting of the subscriber.
Output
Output displays the message, Success, as the system lists the allowed and blocked contacts for
the subscriber.
68P09278A36-A
2-29
FEB 2007
Input
Subscriber MDN.
Processing
Output
Output displays one of the following messages:
Success
Updated the contact in Allow/Block list.
Failure
Invalid format for the new contact name.
Input
Subscriber MDN
Processing
Update the Active Directory database for subscriber MDN by deleting contact in allow/block list
with MDN equals del-MDN.
2-30
68P09278A36-A
FEB 2007
Output
Output displays the message, Success, as the system removed the contact from the Allow/Block
list.
68P09278A36-A
2-31
FEB 2007
The PoC provisioning web interface provides the list of notication messages for a specic
PoC subscriber.
Input
Subscriber MDN
Processing
Query the Active Directory database for the list of notication messages.
Output
Output displays the message, Success, as the system lists the notication messages for the
subscriber.
2-32
68P09278A36-A
FEB 2007
Input
Processing
Check whether the enterprise is homed on local AD. If the enterprise is not homed, retrieve
the IP of the web server corresponding to the AD, where the enterprise is created.
Output
Output displays one of the following messages:
Success
Web server IP if enterprise is homed on a foreign AD
Successful login for the Enterprise web administrator.
Failure
Administrator name is not a valid Enterprise user.
Password validation failure.
68P09278A36-A
2-33
FEB 2007
Input
None.
Processing
None.
Output
Output displays the message, Success, as the enterprise web administrator successfully logs out
of the system.
Input
Web administrator name
Processing
Check whether the enterprise is homed on the local AD, if not, retrieve the IP address of
the web server corresponding to the AD, where the enterprise is created.
Output
Output displays one of the following messages:
Success
Web server IP address, if enterprise is homed on a foreign AD.
Enterprise name for the specied web administrator.
Failure
Administrator name is not a valid enterprise user name.
2-34
68P09278A36-A
FEB 2007
Input
Processing
If old-passwd is validated, validate the format of the new-passwd, and update the Active
Directory database with it for the enterprise web administrator name.
Output
Output displays one of the following messages:
Success
The new password of the web administrator is the current password for web administrator
name.
Failure
Password validation for web administrator old password failure
Invalid format for web administrator new password
Input
None.
Processing
Query the Active Directory database for the list of subscribers.
68P09278A36-A
2-35
FEB 2007
Output
Output displays the message, Success, as the system displays the list of subscribers for the
enterprise.
Input
None.
Processing
Query the Active Directory database for the list of contacts.
Output
Output displays the message, Success, as the system displays list of contacts for the enterprise.
Input
2-36
68P09278A36-A
FEB 2007
Processing
Query the Active Directory database for the list of owners for contact new-MDN.
If any of the existing owners are already there in the contact list, reject the request.
If any of the owners have reached their CoS based maximum contacts limit, reject the
request for those owners.
If the contact MDN is outside the enterprise, reject the request for owners whose CoS
parameter, is_open_enterprise, is set to False.
Update the Active Directory database with the new contact for enterprise.
Output
Output displays one of the following messages:
Success
Added a contact to the enterprise, or added owners for an existing enterprise contact.
Failure
Attempting to add contact new-MDN to owners list.
Subscriber new-MDN not a valid PoC subscriber.
Invalid format for new-name.
One or more owners have reached their CoS based maximum contacts limit.
Input
Contact name
Contact MDN
Processing
Query the Active Directory database for the list of owners.
68P09278A36-A
2-37
FEB 2007
Output
Output displays the message, Success, as the system displays the list of owners for the contact
in the enterprise.
Input
Contact name
Contact MDN
Processing
Query the Active Directory database for the list of non-owners.
Output
Output displays the message, Success, as the system lists the non-owners for the contact in
the enterprise.
The operator can update only the contact name in an enterprise and cannot update
the MDN of the contact.
Input
2-38
Contact MDN
68P09278A36-A
FEB 2007
Processing
Update the Active Directory database for all owners of the contact with MDN by value
name=update-name.
Output
Output displays one of the following messages:
Success
Updated the name of the contact in the contact list of the enterprise.
Failure
Invalid format for contact name update-name.
New contact name exists.
Input
Processing
Update the Active Directory database for owner-MDNs by deleting contact with MDN equals
ct-MDN.
Output
Output displays the message, Success, as the system removed the owners of the enterprise
contact.
68P09278A36-A
2-39
FEB 2007
Input
Processing
Update the Active Directory database for all contact owners by deleting the contact with
MDN equals del-MDN.
Update the Active Directory database for all groups created by contact owners that contain
the specic contact to be deleted (whose MDN equals del-MDN).
Output
Output displays the message, Success, as the system removed the contact from the enterprise.
2-40
68P09278A36-A
FEB 2007
Managing groups
Managing groups
The administrator manages the groups through the XML web provisioning interface. The
interface allows to:
Add a Shared Talk Group to an enterprise or add owners for an existing enterprise group.
Input
None.
Processing
Query the Active Directory database for the list of Shared Talk Groups for the specied
enterprise.
Output
Output displays the message, Success, as the system lists the Shared Talk Groups for the
enterprise.
68P09278A36-A
2-41
FEB 2007
Managing groups
Input
Processing
Query the Active Directory database for all groups created by specied enterprise.
If Shared Talk Group (new-name) is created already, query the Active Directory database
for the list of owners of Shared Talk Group (new- name).
If any of the existing owners are already present in the owners list, reject the request.
If any of the owners have reached the CoS based maximum groups limit, reject the request
for those owners.
Update the Active Directory database with the new group for enterprise.
Output
Output displays one of the following messages:
Success
Added a Shared Talk Group to an enterprise, or added owners for an existing enterprise
group.
Failure
Subscriber owner-MDN not a valid PoC subscriber
Invalid format for new-name
One or more owners have reached their CoS based maximum groups limit
2-42
68P09278A36-A
FEB 2007
Managing groups
Input
Processing
Update the Active Directory database for all owners of the enterprise group with the
update-name by value name=update-name.
Output
Output displays one of the following messages:
Success
Updated the name of the enterprise Shared Talk Group.
Failure
Invalid format of the new group name.
Input
Private Talk Group name (sel-name)
Processing
Query the Active Directory database for the list of owners of enterprise group (sel-name).
Output
Output displays the message, Success, as the system displays the list of unique owners for
the enterprise group.
68P09278A36-A
2-43
FEB 2007
Managing groups
Input
Shared Talk Group name (sel-name).
Processing
Query the Active Directory database for the list of non-owners for enterprise group (sel-name).
Output
Output displays the message, Success, as the system displays the list of unique non-owners
for the enterprise group.
Input
Name of the selected enterprise Shared Talk Group (sel-name).
Processing
Output
Output displays one of the following messages:
Success
Displays the list of unique contacts for enterprise Shared Talk Group sel-name.
Failure
Enterprise Shared Talk Group sel-name does not exist.
2-44
68P09278A36-A
FEB 2007
Managing groups
Input
Name of selected enterprise Shared Talk Group (sel-name).
Processing
Query the Active Directory database for all the buddies in the specied enterprise group, except
the buddies who are already assigned to the enterprise group with the group sel-name.
Output
Output displays one of the following messages:
Success
Lists the available unique contacts, who can be associated with Shared Talk Group
sel-name.
Failure
Enterprise Shared Talk Group sel-name does not exist.
Input
MDNs of all enterprise PoC subscribers to add to enterprise Private Talk Group (list
of new-MDN)
Processing
If any of the owners of this group reaches the CoS based group size limit (members in group),
reject the request.
For each new-MDN:
Update the Active Directory database by appending new-MDN to the enterprise group
selname.
68P09278A36-A
2-45
FEB 2007
Managing groups
Output
Output displays one of the following messages:
Success
Successfully added the contacts (members) to the enterprise group.
Failure
Subscriber new-MDN not a valid enterprise PoC subscriber
Enterprise Private Talk Group sel-name does not exist
Subscriber new-MDN already in enterprise Private Talk Group sel-name
One or more owners of the Shared Talk Group reached their CoS based group size
limit (members in group)
Input
MDNs of all enterprise PoC subscribers to remove from enterprise Private Talk Group
(list of rem-MDN).
Processing
Query the Active Directory database for group sel-name created with enterprise PoC
subscribers as owners.
For each rem-MDN, update the Active Directory database by removing {rem-MDN} from the
record of group sel-name and owners of the group belonging to the specied enterprise.
Output
Output displays one of the following messages:
Success
Removed the contacts (members) from the enterprise group.
Failure
Enterprise Private Talk Group sel-name does not exist.
2-46
68P09278A36-A
FEB 2007
Managing groups
Input
Processing
Update the Active Directory database by deleting enterprise group (grp- name) created for
owners with MDN equals owner-MDNs.
Output
Output displays the message, Success, as the system removes the existing owner of the
enterprise Private Talk Group.
Input
Name of enterprise Private Talk Group to delete (del-name).
Processing
Update the Active Directory database by deleting the enterprise group del-name created for the
specied enterprise.
Output
Output displays the message, Success, as the system deletes the enterprise Private Talk Group
from the Private Talk Group list of the enterprise.
68P09278A36-A
2-47
FEB 2007
Managing groups
Input
None.
Processing
Query the Active Directory database for the list of MDNs.
Output
Output displays the message, Success, as the system lists the subscriber MDNs for the
enterprise.
2-48
68P09278A36-A
FEB 2007
Chapter
3
Message denitions
The provisioning interface provides messages to add, modify, delete, and query the provisioning
data in a single transaction. Provisioning data is grouped into objects, where the data specify
the objects properties.
There are three types of provisioning objects:
Contact
Name
MDN
Subscriber
MDN
MIN
Password
Contact ListContact
Private Talk Group ListPrivate Talk Group
Preferences
Presence Privacy
Caller ID Blocking
68P09278A36-A
FEB 2007
3-1
All provisioning messages are XML v1.0 documents. The format of the provisioning request and
response messages are dened using XML Document Type Denitions (DTDs).
A DTD species a set of rules for the format of an XML document. Each PoC provisioning
command and response message includes a reference to an associated DTD when encoded in
XML. The included DTD reference is represented as a relative URI (DTD name only) to allow
different clients and servers to store DTDs locally in differing locations.
When receiving a PoC provisioning XML document, the recipient must resolve the relative URI
to a location, where the DTD is located within the recipients application context.
The relative URI resolves to a fully qualied path name of where the DTD is stored within the
local le system, an external URL reference, or an internal DTD cache reference.
The storage of PoC provisioning DTDs and resolution of their location is implementation specic.
DTD URI resolution must occur before XML parsing and validation. Most XML parsers does
not allow a relative URI DTD reference, if it cannot be resolved to an absolute URI within the
context of the parsing application.
3-2
68P09278A36-A
FEB 2007
Provisioning messages
Provisioning messages
Add
Delete
Update
Query
Login
Logout
Reset
Each type of request is applied to different objects. See Table 3-1 for a cross reference of
request and object types.
Table 3-1
Request type
Add
Subscriber
Subscriber > Private Talk Group List > Private Talk Group
Subscriber > Private Talk Group List > Private Talk Group > Private
Talk Group Member
Subscriber
Subscriber > Private Talk Group List > Private Talk Group
Subscriber > Private Talk Group List > Private Talk Group > Private
Talk Group Member
Delete
Continued
68P09278A36-A
3-3
FEB 2007
Provisioning messages
Table 3-1
Request type
Update
Subscriber > Private Talk Group List > Private Talk Group
Subscriber > Private Talk Group List > Private Talk Group > Private
Talk Group Member
Subscriber
Subscriber > Private Talk Group List > Private Talk Group
Query
3-4
Login
Subscriber
Logout
Subscriber
Reset
Subscriber
68P09278A36-A
FEB 2007
Character set
Character set
The character set used is UTF-8, which is a compressed version of Unicode that uses a single
byte for the ASCII 0-127 characters. A plain ASCII string is also a valid UTF-8 string.
UTF-8 is the default character set in XML specications.
68P09278A36-A
3-5
FEB 2007
Encoding rules
Encoding rules
Data contained in an XML element is typically parsed character data (#PCDATA in XML
notation). The following BNF species the encoding rules that are used to express the format of
data contained in the XML elements. The BNF is taken from RFC822.
Table 3-2
Encoding rules
Rule name
3-6
Character set
Alphabet
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z.
A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z.
Digit
0, 1, 2, 3, 4, 5, 6, 7, 8, 9.
hex
0, 1, 2, 3, 4, 5, 6, 7, 8, 9
digits, alphabets, / , / : / ; / . / ( / ) / - / + / / / ! /
/ # / $ / &%rdquo; / * / = / ? / @ / \ / ^ / _ /
/ { / } / | / ~ /
letterstring
numericstring
Tid
MDN
1to 10 digits
MIN
1 to 10 digits
NAME
PASSWD
OLD_MDN
MDN
OLD_MIN
MIN
OLD_NAME
NAME
OLD_PASSWD
PASSWD
CSR
68P09278A36-A
FEB 2007
This section lists each element dened in the PTT_Request DTD. The attributes, child elements,
and character data are described for all elements.
For examples of all types of PTT_Requests, see Appendix A XML samples.
<PTT_REQUEST>
<!ELEMENT PTT_REQUEST (CSR?, ADMIN?, SUBSCRIBER)>
<!ATTLIST PTT_REQUEST
tid CDATA #REQUIRED
action (Add | Delete | Update | Query | Login |
Logout | Reset | PURGE) #REQUIRED
Attributes
tid: Each provisioning request has a transaction identier, tid, as a required XML attribute.
The provisioning client must generate a unique tid for each request. The PoC provisioning
web interface returns the same tid in response to the request.
A transaction identier is a maximum 16-character string. The encoding of a tid is dened
in Encoding Rules.
action: Must always be set to Add, Delete, Update, Query, Login, Logout, Reset, or Purge.
Child elements
<SUBSCRIBER>: Mandatory.
<CSR>: Optional. For logging purposes, the CSR name is sent with each request that
a CSR makes on behalf of the subscriber.
Character data
None.
68P09278A36-A
3-7
FEB 2007
<SUBSCRIBER>
<!ELEMENT SUBSCRIBER (MDN, MIN?, OLD_MDN?,
OLD_MIN?, PASSWD?, OLD_PASSWD?,
CONTACT_LIST?, GROUP_LIST?,
PREFERENCES?, PREFERENCES2?,
BLOCKING_EXCLUSION_LIST?,
BLOCKING_EXCLUSION_CONTACT_LIST?,
NOTIFICATION_MESSAGE_LIST?)>
Attributes
None.
Child elements
<MDN>: Mandatory.
Character data
None.
3-8
68P09278A36-A
FEB 2007
<CSR>
<!ELEMENT CSR (NAME)>
Attributes
None.
Child elements
<NAME>: mandatory.
Character data
None.
<GROUP_LIST>
<!ELEMENT GROUP_LIST (GROUP*)>
Attributes
None.
Child elements
<GROUP>: 0 or more, depends on the PTT request action attribute.
Character data
None.
<CONTACT_LIST>
<!ELEMENT CONTACT_LIST (CONTACT*)>
Attributes
None.
Child elements
<CONTACT_LIST>: 0 or more, depends on the PTT request action attribute.
68P09278A36-A
3-9
FEB 2007
Character data
None.
<CONTACT>
<!ELEMENT CONTACT (NAME, MDN, OLD_NAME?,
OLD_MDN?)>
Attributes
None.
Child elements
<NAME>: Mandatory.
<MDN>: Mandatory.
Character data
None.
<GROUP>
<!ELEMENT GROUP (NAME, OLD_NAME?,
GROUP_MEMBER_LIST*)>
Attributes
<NAME>: mandatory
Child elements
None.
3-10
68P09278A36-A
FEB 2007
Character data
None.
<GROUP_MEMBER_LIST>
<!ELEMENT GROUP_MEMBER_LIST (MDN*)>
Attributes
None.
Child elements
<MDN>:0 or more depends on the PTT request action attribute.
Character data
None.
<MDN>
<!ELEMENT MDN (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
One to 10 digits, the encoding of an MDN is dened in the Encoding Rules.
<MIN>
<!ELEMENT MIN (#PCDATA)>
Attributes
None.
68P09278A36-A
3-11
FEB 2007
Child elements
None.
Character data
One to 10 digits. The encoding of an MIN is dened in the Encoding Rules.
<NAME>
<!ELEMENT NAME (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
One to 16 printable characters. The encoding of a NAME is dened in the Encoding Rules.
<OLD_MDN>
<!ELEMENT OLD_MDN (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
One to 10 digits. The encoding of an OLD_MDN is dened in the Encoding Rules.
<OLD_NAME>
<!ELEMENT OLD_NAME (#PCDATA)>
3-12
68P09278A36-A
FEB 2007
Attributes
None.
Child elements
None.
Character data
One to 10 digits. The encoding of an OLD_NAME is dened in the Encoding Rules.
<PASSWD>
<!ELEMENT PASSWD (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
Zero to 16 printable characters. The encoding of a PASSWD is dened in the Encoding Rules.
<OLD_PASSWD>
<!ELEMENT OLD_PASSWD (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
Zero to 16 printable characters. The encoding of an OLD_PASSWD is dened in the Encoding
Rules.
68P09278A36-A
3-13
FEB 2007
<PTT_RESPONSE>
<!ELEMENT PTT_RESPONSE (RETURN_CODE,
SUBSCRIBER?)>
<!ATTLIST PTT_RESPONSE
tid CDATA #REQUIRED
action (Add | Delete | Update | Query | Login |
Logout | Reset) #REQUIRED>
Attributes
tid: the PoC provisioning web interface returns the same tid in the response as the one
specied in the request. A transaction identier is a maximum 16 characters long string.
The encoding of a tid is dened in the Encoding Rules.
action: must always be set to Add, Delete, Update, Query, Login, Logout, or Reset.
Child elements
<SUBSCRIBER>: optional. Depends on the PTT Response action attribute.
Character data
None.
<RETURN_CODE>
<!ELEMENT RETURN_CODE (SUCCESS
| INVALID_XML_FORMAT
| ACTIVE_DIRECTORY_UNAVAILABLE
| ATTEMPTING_TO_ADD_SELF
| INVALID_NAME_FORMAT
| MAX_SIZE_REACHED
| ALREADY_EXISTS
| ENTRY_NOT_FOUND
| MIN_MDN_MISMATCH
| LOGIN_FAILURE
| PASSWORD_MODIFICATION_FAILURE
| UNKNOWN_ERROR
| ERROR_MESSAGE)+>
3-14
68P09278A36-A
FEB 2007
Attributes
None.
Child elements
Table 3-3
Character set
<SUCCESS>
<INVALID_XML_FORMAT>
The format of the PTT request does not satisfy the DTD.
<ACTIVE_DIRECTORY_UNAVAILABLE>
<ATTEMPTING_TO_ADD_SELF>
<INVALID_NAME_FORMAT>
<NAME>
<MAX_SIZE_REACHED>
<LIMIT>
<ENTRY_NOT_ADDED>
<ALREADY_EXISTS>
<GROUP> or
<CONTACT> or
<MDN>
<ENTRY_NOT_FOUND>
<SUBSCRIBER> or
<GROUP> or
<CONTACT> or
<MDN>
<MIN_MDN_MISMATCH>
The MIN and MDN are two separate entries in the Active
Directory database.
<LOGIN_FAILURE>
<PASSWORD_MODIFICATION_ FAILURE>
<UNKNOWN_ERROR>
<ERROR_MESSAGE>
68P09278A36-A
3-15
FEB 2007
Character data
None.
<PREFERENCES>
<!ELEMENT PREFERENCES (PRESENCE_PRIVACY?,
CALLERID_BLOCKING?)>
Attributes
None.
Child elements
Character data
None.
<PRESENCE_PRIVACY>
<!ELEMENT PRESENCE_PRIVACY (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
Two types: on and off.
<CALLERID_BLOCKING>
<!ELEMENT CALLERID_BLOCKING (#PCDATA)>
3-16
68P09278A36-A
FEB 2007
Attributes
None.
Child elements
None.
Character data
Two types: on and off.
<PREFERENCES2>
<!ELEMENT PREFERENCES2 (RECEIVE_NOTIFICATION?)>
Attributes
None.
Child elements
<RECEIVE_NOTIFICATION>: optional. Depends on the PTT request action attribute.
Character data
None.
<RECEIVE_NOTIFICATION>
<!ELEMENT RECEIVE_NOTIFICATION (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
Two types: on and off.
68P09278A36-A
3-17
FEB 2007
<BLOCKING_EXCLUSION_LIST>
<!ELEMENT BLOCKING_EXCLUSION_LIST
(BLOCKING_EXCLUSION_LIST_MODE?)>
Attributes
None.
Child elements
<BLOCKING_EXCLUSION_LIST_MODE>: optional. Depends on the PTT request action
attribute.
Character data
None.
<BLOCKING_EXCLUSION_LIST_MODE>
<!ELEMENT BLOCKING_EXCLUSION_LIST_MODE (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
ALLOW, BLOCK, and EXCLUDE.
<ERROR_MESSAGE>
<!ELEMENT ERROR_MESSAGE (MSG)>
Attributes
None.
3-18
68P09278A36-A
FEB 2007
Child elements
<MSG>: mandatory.
Character data
None.
<MSG>
<!ELEMENT MSG (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
One to 16 printable characters. The encoding of an MSG is dened in the Encoding Rules.
<NOTIFICATION_MESSAGE_LIST>
<!ELEMENT NOTIFICATION_MESSAGE_LIST
(NOTIFICATION_MESSAGE*)>
Attributes
None.
Child elements
<NOTIFICATION_MESSAGE>: 0 or more. Depends on the PTT request action attribute.
Character data
None.
68P09278A36-A
3-19
FEB 2007
<NOTIFICATION_MESSAGE>
<!ELEMENT NOTIFICATION_MESSAGE (MDN, MSG_ID?,
OWNER_ID?, TYPE?, TIMESTAMP?, CUG_ID?,
GROUP_ID?)>
Attributes
None.
Child elements
<MDN>: mandatory.
Character data
None.
<MSG_ID>
<!ELEMENT MSG_ID (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
One to 16 printable characters. The encoding of an MSG_ID is dened in the Encoding Rules.
3-20
68P09278A36-A
FEB 2007
<OWNER_ID>
<!ELEMENT OWNER_ID (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
One to 16 printable characters. The encoding of an OWNER_ID is dened in the Encoding Rules.
<TYPE>
<!ELEMENT TYPE (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
One to 16 printable characters. The encoding of a TYPE is dened in the Encoding Rules.
<TIMESTAMP>
<!ELEMENT TIMESTAMP (#PCDATA)>
Attributes
None.
Child elements
None
68P09278A36-A
3-21
FEB 2007
Character data
One to 16 printable characters. The encoding of a TIMESTAMP is dened in the Encoding Rules.
<CUG_ID>
<!ELEMENT CUG_ID (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
One to 16 printable characters. The encoding of a CUG_ID is dened in the Encoding Rules.
<GROUP_ID>
<!ELEMENT GROUP_ID (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
One to 16 printable characters. The encoding of a GROUP_ID is dened in the Encoding Rules.
3-22
68P09278A36-A
FEB 2007
<ADMIN>
<!ELEMENT ADMIN (NAME?, PASSWD?, OLD_PASSWD?,
ENTERPRISE_CONTACT_LIST?,
ENTERPRISE_CONTACT_OWNERS?,
ENTERPRISE_GROUP_OWNERS?,
ENTERPRISE_CONTACT_NO_OWNERS?,
ENTERPRISE_GROUP_NO_OWNERS?,
REMOVE_ENTERPRISE_CONTACT?,
ADD_ENTERPRISE_CONTACT?,
ADD_ENTERPRISE_GROUP?,
REMOVE_ENTERPRISE_GROUP?,
ENTERPRISE_GROUP_AVAILABLE_BUDDIES?,
ENTERPRISE_GROUP_ASSIGNED_BUDDIES?,
UPDATE_ENTERPRISE_CONTACT?,
REMOVE_ENTERPRISE_GROUP_BUDDIES?,
ADD_ENTERPRISE_GROUP_BUDDIES?,
ENTERPRISE_SUBSCRIBERS_LIST?,
ENTERPRISE_MDNS_LIST?,
ENTERPRISE_GROUP_LIST?,
GROUP_LIST?,
CONTACT_LIST?,
OWNERS_LIST?,
GET_ENTERPRISE_NAME? )>
Attributes
ENTERPRISE_NAME: the Enterprise Name input is passed only if the value of variable
session_tracking_enabled in the web.xml conguration le is set to False.
Child elements
68P09278A36-A
3-23
FEB 2007
Character data
None.
3-24
68P09278A36-A
FEB 2007
<BLOCKING_EXCLUSION_CONTACT_LIST>
<!ELEMENT BLOCKING_EXCLUSION_CONTACT_LIST
(ALLOW_DENY_CONTACT*)>
Attributes
None.
Child elements
<ALLOW_DENY_CONTACT>: 0 or more, depends on the PTT request action attribute.
Character data
None.
<ALLOW_DENY_CONTACT>
<!ELEMENT ALLOW_DENY_CONTACT (NAME, MDN,
BUDDY_ADDITION?, GROUP_ADDITION?)>
Attributes
None.
Child elements
<NAME>: mandatory.
<MDN>: mandatory.
Character data
None.
68P09278A36-A
3-25
FEB 2007
<OWNER_MDN>
<!ELEMENT OWNER_MDN (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
One to 10 digits. The encoding of an OWNER_MDN is dened in the Encoding Rules.
<BUDDY_ADDITION>
<!ELEMENT BUDDY_ADDITION (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
One to 16 printable characters. The encoding of a BUDDY_ADDITION is dened in the Encoding
Rules.
<GROUP_ADDITION>
<!ELEMENT GROUP_ADDITION (#PCDATA)>
Attributes
None.
Child elements
None.
3-26
68P09278A36-A
FEB 2007
Character data
One to 16 printable characters. The encoding of a GROUP_ADDITION is dened in the Encoding
Rules.
<ENTERPRISE_CONTACT_OWNERS>
<!ELEMENT ENTERPRISE_CONTACT_OWNERS (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
<ENTERPRISE_GROUP_OWNERS>
<!ELEMENT ENTERPRISE_GROUP_OWNERS (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
68P09278A36-A
3-27
FEB 2007
<ENTERPRISE_CONTACT_NO_OWNERS>
<!ELEMENT ENTERPRISE_CONTACT_NO_OWNERS (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
<ENTERPRISE_GROUP_NO_OWNERS>
<!ELEMENT ENTERPRISE_GROUP_NO_OWNERS (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
<REMOVE_ENTERPRISE_CONTACT>
<!ELEMENT REMOVE_ENTERPRISE_CONTACT (#PCDATA)>
Attributes
None.
Child elements
None.
3-28
68P09278A36-A
FEB 2007
Character data
None.
<REMOVE_ENTERPRISE_GROUP>
<!ELEMENT REMOVE_ENTERPRISE_GROUP (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
<ADD_ENTERPRISE_CONTACT>
<!ELEMENT ADD_ENTERPRISE_CONTACT (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
<ADD_ENTERPRISE_GROUP>
<!ELEMENT ADD_ENTERPRISE_GROUP (#PCDATA)>
Attributes
None.
68P09278A36-A
3-29
FEB 2007
Child elements
None.
Character data
None.
<UPDATE_ENTERPRISE_CONTACT>
<!ELEMENT UPDATE_ENTERPRISE_CONTACT (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
<ENTERPRISE_GROUP_AVAILABLE_BUDDIES>
<!ELEMENT ENTERPRISE_GROUP_AVAILABLE_BUDDIES
(#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
3-30
68P09278A36-A
FEB 2007
<ENTERPRISE_GROUP_ASSIGNED_BUDDIES>
<!ELEMENT ENTERPRISE_GROUP_ASSIGNED_BUDDIES
(#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
<ADD_ENTERPRISE_GROUP_BUDDIES>
<!ELEMENT ADD_ENTERPRISE_GROUP_BUDDIES (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
<REMOVE_ENTERPRISE_GROUP_BUDDIES>
<!ELEMENT REMOVE_ENTERPRISE_GROUP_BUDDIES
(#PCDATA)>
Attributes
None.
68P09278A36-A
3-31
FEB 2007
Child elements
None.
Character data
None.
<ENTERPRISE_SUBSCRIBERS_LIST>
<!ELEMENT ENTERPRISE_SUBSCRIBERS_LIST (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
<ENTERPRISE_MDNS_LIST>
<!ELEMENT ENTERPRISE_MDNS_LIST (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
<OWNERS_LIST>
<!ELEMENT OWNERS_LIST (MDN*)>
3-32
68P09278A36-A
FEB 2007
Attributes
None.
Child elements
<MDN>: zero or more
Character data
None.
<ENTERPRISE_GROUP_LIST>
<!ELEMENT ENTERPRISE_GROUP_LIST (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
<ENTERPRISE_CONTACT_LIST>
<!ELEMENT ENTERPRISE_CONTACT_LIST (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
68P09278A36-A
3-33
FEB 2007
<GET_ENTERPRISE_NAME>
<!ELEMENT GET_ENTERPRISE_NAME (#PCDATA)>
Attributes
None.
Child elements
None.
Character data
None.
3-34
68P09278A36-A
FEB 2007
Appendix
XML samples
This appendix contains XML examples of both PTT_Request and PTT_Response corresponding
to the permitted requests and responses specied in this document.
All PoC XML API client applications sending requests to PoC Web Server must always
set the value of Content-Type header to text/xml. For more details, see HTTP request
sample on page A-95.
68P09278A36-A
FEB 2007
A-1
A-2
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10000" action="Query">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556667777</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
<!-- If the subscribers MDN is not on the local AD (the
AD to which the webserver is connected):
<SUBSCRIBER>
<REDIRECT_WEBSERVER_IP>http://10.232.118.77</REDIRECT_WEBSERVER_IP>
</SUBSCRIBER>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-3
Add subscriber
PTT request
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="10004" action="Add">
<SUBSCRIBER>
<MDN>5556668888</MDN>
<MIN>1234567890</MIN>
<!-- optional; defaults to MDN
if not present -->
<PASSWD>myPwd</PASSWD>
<!-- optional; if not present &
- SMS enabled, password is generated and sent;
- SMS disabled, defaults to configurable
default_subscriber_password -->
</SUBSCRIBER>
</PTT_REQUEST>
A-4
68P09278A36-A
FEB 2007
PTT response
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10004" action="Add">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<MIN_MDN_MISMATCH/>
<ALREADY_EXISTS>
<MDN>5556668888</MDN>
</ALREADY_EXISTS>
<PASSWORD_MODIFICATION_FAILURE/>
<UNKNOWN_ERROR/>
-->
<!-- If the subscriber s MDN is not on the local AD(the
AD to which the webserver is connected):
<SUBSCRIBER>
<REDIRECT_WEBSERVER_IP>http://10.232.118.77</REDIRECT_WEBSERVER_IP>
</SUBSCRIBER>
-->
</RETURN_CODE>
</PTT_RESPONSE>
Remove subscriber
PTT request
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="10012" action="Delete">
<SUBSCRIBER>
<MDN>5556668888</MDN>
</SUBSCRIBER>
</PTT_REQUEST>
68P09278A36-A
FEB 2007
A-5
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10012" action="Delete">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556667777</MDN>
</SUBSCRIBER>
<UNKNOWN_ERROR/>
-->
<!-- If the subscriber s MDN is not on the local AD(the
AD to which the webserver is connected):
<SUBSCRIBER>
<REDIRECT_WEBSERVER_IP>http://10.232.118.77</REDIRECT_WEBSERVER_IP>
</SUBSCRIBER>
-->
</RETURN_CODE>
</PTT_RESPONSE>
Purge subscriber
PTT request
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="10012" action="Purge">
<SUBSCRIBER>
<MDN>5556668888</MDN>
</SUBSCRIBER>
</PTT_REQUEST>
A-6
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10012" action="Purge">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556668888</MDN>
</SUBSCRIBER>
<UNKNOWN_ERROR/>
-->
<!-- If the subscriber s MDN is not on the local AD(the
AD to which the webserver is connected):
<SUBSCRIBER>
<REDIRECT_WEBSERVER_IP>http://10.232.118.77</REDIRECT_WEBSERVER_IP>
</SUBSCRIBER>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-7
A-8
68P09278A36-A
FEB 2007
PTT response
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10008" action="Update">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<MIN_MDN_MISMATCH/>
<UNKNOWN_ERROR/>
-->
<!-- If the subscribers MDN is not on the
local AD(the AD to which the webserver is connected):
<SUBSCRIBER>
<REDIRECT_WEBSERVER_IP>http://10.232.118.77</REDIRECT_WEBSERVER_IP>
</SUBSCRIBER>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-9
Subscriber login
PTT request
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="11000" action="Login">
<SUBSCRIBER>
<MDN>5556669999</MDN>
<PASSWD>my_password</PASSWD>
</SUBSCRIBER>
</PTT_REQUEST>
A-10
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="11000" action="Login">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<LOGIN_FAILURE/>
<UNKNOWN_ERROR/>
<ENTERPRISE_SUBSCRIBER/>
-->
<!-- If the subscriber is not created on the
local AD(the AD to which the webserver is connected):
<SUBSCRIBER>
<REDIRECT_WEBSERVER_IP>http://10.232.118.77</REDIRECT_WEBSERVER_IP>
</SUBSCRIBER>
-->
</RETURN_CODE>
</PTT_RESPONSE>
In case, the subscriber is created on foreign AD, the login message provides the web
server IP of the corresponding AD, which is used for all the operations pertaining
to this subscriber.
68P09278A36-A
FEB 2007
A-11
Subscriber logout
PTT request
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="11002" action="Logout">
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</PTT_REQUEST>
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="11002" action="Logout">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
<ENTRY_NOT_FOUND>
-->
</RETURN_CODE>
</PTT_RESPONSE>
A-12
68P09278A36-A
FEB 2007
Update password
PTT request
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="10009" action="Update">
<SUBSCRIBER>
<MDN>5556669999</MDN>
<PASSWD>my_new_passwd</PASSWD>
<OLD_PASSWD>my_password</OLD_PASSWD>
</SUBSCRIBER>
</PTT_REQUEST>
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10009" action="Update">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<PASSWORD_MODIFICATION_FAILURE/>
<INVALID_PASSWORD/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-13
Password reset
PTT request
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="11004" action="Reset">
<SUBSCRIBER>
<MDN>5556669999</MDN>
<PASSWD/>
</SUBSCRIBER>
</PTT_REQUEST>
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="11004" action="Reset">
<RETURN_CODE>
<SUCCESS/>
<!-- SMS notification sent to subscribers handset -->
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<PASSWORD_MODIFICATION_FAILURE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
<RETURN_CODE>
</PTT_RESPONSE>
A-14
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10001" action="Query">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- the following element is only included for SUCCESS case -->
<SUBSCRIBER>
<MDN>5556669999</MDN>
68P09278A36-A
FEB 2007
A-15
<CONTACT_LIST>
<CONTACT>
<NAME>Jane Doe</NAME>
<MDN>2223334444</MDN>
</CONTACT>
<CONTACT>
<NAME>Dave Smith</NAME>
<MDN>2223335555</MDN>
</CONTACT>
<CONTACT>
<NAME>D Kelly</NAME>
<MDN>2223338888</MDN>
</CONTACT>
</CONTACT_LIST>
</SUBSCRIBER>
</PTT_RESPONSE>
PTT request
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="10005" action="Add">
<SUBSCRIBER>
<MDN>5556669999</MDN>
<CONTACT_LIST>
<CONTACT>
<!-- valid entry to add -->
<NAME>Paul Smith</NAME>
<MDN>2223336666</MDN>
</CONTACT>
A-16
68P09278A36-A
FEB 2007
<CONTACT>
<!-- a Jane Doe already exists but the MDN
is different -->
<NAME>Jane Doe</NAME>
<MDN>2223337777</MDN>
</CONTACT>
<CONTACT>
<!-- a John Doe does not exist but this MDN
does -->
<NAME>John Doe</NAME>
<MDN>2223335555</MDN>
</CONTACT>
<CONTACT>
<!-- this is the subscribers MDN -->
<NAME>me</NAME>
<MDN>5556669999</MDN>
</CONTACT>
<CONTACT>
<!-- assume invalid PTT subscriber -->
<NAME>John Smith</NAME>
<MDN>2224440000</MDN>
</CONTACT>
<CONTACT>
<!-- valid entry to add -->
<NAME>Tom</NAME>
<MDN>2224441111</MDN>
</CONTACT>
<CONTACT>
<!-- valid entry to add -->
<NAME>Jerry</NAME>
<MDN>2224442222</MDN>
</CONTACT>
<CONTACT>
<!-- invalid name format -->
<NAME>Kate MyNameIsTooLong</NAME>
<MDN>2224443333</MDN>
</CONTACT>
</CONTACT_LIST>
</SUBSCRIBER>
</PTT_REQUEST>
68P09278A36-A
FEB 2007
A-17
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10005" action="Add">
<RETURN_CODE>
<ALREADY_EXISTS>
<CONTACT>
<NAME>John Doe</NAME>
<MDN>2223335555</MDN>
</CONTACT>
</ALREADY_EXISTS>
<ATTEMPTING_TO_ADD_SELF/>
<ENTRY_NOT_FOUND>
<MDN>2224440000</MDN>
</ENTRY_NOT_FOUND>
<MAX_SIZE_REACHED>
<LIMIT>150</LIMIT>
<ELEMENTS_NOT_ADDED>
<CONTACT_LIST>
<CONTACT>
<NAME>Tom</NAME>
<MDN>2224441111</MDN>
</CONTACT>
<CONTACT>
<NAME>Jerry</NAME>
<MDN>2224442222</MDN>
</CONTACT>
<CONTACT>
<!-- not processed as max size
reached -->
<NAME>Kate MyNameIsTooLong</NAME>
<MDN>2224443333</MDN>
</CONTACT>
</CONTACT_LIST>
</ELEMENTS_NOT_ADDED>
</MAX_SIZE_REACHED>
<CLOSED_ENTERPRISE_SUBSCRIBER>
<ELEMENTS_NOT_ADDED>
<CONTACT_LIST>
A-18
68P09278A36-A
FEB 2007
<CONTACT>
<NAME>Buddy2</NAME>
<MDN>2224443322</MDN>
</CONTACT>
<CONTACT>
<NAME>Buddy3</NAME>
<MDN>2224443323</MDN>
</CONTACT>
</CONTACT_LIST>
</ELEMENTS_NOT_ADDED>
</CLOSED_ENTERPRISE_SUBSCRIBER>
<!-- other possible values:
<BUDDY_ADDITION_DENIED>
<ELEMENTS_NOT_ADDED>
<CONTACT_LIST>
<CONTACT>
<MDN>1110000095</MDN>
</CONTACT>
<CONTACT>
<MDN>1110000096</MDN>
</CONTACT>
<CONTACT>
<MDN>1110000097</MDN>
</CONTACT>
</CONTACT_LIST>
</ELEMENTS_NOT_ADDED>
</BUDDY_ADDITION_DENIED>
<INVALID_BUDDY_NAME_SIZE>
<ELEMENTS_NOT_ADDED>
<CONTACT_LIST>
<CONTACT>
<MDN>1110000005</MDN>
</CONTACT>
<CONTACT>
<MDN>1110000006</MDN>
</CONTACT>
</CONTACT_LIST>
</ELEMENTS_NOT_ADDED>
</INVALID_BUDDY_NAME_SIZE>
<INVALID_CHARS_IN_BUDDY_NAME>
<ELEMENTS_NOT_ADDED>
68P09278A36-A
FEB 2007
A-19
<CONTACT_LIST>
<CONTACT>
<MDN>1110000097</MDN>
</CONTACT>
</CONTACT_LIST>
</ELEMENTS_NOT_ADDED>
</INVALID_CHARS_IN_BUDDY_NAME>
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
<SUCCESS/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
Duplicate contact names are allowed in buddy list, if the value of the variable,
allow_duplicate_contact_names, in the web.xml conguration le is set to True.
PTT request
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="10010" action="Update">
<SUBSCRIBER>
<MDN>5556669999</MDN>
<CONTACT_LIST>
<CONTACT>
A-20
68P09278A36-A
FEB 2007
68P09278A36-A
FEB 2007
A-21
</CONTACT>
</CONTACT_LIST>
</SUBSCRIBER>
</PTT_REQUEST>
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10010" action="Update">
<RETURN_CODE>
<!-- other possible values: <INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<BUDDY_ADDITION_DENIED>
<ELEMENTS_NOT_ADDED>
<CONTACT_LIST>
<CONTACT>
<MDN>1110000095</MDN>
</CONTACT>
<CONTACT>
<MDN>1110000096</MDN>
</CONTACT>
<CONTACT>
<MDN>1110000097</MDN>
</CONTACT>
</CONTACT_LIST>
</ELEMENTS_NOT_ADDED>
</BUDDY_ADDITION_DENIED>
<CLOSED_ENTERPRISE_SUBSCRIBER>
<ELEMENTS_NOT_ADDED>
<CONTACT_LIST>
<CONTACT>
<NAME>Buddy98</NAME>
<MDN>1110000098</MDN>
</CONTACT>
</CONTACT_LIST>
</ELEMENTS_NOT_ADDED>
</CLOSED_ENTERPRISE_SUBSCRIBER>
<INVALID_BUDDY_NAME_SIZE>
A-22
68P09278A36-A
FEB 2007
<ELEMENTS_NOT_ADDED>
<CONTACT_LIST>
<CONTACT>
<NAME>abcdefghijklmnopqrstuvwxy</NAME>
<MDN>1110000005</MDN>
</CONTACT>
<CONTACT>
<NAME>abcdefghijklmnopqrstuvwxy</NAME>
<MDN>1110000006</MDN>
</CONTACT>
</CONTACT_LIST>
</ELEMENTS_NOT_ADDED>
</INVALID_BUDDY_NAME_SIZE>
<INVALID_CHARS_IN_BUDDY_NAME>
<ELEMENTS_NOT_ADDED>
<CONTACT_LIST>
<CONTACT>
<NAME>abcdefghijklmnopqrstuvwxy</NAME>
<MDN>1110000097</MDN>
</CONTACT>
</CONTACT_LIST>
</ELEMENTS_NOT_ADDED>
</INVALID_CHARS_IN_BUDDY_NAME>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
<SUCCESS/>
-->
<ATTEMPTING_TO_ADD_SELF/>
<ALREADY_EXISTS>
<CONTACT>
<NAME>Jane Doe</NAME>
<MDN>2223336666</MDN>
</CONTACT>
</ALREADY_EXISTS>
<ENTRY_NOT_FOUND>
<MDN>2224440000</MDN>
</ENTRY_NOT_FOUND>
68P09278A36-A
FEB 2007
A-23
<ENTRY_NOT_FOUND>
<CONTACT>
<NAME>Tom</NAME>
<MDN>2224441111</MDN>
</CONTACT>
</ENTRY_NOT_FOUND>
</RETURN_CODE>
</PTT_RESPONSE>
A-24
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10013" action="Delete">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
<ENTRY_NOT_FOUND>
<CONTACT>
<NAME>Dave Smith</NAME>
<MDN>2223335555</MDN>
</CONTACT>
</ENTRY_NOT_FOUND>
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-25
A-26
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10002" action="Query">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- this element is only included for SUCCESS case -->
<SUBSCRIBER>
<MDN>5556669999</MDN>
<GROUP_LIST>
<GROUP>
<NAME>work</NAME>
</GROUP>
<GROUP>
<NAME>friends</NAME>
</GROUP>
</GROUP_LIST>
</SUBSCRIBER>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-27
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10006" action="Add">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ALREADY_EXISTS>
<GROUP>
<NAME>newgroup</NAME>
</GROUP>
</ALREADY_EXISTS>
<INVALID_GROUP_NAME_SIZE>
<ELEMENTS_NOT_ADDED>
<GROUP_LIST>
<GROUP>longgroupname</GROUP>
</GROUP_LIST>
</ELEMENTS_NOT_ADDED>
A-28
68P09278A36-A
FEB 2007
</INVALID_GROUP_NAME_SIZE>
<INVALID_CHARS_IN_GROUP_NAME>
<ELEMENTS_NOT_ADDED>
<GROUP_LIST>
<GROUP>group*with#invalid^chars</GROUP>
</GROUP_LIST>
</ELEMENTS_NOT_ADDED>
</INVALID_CHARS_IN_GROUP_NAME>
<MAX_SIZE_REACHED>
<LIMIT>50</LIMIT>
<ELEMENTS_NOT_ADDED>
<GROUP_LIST>
<GROUP>
<NAME>newgroup</NAME>
</GROUP>
</GROUP_LIST>
</ELEMENTS_NOT_ADDED>
</MAX_SIZE_REACHED>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-29
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10011" action="Update">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<GROUP>
<NAME>work</NAME>
</GROUP>
</ENTRY_NOT_FOUND>
<ALREADY_EXISTS>
<GROUP>
<NAME>MOTO</NAME>
</GROUP>
</ALREADY_EXISTS>
A-30
68P09278A36-A
FEB 2007
<INVALID_GROUP_NAME_SIZE>
<ELEMENTS_NOT_ADDED>
<GROUP_LIST>
<GROUP>longgroupname</GROUP>
</GROUP_LIST>
</ELEMENTS_NOT_ADDED>
</INVALID_GROUP_NAME_SIZE>
<INVALID_CHARS_IN_GROUP_NAME>
<ELEMENTS_NOT_ADDED>
<GROUP_LIST>
<GROUP>group*with#invalid^chars
</GROUP>
</GROUP_LIST>
</ELEMENTS_NOT_ADDED>
</INVALID_CHARS_IN_GROUP_NAME>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-31
A-32
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10014" action="Delete">
<RETURN_CODE>
<SUCCESS/>
<ENTRY_NOT_FOUND>
<GROUP>
<NAME>newgroup</NAME>
</GROUP>
</ENTRY_NOT_FOUND>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-33
A-34
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10003" action="Query">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<GROUP>
<NAME>friends</NAME>
</GROUP>
</ENTRY_NOT_FOUND>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- the following element is only included for SUCCESS case
-->
<SUBSCRIBER>
<MDN>5556669999</MDN>
<GROUP_LIST>
<GROUP>
<NAME>friends</NAME>
<GROUP_MEMBER_LIST>
<MDN>2223334444</MDN>
</GROUP_MEMBER_LIST>
</GROUP>
</GROUP_LIST>
</SUBSCRIBER>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-35
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10007" action="Add">
A-36
68P09278A36-A
FEB 2007
<RETURN_CODE>
<ENTRY_NOT_FOUND>
<MDN>2224440000</MDN>
</ENTRY_NOT_FOUND>
<ATTEMPTING_TO_ADD_SELF/>
<ALREADY_EXISTS>
<MDN>2223334444</MDN>
</ALREADY_EXISTS>
<MAX_SIZE_REACHED>
<LIMIT>20</LIMIT>
<ELEMENTS_NOT_ADDED>
<GROUP_MEMBER_LIST>
<MDN>2224441111</MDN>
<MDN>2224442222</MDN>
</GROUP_MEMBER_LIST>
</ELEMENTS_NOT_ADDED>
</MAX_SIZE_REACHED>
<CLOSED_ENTERPRISE_SUBSCRIBER>
<ELEMENTS_NOT_ADDED>
<GROUP_MEMBER_LIST>
<MDN>2223334234</MDN>
<MDN>2223334235</MDN>
</GROUP_MEMBER_LIST>
</ELEMENTS_NOT_ADDED>
</CLOSED_ENTERPRISE_SUBSCRIBER>
<NON_ENTERPRISE_GROUP_SIZE>
<CONTACT>
<MDN>2224442222</MDN>
</CONTACT>
<NEW_GROUP_SIZE>4</NEW_GROUP_SIZE>
</NON_ENTERPRISE_GROUP_SIZE>
<NON_ENTERPRISE_GROUP_SIZE_MAX_LIMIT_REACHED>
<ELEMENTS_NOT_ADDED>
<MDN>2224442227</MDN>
<MDN>2224442229</MDN>
<MDN>2224442241</MDN>
</ELEMENTS_NOT_ADDED>
</NON_ENTERPRISE_GROUP_SIZE_MAX_LIMIT_REACHED>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ERROR_MESSAGE>
68P09278A36-A
FEB 2007
A-37
A-38
68P09278A36-A
FEB 2007
68P09278A36-A
FEB 2007
A-39
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10015" action="Delete">
<RETURN_CODE>
<SUCCESS/>
<ENTRY_NOT_FOUND>
<CONTACT>
<MDN>2224443333</MDN>
</CONTACT>
</ENTRY_NOT_FOUND>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<GROUP>
<NAME>friends</NAME>
</GROUP>
</ENTRY_NOT_FOUND>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
A-40
68P09278A36-A
FEB 2007
Query preferences
PTT request
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="10020" action="Query">
<SUBSCRIBER>
<MDN>5556669999</MDN>
<PREFERENCES/>
</SUBSCRIBER>
</PTT_REQUEST>
68P09278A36-A
FEB 2007
A-41
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10020" action="Query">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<SUBSCRIBER>
<MDN>5556669999</MDN>
<PREFERENCES>
<PRESENCE_PRIVACY>on</PRESENCE_PRIVACY>
<CALLERID_BLOCKING>on</CALLERID_BLOCKING>
</PREFERENCES>
</SUBSCRIBER>
</PTT_RESPONSE>
A-42
68P09278A36-A
FEB 2007
Update preferences
PTT request
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="10021" action="Update">
<SUBSCRIBER>
<MDN>5556669999</MDN>
<PREFERENCES>
<PRESENCE_PRIVACY>off</PRESENCE_PRIVACY>
<CALLERID_BLOCKING>on</CALLERID_BLOCKING>
</PREFERENCES>
</SUBSCRIBER>
</PTT_REQUEST>
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10021" action="Update">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-43
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10022">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<SUBSCRIBER>
<MDN>5556669999</MDN>
<PREFERENCES2>
<RECEIVE_NOTIFICATION>on</RECEIVE_NOTIFICATION>
</PREFERENCES2>
</SUBSCRIBER>
</PTT_RESPONSE>
A-44
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Update" tid="10023">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-45
A-46
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10022">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<SUBSCRIBER>
<MDN>5556669999</MDN>
<BLOCKING_EXCLUSION_LIST>
<BLOCKING_EXCLUSION_LIST_MODE>ALLOW
</BLOCKING_EXCLUSION_LIST_MODE>
</BLOCKING_EXCLUSION_LIST>
</SUBSCRIBER>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-47
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10025">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
A-48
68P09278A36-A
FEB 2007
68P09278A36-A
FEB 2007
A-49
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10026">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<SUBSCRIBER>
<MDN>5556669999</MDN>
<BLOCKING_EXCLUSION_CONTACT_LIST>
<ALLOW_DENY_CONTACT>
<NAME>block8088008002</NAME>
<BUDDY_ADDITION>1</BUDDY_ADDITION>
<GROUP_ADDITION>1</GROUP_ADDITION>
<MDN>8088008002</MDN>
</ALLOW_DENY_CONTACT>
<ALLOW_DENY_CONTACT>
<NAME>block8088008008</NAME>
<BUDDY_ADDITION>0</BUDDY_ADDITION>
<GROUP_ADDITION>1</GROUP_ADDITION>
<MDN>8088008008</MDN>
</ALLOW_DENY_CONTACT>
</BLOCKING_EXCLUSION_CONTACT_LIST>
</SUBSCRIBER>
</PTT_RESPONSE>
A-50
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Add" tid="10028">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-51
A-52
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Update" tid="10029">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-53
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Delete" tid="10027">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>5556669999</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
A-54
68P09278A36-A
FEB 2007
Notication messages
Notication messages
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10030">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>8088008002</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- the following element is only included for
SUCCESS case -->
<SUBSCRIBER>
68P09278A36-A
FEB 2007
A-55
Notication messages
<MDN>9789780001</MDN>
<NOTIFICATION_MESSAGE_LIST>
<NOTIFICATION_MESSAGE>
<MSG_ID>4</MSG_ID>
<MDN>8088008005</MDN>
<OWNER_ID>8</OWNER_ID>
<TYPE>ADD_IN_BUDDYLIST</TYPE>
<TIMESTAMP>-1108884500</TIMESTAMP>
<CUG_ID>-</CUG_ID>
<STRING_FORMAT>%MDN has added you in
his/her buddy list.</STRING_FORMAT>
</NOTIFICATION_MESSAGE>
<NOTIFICATION_MESSAGE>
<MSG_ID>5</MSG_ID>
<MDN>8088008005</MDN>
<OWNER_ID>8</OWNER_ID>
<TYPE>ADD_IN_GROUPLIST</TYPE>
<TIMESTAMP>-1108836334</TIMESTAMP>
<CUG_ID>860</CUG_ID>
<STRING_FORMAT>%MDN has added you in
his/her group %GROUP.</STRING_FORMAT>
<GROUP_ID>GRP</GROUP_ID>
</NOTIFICATION_MESSAGE>
</NOTIFICATION_MESSAGE_LIST>
</SUBSCRIBER>
</PTT_REQUEST>
A-56
68P09278A36-A
FEB 2007
Notication messages
PTT response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE tid="10006" action="Delete">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<ENTRY_NOT_FOUND>
<SUBSCRIBER>
<MDN>1030003001</MDN>
</SUBSCRIBER>
</ENTRY_NOT_FOUND>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-57
A-58
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Login" tid="111100">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<LOGIN_FAILURE/>
<UNKNOWN_ERROR/>
-->
<!-- If the enterprise for the admin is not homed
on the local AD(the AD to which the webserver is connected):
<ADMIN>
<REDIRECT_WEBSERVER_IP>
http://10.232.118.77
</REDIRECT_WEBSERVER_IP>
</ADMIN>
-->
</RETURN_CODE>
</PTT_RESPONSE>
In case, the enterprise is created on foreign AD, the Enterprise Web Administrator
Login or Get Enterprise Name for the Web Administrator message provides
the web server IP of the corresponding AD. This IP is used for all the operations
pertaining to this enterprise (Enterprise Web Administrator).
68P09278A36-A
FEB 2007
A-59
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Logout" tid="10002">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
A-60
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="11101">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<ENTRY_NOT_FOUND>
<ADMIN>mot100admin</ADMIN>
</ENTRY_NOT_FOUND>
-->
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<ADMIN>
<ENTERPRISE>mot1</ENTERPRISE>
</ADMIN>
<!-- If the enterprise for the admin is not homed on the
local AD(the AD to which the webserver is connected):
<ADMIN>
<REDIRECT_WEBSERVER_IP>
http://10.232.118.77
</REDIRECT_WEBSERVER_IP>
</ADMIN>
-->
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-61
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Update" tid="10009">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<INVALID_PASSWORD/>
<PASSWORD_MODIFICATION_FAILURE/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
A-62
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10002">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- the following element is only included for SUCCESS case:->
<ADMIN>
<ENTERPRISE>motorola</ENTERPRISE>
<ENTERPRISE_SUBSCRIBERS>
<SUBSCRIBER><MDN>9789780004</MDN></SUBSCRIBER>
<SUBSCRIBER><MDN>8088008001</MDN></SUBSCRIBER>
<SUBSCRIBER><MDN>8088008004</MDN></SUBSCRIBER>
</ENTERPRISE_SUBSCRIBERS>
</ADMIN>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-63
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10002">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- the following element is only included for SUCCESS case:->
<ADMIN>
<ENTERPRISE>motorola</ENTERPRISE>
<ENTERPRISE_CONTACT_LIST>
<CONTACT>
<NAME>CT8001</NAME>
<MDN>8088008001</MDN>
</CONTACT>
<CONTACT>
<NAME>CT8002</NAME>
<MDN>8088008002</MDN>
</CONTACT>
A-64
68P09278A36-A
FEB 2007
<CONTACT>
<NAME>CT8003</NAME>
<MDN>8088008003</MDN>
</CONTACT>
<CONTACT>
<NAME>CT8005</NAME>
<MDN>8088008005</MDN>
</CONTACT>
<CONTACT>
<NAME>CT8006</NAME>
<MDN>8088008006</MDN>
</CONTACT>
</ENTERPRISE_CONTACT_LIST>
</ADMIN>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-65
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Add" tid="10020">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:-->
<ENTRY_NOT_FOUND>
<MDN>8088008008</MDN>
</ENTRY_NOT_FOUND>
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
<BUDDY_ALREADY_EXISTS_FOR_OWNERS>
<OWNER_MDN>9110000065</OWNER_MDN>
<OWNER_MDN>9110000074</OWNER_MDN>
<OWNER_MDN>9110000073</OWNER_MDN>
</BUDDY_ALREADY_EXISTS_FOR_OWNERS>
<MAX_LIMIT_REACHED_OWNERS>
<OWNER_MDN>1110000006</OWNER_MDN>
<OWNER_MDN>1110000007</OWNER_MDN>
<OWNER_MDN>1110000010</OWNER_MDN>
<OWNER_MDN>1110000011</OWNER_MDN>
</MAX_LIMIT_REACHED_OWNERS>
<CLOSED_ENTERPRISE_OWNERS>
<OWNER_MDN>1110000003</OWNER_MDN>
<OWNER_MDN>1110000004</OWNER_MDN>
<OWNER_MDN>1110000005</OWNER_MDN>
</CLOSED_ENTERPRISE_OWNERS>
<ERROR_MESSAGE>
<INVALID_BUDDY_NAME_SIZE>
<BUDDY_MDN>1110000097</BUDDY_MDN>
<BUDDY_NAME>buddy_name_too_long</BUDDY_NAME>
</INVALID_BUDDY_NAME_SIZE>
</ERROR_MESSAGE>
<ERROR_MESSAGE>
<INVALID_CHARS_IN_BUDDY_NAME>
<BUDDY_MDN>1110000097</BUDDY_MDN>
<BUDDY_NAME>invalid_buddy_name</BUDDY_NAME>
A-66
68P09278A36-A
FEB 2007
</INVALID_CHARS_IN_BUDDY_NAME>
</ERROR_MESSAGE>
<ERROR_MESSAGE>
<MSG>DUPLICATE_ENTERPRISE_CONTACT_NAME</MSG>
</ERROR_MESSAGE>
<!-- If the owner MDN is not a enterprise subscriber:
<NON_ENTERPRISE_SUBSCRIBER>Motorola</NON_ENTERPRISE_SUBSCRIBER>
<CLOSED_ENTERPRISE_SUBSCRIBER>
<ELEMENTS_NOT_ADDED>
<CONTACT_LIST>
<CONTACT>
<NAME>CT008</NAME>
<MDN>8088008002</MDN>
</CONTACT>
</CONTACT_LIST>
</ELEMENTS_NOT_ADDED>
</CLOSED_ENTERPRISE_SUBSCRIBER>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-67
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10013">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- the following element is only included for SUCCESS case: -->
<ADMIN>
<ENTERPRISE>motorola</ENTERPRISE>
<ENTERPRISE_CONTACT_OWNERS>
<OWNER_MDN>8088008001</OWNER_MDN>
<OWNER_MDN>8088008004</OWNER_MDN>
</ENTERPRISE_CONTACT_OWNERS>
</ADMIN>
</PTT_RESPONSE>
A-68
68P09278A36-A
FEB 2007
68P09278A36-A
FEB 2007
A-69
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10013">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- the following element is only included for SUCCESS case: -->
<ADMIN>
<ENTERPRISE>motorola</ENTERPRISE>
<ENTERPRISE_CONTACT_NON_OWNERS>
<OWNER_MDN>9110000080</OWNER_MDN>
<OWNER_MDN>9110000081</OWNER_MDN>
<OWNER_MDN>9110000082</OWNER_MDN>
<OWNER_MDN>9000000001</OWNER_MDN>
<OWNER_MDN>9000000002</OWNER_MDN>
<OWNER_MDN>9110000199</OWNER_MDN>
<OWNER_MDN>9110000200</OWNER_MDN>
</ENTERPRISE_CONTACT_NON_OWNERS>
</ADMIN>
</PTT_RESPONSE>
The operator can update only the contact name in an enterprise, and not the MDN
of the contact.
A-70
68P09278A36-A
FEB 2007
PTT request
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="10021" action="Update">
<ADMIN ENTERPRISE_NAME="Motorola">
<UPDATE_ENTERPRISE_CONTACT/>
<CONTACT_LIST>
<CONTACT>
<NAME>CONTACT008</NAME>
<MDN>8088008008</MDN>
</CONTACT>
</CONTACT_LIST>
</ADMIN>
</PTT_REQUEST>
68P09278A36-A
FEB 2007
A-71
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Update" tid="10021">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
<ERROR_MESSAGE>
<INVALID_BUDDY_NAME_SIZE>
<BUDDY_MDN>1110000097</BUDDY_MDN>
</INVALID_BUDDY_NAME_SIZE>
</ERROR_MESSAGE>
<ERROR_MESSAGE>
<INVALID_CHARS_IN_BUDDY_NAME>
<BUDDY_MDN>1110000097</BUDDY_MDN>
</INVALID_CHARS_IN_BUDDY_NAME>
</ERROR_MESSAGE>
<ERROR_MESSAGE>
<MSG>DUPLICATE_ENTERPRISE_CONTACT_NAME</MSG>
</ERROR_MESSAGE>
-->
<!-- If the contact with given MDN does not exist:
<ENTRY_NOT_FOUND>
<CONTACT>
<MDN>8088008008</MDN>
</CONTACT>
</ENTRY_NOT_FOUND>
-->
</RETURN_CODE>
</PTT_RESPONSE>
A-72
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Delete" tid="10013">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-73
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Delete" tid="10013">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
A-74
68P09278A36-A
FEB 2007
68P09278A36-A
FEB 2007
A-75
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10002">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- the following element is only included for SUCCESS case: -->
<ADMIN>
<ENTERPRISE>motorola</ENTERPRISE>
<ENTERPRISE_GROUP_LIST>
<GROUP>
<NAME>GRP1</NAME>
</GROUP>
<GROUP>
<NAME>GRP2</NAME>
</GROUP>
<GROUP>
<NAME>GRP3</NAME>
</GROUP>
<GROUP>
<NAME>GRP4</NAME>
</GROUP>
</ENTERPRISE_GROUP_LIST>
</ADMIN>
</PTT_RESPONSE>
A-76
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Add" tid="10020">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
<ERROR_MESSAGE>
<GROUP_ALREADY_EXISTS_FOR_OWNERS>
<OWNER_MDN>9110000065</OWNER_MDN>
<OWNER_MDN>9110000074</OWNER_MDN>
<OWNER_MDN>9110000073</OWNER_MDN>
</GROUP_ALREADY_EXISTS_FOR_OWNERS>
68P09278A36-A
FEB 2007
A-77
<MAX_LIMIT_REACHED_OWNERS>
<OWNER_MDN>1110000003</OWNER_MDN>
<OWNER_MDN>1110000004</OWNER_MDN>
<OWNER_MDN>1110000005</OWNER_MDN>
<OWNER_MDN>1110000006</OWNER_MDN>
<OWNER_MDN>1110000007</OWNER_MDN>
<OWNER_MDN>1110000010</OWNER_MDN>
<OWNER_MDN>1110000011</OWNER_MDN>
</MAX_LIMIT_REACHED_OWNERS>
</ERROR_MESSAGE>
<INVALID_GROUP_NAME_SIZE>
<ELEMENTS_NOT_ADDED>
<GROUP_LIST>
<GROUP>longgroupname</GROUP>
</GROUP_LIST>
</ELEMENTS_NOT_ADDED>
</INVALID_GROUP_NAME_SIZE>
<INVALID_CHARS_IN_GROUP_NAME>
<ELEMENTS_NOT_ADDED>
<GROUP_LIST>
<GROUP>group*with#invalid^chars</GROUP>
</GROUP_LIST>
</ELEMENTS_NOT_ADDED>
</INVALID_CHARS_IN_GROUP_NAME>
-->
<!-- If the owner MDN is not a enterprise subscriber:
<NON_ENTERPRISE_SUBSCRIBER>Motorola</NON_ENTERPRISE_SUBSCRIBER>
-->
</RETURN_CODE>
</PTT_RESPONSE>
A-78
68P09278A36-A
FEB 2007
68P09278A36-A
FEB 2007
A-79
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Update" tid="10011">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
<INVALID_GROUP_NAME_SIZE>
<ELEMENTS_NOT_ADDED>
<GROUP_LIST>
<GROUP>longgroupname</GROUP>
</GROUP_LIST>
</ELEMENTS_NOT_ADDED>
</INVALID_GROUP_NAME_SIZE>
<INVALID_CHARS_IN_GROUP_NAME>
<ELEMENTS_NOT_ADDED>
<GROUP_LIST>
<GROUP>group*with#invalid^chars</GROUP>
</GROUP_LIST>
</ELEMENTS_NOT_ADDED>
</INVALID_CHARS_IN_GROUP_NAME>
-->
</RETURN_CODE>
</PTT_RESPONSE>
A-80
68P09278A36-A
FEB 2007
68P09278A36-A
FEB 2007
A-81
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10013">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<ENTRY_NOT_FOUND/>
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- the following element is only included for SUCCESS case: -->
<ADMIN>
<ENTERPRISE>motorola</ENTERPRISE>
<ENTERPRISE_GROUP_OWNERS>
<OWNER_MDN>8088008001</OWNER_MDN>
<OWNER_MDN>8088008004</OWNER_MDN>
</ENTERPRISE_GROUP_OWNERS>
</ADMIN>
</PTT_RESPONSE>
A-82
68P09278A36-A
FEB 2007
68P09278A36-A
FEB 2007
A-83
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10013">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<ENTRY_NOT_FOUND>
<GROUP>grp1</GROUP>
</ENTRY_NOT_FOUND>
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- the following element is only included for SUCCESS case: -->
<ADMIN>
<ENTERPRISE>motorola</ENTERPRISE>
<ENTERPRISE_GROUP_NON_OWNERS>
<OWNER_MDN>8088008004</OWNER_MDN>
</ENTERPRISE_GROUP_NON_OWNERS>
</ADMIN>
</PTT_RESPONSE>
A-84
68P09278A36-A
FEB 2007
68P09278A36-A
FEB 2007
A-85
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10013">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- the following element is only included for SUCCESS case: -->
<ADMIN>
<ENTERPRISE>motorola</ENTERPRISE>
<ENTERPRISE_GROUP_ASSIGNED_BUDDIES>
<MDN>4044004004</MDN>
<MDN>4044004003</MDN>
<MDN>4044004018</MDN>
<MDN>4044004006</MDN>
<MDN>4044004013</MDN>
<MDN>4044004009</MDN>
<MDN>8088888888</MDN>
</ENTERPRISE_GROUP_ASSIGNED_BUDDIES>
</ADMIN>
</PTT_RESPONSE>
A-86
68P09278A36-A
FEB 2007
PTT request
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="10013" action="Query">
<ADMIN ENTERPRISE_NAME="Motorola">
<ENTERPRISE_GROUP_AVAILABLE_BUDDIES/>
<GROUP_LIST>
<GROUP>
<NAME>grp1</NAME>
</GROUP>
</GROUP_LIST>
</ADMIN>
</PTT_REQUEST>
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10013">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<!-- the following element is only included for SUCCESS case: -->
<ADMIN>
<ENTERPRISE>motorola</ENTERPRISE>
<ENTERPRISE_GROUP_AVAILABLE_BUDDIES>
<MDN>4044004001</MDN>
<MDN>4044004015</MDN>
<MDN>4044004019</MDN>
<MDN>4044004025</MDN>
</ENTERPRISE_GROUP_AVAILABLE_BUDDIES>
</ADMIN>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-87
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Add" tid="10011">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
<ERROR_MESSAGE>
<MAX_LIMIT_REACHED_OWNERS>
<OWNER_MDN>4044004029</OWNER_MDN>
<OWNER_MDN>4044004026</OWNER_MDN>
<OWNER_MDN>4044004025</OWNER_MDN>
A-88
68P09278A36-A
FEB 2007
<OWNER_MDN>4044004024</OWNER_MDN>
</MAX_LIMIT_REACHED_OWNERS>
</ERROR_MESSAGE>
<NON_ENTERPRISE_GROUP_SIZE>
<OWNER>
<OWNER_MDN>4044004031</OWNER_MDN>
<NEW_GROUP_SIZE>5</NEW_GROUP_SIZE>
</OWNER>
<OWNER>
<OWNER_MDN>4044004035</OWNER_MDN>
<NEW_GROUP_SIZE>5</NEW_GROUP_SIZE>
</OWNER>
</NON_ENTERPRISE_GROUP_SIZE>
<ERROR_MESSAGE>
<NON_ENTERPRISE_GROUP_SIZE_MAX_LIMIT_REACHED_OWNERS>
<OWNER_MDN>4044004041</OWNER_MDN>
<OWNER_MDN>4044004047</OWNER_MDN>
</NON_ENTERPRISE_GROUP_SIZE_MAX_LIMIT_REACHED_OWNERS>
</ERROR_MESSAGE>
<CLOSED_ENTERPRISE_OWNERS>
<OWNER_MDN>4044004015</OWNER_MDN>
<OWNER_MDN>4044004016</OWNER_MDN>
</CLOSED_ENTERPRISE_OWNERS>
<GROUP_ADDITION_DENIED>
<ELEMENTS_NOT_ADDED>
<CONTACT_LIST>
<CONTACT><MDN>8088008006</MDN></CONTACT>
<CONTACT><MDN>8088008007</MDN></CONTACT>
</CONTACT_LIST>
</ELEMENTS_NOT_ADDED>
</GROUP_ADDITION_DENIED>
<CLOSED_ENTERPRISE_SUBSCRIBER>
<ELEMENTS_NOT_ADDED>
<GROUP_MEMBER_LIST>
<MDN>8088008006</MDN>
</GROUP_MEMBER_LIST>
</ELEMENTS_NOT_ADDED>
</CLOSED_ENTERPRISE_SUBSCRIBER>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-89
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Delete" tid="10011">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
A-90
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Delete" tid="10020">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-91
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Delete" tid="10020">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
</PTT_RESPONSE>
A-92
68P09278A36-A
FEB 2007
PTT response
<?xml version="1.0"?>
<!DOCTYPE PTT_RESPONSE SYSTEM "PTT_Interface.dtd">
<PTT_RESPONSE action="Query" tid="10002">
<RETURN_CODE>
<SUCCESS/>
<!-- other possible values:
<INVALID_XML_FORMAT/>
<ACTIVE_DIRECTORY_UNAVAILABLE/>
<UNKNOWN_ERROR/>
-->
</RETURN_CODE>
<ADMIN>
<ENTERPRISE>motorola</ENTERPRISE>
<ENTERPRISE_SUBSCRIBERS>
<SUBSCRIBER><MDN>9789780004</MDN></SUBSCRIBER>
<SUBSCRIBER><MDN>8088008001</MDN></SUBSCRIBER>
<SUBSCRIBER><MDN>8088008004</MDN></SUBSCRIBER>
</ENTERPRISE_SUBSCRIBERS>
</ADMIN>
</PTT_RESPONSE>
68P09278A36-A
FEB 2007
A-93
A-94
68P09278A36-A
FEB 2007
All PTT XML API client applications sending HTTP requests to PoC Web Server must always set
the value of Content-Type header to text/xml.
The following sample shows an HTTP request with the header Content-Type set to text/xml:
POST /gws/PTTProvServlet HTTP/1.1
TE: deate,gzip;q=0.3
Connection: TE, close
Host: 10.232.117.90
User-Agent: ScriptPerl/0.1 libwww-perl/5.65
Content-Type: text/xml
Content-Length: 190
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PTT_REQUEST SYSTEM "PTT_Interface.dtd">
<PTT_REQUEST tid="10000" action="Query">
<SUBSCRIBER>
<MDN>5556667777</MDN>
</SUBSCRIBER>
</PTT_REQUEST>
68P09278A36-A
FEB 2007
A-95
A-96
68P09278A36-A
FEB 2007
Appendix
DTD denition
This appendix contains the interface DTD for the PoC system.
<?xml version="1.0" encoding="UTF-8"?>
<!ELEMENT CONTACT (NAME, MDN, OLD_NAME?, OLD_MDN?)>
<!ELEMENT CONTACT_LIST (CONTACT*)>
<!ELEMENT GROUP (NAME, OLD_NAME?, GROUP_MEMBER_LIST*)>
<!ELEMENT GROUP_LIST (GROUP*)>
<!ELEMENT GROUP_MEMBER_LIST (MDN*)>
<!ELEMENT ALLOW_DENY_CONTACT (NAME, MDN, BUDDY_ADDITION?,GROUP_ADDITION?)>
<!ELEMENT BLOCKING_EXCLUSION_CONTACT_LIST ((ALLOW_DENY_CONTACT*)>
<!ELEMENT MDN (#PCDATA)>
<!ELEMENT MIN (#PCDATA)>
<!ELEMENT NAME (#PCDATA)>
<!ELEMENT OLD_MDN (#PCDATA)>
<!ELEMENT OLD_MIN (#PCDATA)>
<!ELEMENT OLD_NAME (#PCDATA)>
<!ELEMENT OLD_PASSWD (#PCDATA)>
<!ELEMENT PASSWD (#PCDATA)>
<!ELEMENT OWNER_MDN (#PCDATA)>
<!ELEMENT BUDDY_ADDITION (#PCDATA)>
<!ELEMENT GROUP_ADDITION (#PCDATA)>
<!ELEMENT ENTERPRISE_GROUP_LIST (#PCDATA)>
<!ELEMENT ENTERPRISE_CONTACT_LIST (#PCDATA)>
<!ELEMENT ENTERPRISE_CONTACT_OWNERS (#PCDATA)>
<!ELEMENT ENTERPRISE_GROUP_OWNERS (#PCDATA)>
<!ELEMENT ENTERPRISE_CONTACT_NO_OWNERS (#PCDATA)>
<!ELEMENT ENTERPRISE_GROUP_NO_OWNERS (#PCDATA)>
<!ELEMENT REMOVE_ENTERPRISE_CONTACT (#PCDATA)>
<!ELEMENT REMOVE_ENTERPRISE_GROUP (#PCDATA)>
<!ELEMENT ADD_ENTERPRISE_CONTACT (#PCDATA)>
<!ELEMENT ADD_ENTERPRISE_GROUP (#PCDATA)>
<!ELEMENT UPDATE_ENTERPRISE_CONTACT (#PCDATA)>
<!ELEMENT ENTERPRISE_GROUP_AVAILABLE_BUDDIES (#PCDATA)>
<!ELEMENT ENTERPRISE_GROUP_ASSIGNED_BUDDIES (#PCDATA)>
<!ELEMENT ADD_ENTERPRISE_GROUP_BUDDIES (#PCDATA)>
<!ELEMENT REMOVE_ENTERPRISE_GROUP_BUDDIES (#PCDATA)>
<!ELEMENT OWNERS_LIST (MDN*)>
<!ELEMENT ENTERPRISE_SUBSCRIBERS_LIST (#PCDATA)>
<!ELEMENT ENTERPRISE_MDNS_LIST (#PCDATA)>
68P09278A36-A
FEB 2007
B-1
GET_ENTERPRISE_NAME?, ENTERPRISE_CONTACT_LIST?,
ENTERPRISE_CONTACT_OWNERS?,
ENTERPRISE_GROUP_OWNERS?,
ENTERPRISE_CONTACT_NO_OWNERS?,
ENTERPRISE_GROUP_NO_OWNERS?,
REMOVE_ENTERPRISE_CONTACT?,
ADD_ENTERPRISE_CONTACT?,
ADD_ENTERPRISE_GROUP?, REMOVE_ENTERPRISE_GROUP?,
ENTERPRISE_GROUP_AVAILABLE_BUDDIES?,
ENTERPRISE_GROUP_ASSIGNED_BUDDIES?,
UPDATE_ENTERPRISE_CONTACT?,
REMOVE_ENTERPRISE_GROUP_BUDDIES?,
ADD_ENTERPRISE_GROUP_BUDDIES?,
ENTERPRISE_SUBSCRIBERS_LIST?,
ENTERPRISE_MDNS_LIST?,
ENTERPRISE_GROUP_LIST?, GROUP_LIST?,
CONTACT_LIST?,
OWNERS_LIST?
B-2
68P09278A36-A
FEB 2007
<!ATTLIST ADMIN
ENTERPRISE_NAME CDATA #IMPLIED>
<!ELEMENT CSR (NAME)>
<!ELEMENT PTT_REQUEST (CSR?, ADMIN?, SUBSCRIBER)>
<!ATTLIST PTT_REQUEST
tid CDATA #REQUIRED
action (Add | Delete | Update | Query | Login | Logout | Reset | Purge)
#REQUIRED>
<!ELEMENT PTT_RESPONSE (RETURN_CODE, SUBSCRIBER?)>
<!ATTLIST PTT_RESPONSE
tid CDATA #REQUIRED
action (Add | Delete | Update | Query | Login | Logout | Reset) #REQUIRED>
<!ELEMENT RETURN_CODE (SUCCESS
| INVALID_XML_FORMAT
| ACTIVE_DIRECTORY_UNAVAILABLE
| ATTEMPTING_TO_ADD_SELF
| INVALID_NAME_FORMAT
| MAX_SIZE_REACHED
| ALREADY_EXISTS
| ENTRY_NOT_FOUND
| MIN_MDN_MISMATCH
| LOGIN_FAILURE
| PASSWORD_MODIFICATION_FAILURE
| UNKNOWN_ERROR)
| ERROR_MESSAGE)+
>
<!-- Error Codes-->
<!ELEMENT SUCCESS (#PCDATA)>
<!ELEMENT INVALID_XML_FORMAT (#PCDATA)>
<!ELEMENT ACTIVE_DIRECTORY_UNAVAILABLE (#PCDATA)>
<!ELEMENT ATTEMPTING_TO_ADD_SELF (#PCDATA)>
<!ELEMENT INVALID_NAME_FORMAT (NAME)>
<!ELEMENT LIMIT (#PCDATA)>
<!ELEMENT ELEMENTS_NOT_ADDED (CONTACT_LIST | GROUP_LIST |
GROUP_MEMBER_LIST)>
<!ELEMENT MAX_SIZE_REACHED (LIMIT, ELEMENTS_NOT_ADDED)>
<!ELEMENT ALREADY_EXISTS (GROUP | CONTACT | MDN)>
<!ELEMENT ENTRY_NOT_FOUND (SUBSCRIBER | GROUP | CONTACT | MDN)>
<!ELEMENT MIN_MDN_MISMATCH (#PCDATA)>
<!ELEMENT LOGIN_FAILURE (#PCDATA)>
<!ELEMENT PASSWORD_MODIFICATION_FAILURE (#PCDATA)>
68P09278A36-A
FEB 2007
B-3
B-1
68P09278A36-A
FEB 2007
*68P09278A36-A*
68P09278A36-A
Technical
Information
ENGLISH
FEB 2007
68P09278A36-A
ENGLISH
FEB 2007
68P09278A36-A
68P09278A36-A
Manual Title
Date
FEB 2007
CSD/CND (US)
Binder
Printing
Finishing
3 Slant D-ring binder - letter size (11.75 in x 11.5 in) white PVC.
Body- printed double sided onto white letter size (8.5 in x 11 in) 70 lb.
Logo 2 means that the product may contain substances in excess of the
maximum concentration value for materials identified in the China
Management Methods regulation, and has an Environmental Friendly
Use Period (EFUP) in years, fifty years in the example shown.
Logo 1
Logo 2
The Environmental Friendly Use Period (EFUP) is the period (in years) during
which the Toxic and Hazardous Substances (T&HS) contained in the Electronic
Information Product (EIP) will not leak or mutate causing environmental pollution
or bodily injury from the use of the EIP. The EFUP indicated by the Logo 2 label
applies to a product and all its parts. Certain field-replaceable parts, such as
battery modules, can have a different EFUP and are marked separately.
The Disclosure Table is intended only to communicate compliance with China
requirements; it is not intended to communicate compliance with EU RoHS or any
other environmental requirements.
68P02901W00-E