GroupWise SDK: Administration REST API Guide

GroupWise

®

Software Developer Kit

Administration REST API Guide

April 2024

2

Legal Notices

The only warranties for products and services of Open Text and its affiliates and licensors (“Open Text”) are as may be set

forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as

constituting an additional warranty. Open Text shall not be liable for technical or editorial errors or omissions contained

herein. The information contained herein is subject to change without notice.

Contents 3

Contents

About This Guide 7

1Overview 9

Information Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

GroupWise Administration Architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

GroupWise Admin Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

GroupWise Admin API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

Directory Independence for Your GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Sample Code for the Admin API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Supported and Recommended GroupWise APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

2 Working with the GroupWise Administration Service 13

3Admin API Resources 15

A Sample Requests and Responses 17

Requesting a List of Domains in the GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Requesting a List of Post Offices in a Domain. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

Requesting a List of Users in the GroupWise System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Requesting a List of Users in the GroupWise System Using a Wildcard Character . . . . . . . . . . . . . . . . . . . .33

Requesting a List of Users in a Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Requesting a List of Users in a Post Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Requesting a List of User Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42

Requesting a List of Groups in the GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Requesting a List of Groups in a Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46

Requesting a List of Groups in a Post Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Requesting a List of Group Memberships for a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Requesting a List of Members in a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Requesting a List of Resources in the GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51

Requesting a List of Resources in a Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Requesting a List of Resources in a Post Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Requesting a List of Resources That a User Owns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Requesting a List of Nicknames in the GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Requesting a List of Nicknames in a Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Requesting a List of Nicknames in a Post Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Requesting a List of Nicknames for a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Requesting Statistical Information about the GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67

Requesting Configuration Information about the GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Requesting Configuration Information about a Domain . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Requesting Configuration Information about an MTA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Requesting Configuration Information about a POA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Creating a GroupWise User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85

4

Creating an External User. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Creating a GroupWise User with Chinese Characters in the Last Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . .87

Updating a User’s First Name That Has Chinese Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88

Renaming a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Creating a GroupWise Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Adding a Member to a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Updating the Participation of a Member of a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90

Requesting an Access Control List for a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90

Creating a GroupWise Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Creating a GroupWise Nickname. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93

Finding a Domain by Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93

Finding a Domain by Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Finding a Post Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100

Finding a User in the GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105

Finding a User in a Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107

Finding a User in a Post Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110

Finding a User in a Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115

Finding a User’s Last Name That Has Chinese Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116

Finding a Group in the GroupWise System . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118

Finding a Group in a Post Office. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119

Finding a Resource in the GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122

Finding a Resource in a Post Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124

Finding a Nickname in the GroupWise System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127

Finding a Nickname in a Post Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130

Moving Users to a Different Post Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133

Moving a Group to a Different Post Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134

Moving a Resource to a Different Post Office. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135

Deleting a User from the GroupWise System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136

Deleting a User That Owns Resources from the GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137

Deleting a User That Has Been Moved from the GroupWise System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138

Deleting a Group from the GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138

Deleting a Member from a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138

Deleting a Resource from the GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139

Deleting a Nickname from the GroupWise System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139

Requesting the Client Options for a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139

Updating the Client Options of a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .197

Setting the GroupWise Password of a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .232

Clearing the GroupWise Password of a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233

Restoring the Compose Views of a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . .233

Modifying the Send Priority Settings of a User. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .234

Modifying the Calendar Settings of a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .234

Modifying the Alarm Settings of a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .235

Disabling and Locking the Publish Free Busy Setting of a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

Enabling the Vibe Access and Configuring the Vibe URL of a User. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

Performing a Batch Operation to Add Members to a Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .237

Performing a Batch Operation to Modify Members of a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .238

Performing a Batch Operation to Add ACL Members to a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239

Performing a Batch Operation to Modify ACL Members of a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240

Creating a Trusted Application Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241

5

Updating a Trusted Application Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242

Deleting a Trusted Application Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .243

B Valid and Invalid Characters 245

Invalid Characters in GroupWise Object Names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .245

Valid Characters in Internet Email Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .245

6

About This Guide 7

About This Guide

GroupWise Administration API provides GroupWise developers with access to events and actions

that occur at the GroupWise Administration console.

This guide contains the following sections:

 Chapter 1, “Overview,” on page 9

 Chapter 2, “Working with the GroupWise Administration Service,” on page 13

 Chapter 3, “Admin API Resources,” on page 15

 Appendix A, “Sample Requests and Responses,” on page 17

 Appendix B, “Valid and Invalid Characters,” on page 245

Audience

This guide is intended for GroupWise developers.

Feedback

We want to hear your comments and suggestions about this manual and the other documentation

included with this product. Please use the

comment on this topic feature at the bottom of each page

of the online documentation.

Documentation Updates

For the most recent version of this guide, see the GroupWise Documentation website.

Documentation Conventions

In Open Text documentation, a greater-than symbol (>) is used to separate actions within a step and

items in a cross-reference path.

8 About This Guide

1

Overview 9

1

Overview

In order for the GroupWise Administration console to be available, the GroupWise Administration

service must be running. The GroupWise Administration API provides GroupWise developers with

access to events and actions that occur at the GroupWise Administration console. The GroupWise

Administration API uses Representational State Transfer (REST) architectural principals.

 “Information Resources” on page 9

 “GroupWise Administration Architecture” on page 10

 “GroupWise Admin Console” on page 10

 “GroupWise Admin API” on page 10

 “Directory Independence for Your GroupWise System” on page 11

 “Sample Code for the Admin API” on page 11

 “Supported and Recommended GroupWise APIs” on page 12

Information Resources

Before working with the GroupWise Admin API, you should be familiar with the following sources of

information:

 Novell Developer Forum (http://forums.novell.com/forum.php)

 GroupWise Documentation website (https://www.novell.com/documentation/groupwise18/)

 REST (http://en.wikipedia.org/wiki/REST)

 JSON (http://www.json.org)

 jQuery (http://jquery.com)

 AJAX (http://api.jquery.com/jQuery.ajax)

 Jersey (http://jersey.java.net)

 Maven (http://maven.apache.org)

 Open API Interface (http://en.wikipedia.org/wiki/Open_API)

 CRUD Operations (http://en.wikipedia.org/wiki/Create,_read,_update_and_delete)

 Token-based Authentication (http://en.wikipedia.org/wiki/Security_token)

10 Overview

GroupWise Administration Architecture

Starting in GroupWise 2014, the GroupWise Admin service provides the GroupWise Admin console

for managing your GroupWise system. The GroupWise Admin console replaces ConsoleOne, which

was the GroupWise administration tool for earlier versions of GroupWise.

The GroupWise Admin service is automatically installed on each server where you create domains

and post offices and install the GroupWise agents:

 Message Transfer Agent (MTA)

 Post Office Agent (POA)

 Document Viewer Agent (DVA)

 Internet Agent (GWIA)

 Monitor Agent

Because GroupWise administration is handled by a web service, you can access it from your web

browser. You do not need to be on a specific machine where specific administration software has

been installed. You do not need drive mappings to servers throughout your GroupWise system.

GroupWise Admin Console

The GroupWise agents have long had web consoles. The web-based GroupWise Admin console now

provides all required administration functionality that was provided by ConsoleOne in earlier

versions of GroupWise.

The GroupWise Admin console is available at the following URL:

https://ip_address:9710/gwadmin-console

The GroupWise Administration Guide details how to use the GroupWise Admin console to manage

your GroupWise system.

GroupWise Admin API

The GroupWise Admin API provides you with access to events and actions that occur at the

GroupWise Admin console.

The Admin API is available at the following URL:

https://server_address:9710/gwadmin-service/static/apidocs/index.html

Overview 11

The main Admin API page appears:

This guide details how to use the Admin API to customize GroupWise administration. In addition,

online documentation located on each GroupWise server provides a complete list of Admin API

resources through the

Detailed Documentation links on the Admin API page.

Directory Independence for Your GroupWise System

Versions of GroupWise before GroupWise 2014 were dependent on NetIQ eDirectory for the storage

of object data. GroupWise can store all its object data internally (using no external directory

service), or it can be configured to integrate with NetIQ eDirectory, Microsoft Active Directory, or

any other LDAP directory service.

When you initially install GroupWise, it is not configured to integrate with any directory service.

When you update from an earlier version of GroupWise, you can configure GroupWise to continue

to integrate with eDirectory, or you can configure it differently as needed.

Although GroupWise can be configured to not use a directory service, directory services have

advantages:

 User information such as login credentials can be accessed by GroupWise as well as by other

user applications across your network.

 Administrative roles can be defined so that GroupWise administrators can be authorized to

perform various subsets of administrative tasks.

If you choose to use a directory service with GroupWise, object data can be synchronized from the

directory service to GroupWise as needed. Synchronization from GroupWise to the directory service

is not yet available in GroupWise.

Sample Code for the Admin API

Two Readmes help you use the sample code that is available for the Admin API:

 GroupWIse Admin SDK Readme (

gwsdk_gwadminweb_readme.txt

)

12 Overview

The SDK Readme covers the documentation and sample code that is included in the SDK.

 GroupWise Admin API Sample Code Readme (

readme.txt

)

The API Sample Code Readme is located in the

docs

subdirectory of the SDK download. It

covers system requirements and instructions for working with the sample code.

Sample Requests and Responses provides detailed examples of JSON and XML requests and

responses:

 “Samples by GroupWise Object” on page 17

 “Samples by Task” on page 19

Supported and Recommended GroupWise APIs

 The GroupWise Administration (REST) API is fully supported for use with GroupWise 18 and

beyond.

 The GroupWise Web Service (SOAP) API is fully supported for use with GroupWise 18 and

beyond.

It is also supported with GroupWise 2012 and GroupWise 8.

 The GroupWise Administration Object API is no longer supported and has limited application in

GroupWise 18 and later versions.

As long as existing eDirectory objects are still present, the Admin Object API will continue to

work with GroupWise 18 and later versions. We recommend moving to the new GroupWise

Administration (REST) API. The capabilities provided by the legacy Admin Object API are

provided much more effectively by the Administration (REST) API and the Web Service (SOAP)

API.

2

Working with the GroupWise Administration Service 13

2

Working with the GroupWise

Administration Service

The GroupWise Administration service is installed and configured wherever you install the

GroupWise agents. For system requirements and installation instructions, see the GroupWise

Installation Guide.

14 Working with the GroupWise Administration Service

3

Admin API Resources 15

3

Admin API Resources

Documentation for the GroupWise Admin API is available on the server where the Admin service is

installed:

https://server_address:9710/gwadmin-service/static/apidocs/index.html

The Detailed Documentation link provides a complete resources listing of the APIs available.

IMPORTANT: Refer to the listing displayed on your GroupWise server for the most current

information. The information in this guide might not be as current as the information available on

your GroupWise server.

A copy of the GroupWise Admin REST API resource documentation can be found at the following

link: gwadmin-service

16 Admin API Resources

A

Sample Requests and Responses 17

A

Sample Requests and Responses

Samples by GroupWise Object

GroupWise Objects Tasks

 GroupWise system Requesting Statistical Information about the GroupWise System

Requesting Configuration Information about the GroupWise System

 Domains Requesting a List of Domains in the GroupWise System

Requesting Configuration Information about a Domain

Finding a Domain by Name

Finding a Domain by Type

 Post offices Requesting a List of Post Offices in a Domain

Finding a Post Office

 Users Requesting a List of Users in the GroupWise System

Requesting a List of Users in the GroupWise System Using a Wildcard Character

Requesting a List of Users in a Domain

Requesting a List of Users in a Post Office

Requesting a List of User Attributes

Creating a GroupWise User

Creating an External User

Adding a Member to a Group

Renaming a User

Moving Users to a Different Post Office

Finding a User in the GroupWise System

Finding a User in a Domain

Finding a User in a Post Office

Requesting a List of Group Memberships for a User

Requesting a List of Nicknames for a User

Requesting a List of Resources That a User Owns

Requesting the Client Options for a User

18 Sample Requests and Responses

 Groups Requesting a List of Groups in the GroupWise System

Requesting a List of Groups in a Domain

Requesting a List of Groups in a Post Office

Requesting a List of Group Memberships for a User

Requesting an Access Control List for a Group

Creating a GroupWise Group

Adding a Member to a Group

Updating the Participation of a Member of a Group

Moving a Group to a Different Post Office

Performing a Batch Operation to Add Members to a Group

Performing a Batch Operation to Modify Members of a Group

Performing a Batch Operation to Add ACL Members to a Group

Performing a Batch Operation to Modify ACL Members of a Group

 Resources Requesting a List of Resources in the GroupWise System

Requesting a List of Resources in a Domain

Requesting a List of Resources in a Post Office

Requesting a List of Resources That a User Owns

Creating a GroupWise Resource

Moving a Resource to a Different Post Office

 Nicknames Requesting a List of Nicknames in the GroupWise System

Requesting a List of Nicknames in a Domain

Requesting a List of Nicknames in a Post Office

Requesting a List of Nicknames for a User

Creating a GroupWise Nickname

 Agents Requesting Configuration Information about an MTA

Requesting Configuration Information about a POA

 Trusted applications Creating a Trusted Application Record

Updating a Trusted Application Record

Deleting a Trusted Application Record

GroupWise Objects Tasks

Sample Requests and Responses 19

Samples by Task

Tasks Related GroupWise Objects

 Requesting a list Requesting a List of Domains in the GroupWise System

Requesting a List of Post Offices in a Domain

Requesting a List of Users in the GroupWise System

Requesting a List of Users in the GroupWise System Using a Wildcard Character

Requesting a List of Users in a Domain

Requesting a List of Users in a Post Office

Requesting a List of User Attributes

Requesting a List of Groups in the GroupWise System

Requesting a List of Groups in a Domain

Requesting a List of Groups in a Post Office

Requesting a List of Group Memberships for a User

Requesting an Access Control List for a Group

Requesting a List of Resources in the GroupWise System

Requesting a List of Resources in a Domain

Requesting a List of Resources in a Post Office

Requesting a List of Resources That a User Owns

Requesting a List of Nicknames in the GroupWise System

Requesting a List of Nicknames in a Domain

Requesting a List of Nicknames in a Post Office

Requesting a List of Nicknames for a User

Requesting Configuration Information about a POA

 Requesting

information

Requesting Statistical Information about the GroupWise System

Requesting Configuration Information about the GroupWise System

Requesting Configuration Information about a Domain

Requesting Configuration Information about an MTA

Requesting the Client Options for a User

 Creating Creating a GroupWise User

Creating an External User

Creating a GroupWise Group

Creating a GroupWise Resource

Creating a GroupWise Nickname

Creating a Trusted Application Record

 Renaming Renaming a User

 Finding Finding a Domain by Name

Finding a Domain by Type

Finding a Post Office

Finding a User in the GroupWise System

Finding a User in a Domain

Finding a User in a Post Office

20 Sample Requests and Responses

Requesting a List of Domains in the GroupWise System

Request:

GET https://localhost:9710/gwadmin-service/domains

Response Status:

200 - OK

JSON Response:

[ {

"id" : "DOMAIN.testDom1",

"guid" : "BC755C40-086F-0000-AE24-CEFE66AF19D4",

"name" : "testDom1",

"links" : null,

"timeCreated" : null,

"timeLastMod" : 1370885999000,

"legacyDn" : null,

 Moving Moving Users to a Different Post Office

Moving a Group to a Different Post Office

Moving a Resource to a Different Post Office

 Deleting Deleting a User from the GroupWise System

Deleting a User That Owns Resources from the GroupWise System

Deleting a User That Has Been Moved from the GroupWise System

Deleting a Group from the GroupWise System

Deleting a Member from a Group

Deleting a Resource from the GroupWise System

Deleting a Nickname from the GroupWise System

 Modifying Client

Options

Requesting the Client Options for a User

Updating the Client Options of a User

Setting the GroupWise Password of a User

Clearing the GroupWise Password of a User

Restoring the Compose Views of a User

Modifying the Send Priority Settings of a User

Modifying the Calendar Settings of a User

Modifying the Alarm Settings of a User

Disabling and Locking the Publish Free Busy Setting of a User

Enabling the Vibe Access and Configuring the Vibe URL of a User

 Working with

double-byte

characters

Creating a GroupWise User with Chinese Characters in the Last Name

Updating a User’s First Name That Has Chinese Characters

Finding a User’s Last Name That Has Chinese Characters

 Performing batch

operations

Performing a Batch Operation to Add Members to a Group

Performing a Batch Operation to Modify Members of a Group

Performing a Batch Operation to Add ACL Members to a Group

Performing a Batch Operation to Modify ACL Members of a Group

Tasks Related GroupWise Objects

Sample Requests and Responses 21

"lastModifiedBy" : "Unknown admin",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"allowedAddressFormats" : null,

"addressBookView" : null,

"alternateInternetAgentName" : null,

"enableICalBrowse" : null,

"databaseVersion" : null,

"defaultInternetAgentName" : null,

"defaultWebAccess" : null,

"description" : null,

"directoryName" : null,

"directorySyncDomainName" : "testDom1",

"domainRebuildCount" : 0,

"domainType" : "PRIMARY",

"domainVersion" : 1212,

"externalSync" : null,

"fileId" : "tesf6f",

"gwId" : null,

"hideUserComments" : null,

"internetDomainName" : null,

"language" : "English - US",

"languageId" : "0",

"linkedDomainName" : null,

"lockoutOldAdmin" : null,

"minimumAdminReleaseDate" : null,

"minimumAdminVersion" : null,

"platform" : null,

"preferredAddressFormat" : null,

"timezone" : "(GMT-07:00) Mountain Time (US & Canada)",

"timezoneId" : "MST",

"path" : "C:\\Novell\\GroupWise\\testDomain1\\",

"adminChanges" : null,

"mtaAddress" : null,

"mtaMtpPort" : null,

"mtaHttpPort" : null,

"mtaAdminPort" : null,

"remoteCreation" : null,

"notifyUser" : null,

"clearNotifyUser" : false,

"connected" : true,

"@type" : "domain",

"@url" : "/gwadmin-service/domains/testDom1"

}, {

"id" : "DOMAIN.testDom2",

"guid" : "5FC6CEE0-08FE-0000-8A08-5BB4E7C4BAB9",

"name" : "testDom2",

"links" : null,

"timeCreated" : 1370968862000,

"timeLastMod" : 1370968863000,

"legacyDn" : null,

"lastModifiedBy" : "Unknown admin",

"lastModifiedOp" : "MODIFY",

"pendingOp" : "MODIFY",

"allowedAddressFormats" : null,

22 Sample Requests and Responses

"addressBookView" : null,

"alternateInternetAgentName" : null,

"enableICalBrowse" : null,

"databaseVersion" : null,

"defaultInternetAgentName" : null,

"defaultWebAccess" : null,

"description" : null,

"directoryName" : null,

"directorySyncDomainName" : "testDom2",

"domainRebuildCount" : 1,

"domainType" : "SECONDARY",

"domainVersion" : 1212,

"externalSync" : null,

"fileId" : "tesfebe",

"gwId" : null,

"hideUserComments" : null,

"internetDomainName" : null,

"language" : "English - US",

"languageId" : "0",

"linkedDomainName" : null,

"lockoutOldAdmin" : null,

"minimumAdminReleaseDate" : null,

"minimumAdminVersion" : null,

"platform" : null,

"preferredAddressFormat" : null,

"timezone" : "(GMT-07:00) Mountain Time (US & Canada)",

"timezoneId" : "MST",

"path" : "C:\\Novell\\GroupWise\\testDomain2",

"adminChanges" : null,

"mtaAddress" : null,

"mtaMtpPort" : null,

"mtaHttpPort" : null,

"mtaAdminPort" : null,

"remoteCreation" : null,

"notifyUser" : null,

"clearNotifyUser" : false,

"connected" : false,

"@type" : "domain",

"@url" : "/gwadmin-service/domains/testDom2"

}, {

"id" : "DOMAIN.testExtDom1",

"guid" : "7F95C180-0904-0000-8A08-C421ECE16D93",

"name" : "testExtDom1",

"links" : null,

"timeCreated" : 1370971492000,

"timeLastMod" : 1370971492000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"allowedAddressFormats" : null,

"addressBookView" : null,

"alternateInternetAgentName" : null,

"enableICalBrowse" : null,

"databaseVersion" : null,

Sample Requests and Responses 23

"defaultInternetAgentName" : null,

"defaultWebAccess" : null,

"description" : null,

"directoryName" : null,

"directorySyncDomainName" : "testExtDom1",

"domainRebuildCount" : 0,

"domainType" : "EXTERNAL_GROUPWISE",

"domainVersion" : 1212,

"externalSync" : null,

"fileId" : "tes904",

"gwId" : null,

"hideUserComments" : null,

"internetDomainName" : null,

"language" : "English - US",

"languageId" : "0",

"linkedDomainName" : null,

"lockoutOldAdmin" : null,

"minimumAdminReleaseDate" : null,

"minimumAdminVersion" : null,

"platform" : null,

"preferredAddressFormat" : null,

"timezone" : "(GMT-07:00) Mountain Time (US & Canada)",

"timezoneId" : "MST",

"path" : null,

"adminChanges" : null,

"mtaAddress" : null,

"mtaMtpPort" : null,

"mtaHttpPort" : null,

"mtaAdminPort" : null,

"remoteCreation" : null,

"notifyUser" : null,

"clearNotifyUser" : false,

"connected" : false,

"@type" : "domain",

"@url" : "/gwadmin-service/domains/testExtDom1"

} ]

XML Response:

<list>

<id>DOMAIN.testDom1</id>

<name>testDom1</name>

<objType>domain</objType>

<url>/gwadmin-service/domains/testDom1</url>

<lastModifiedBy>Unknown admin</lastModifiedBy>

<directorySyncDomainName>testDom1</directorySyncDomainName>

<domainType>PRIMARY</domainType>

<language>English - US</language>

24 Sample Requests and Responses

<timezone>(GMT-07:00) Mountain Time (US & Canada)</timezone>

<path>C:\Novell\GroupWise\testDomain1\</path>

<clearNotifyUser>false</clearNotifyUser>

</domain>

<id>DOMAIN.testDom2</id>

<name>testDom2</name>

<objType>domain</objType>

<url>/gwadmin-service/domains/testDom2</url>

<lastModifiedBy>Unknown admin</lastModifiedBy>

<lastModifiedOp>MODIFY</lastModifiedOp>

<pendingOp>MODIFY</pendingOp>

<directorySyncDomainName>testDom2</directorySyncDomainName>

<domainType>SECONDARY</domainType>

<fileId>tesfebe</fileId>

<language>English - US</language>

<timezone>(GMT-07:00) Mountain Time (US & Canada)</timezone>

<path>C:\Novell\GroupWise\testDomain2</path>

<clearNotifyUser>false</clearNotifyUser>

<connected>false</connected>

</domain>

<id>DOMAIN.testExtDom1</id>

<name>testExtDom1</name>

<objType>domain</objType>

<url>/gwadmin-service/domains/testExtDom1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

Sample Requests and Responses 25

<directorySyncDomainName>testExtDom1</directorySyncDomainName>

<domainType>EXTERNAL_GROUPWISE</domainType>

<language>English - US</language>

<timezone>(GMT-07:00) Mountain Time (US & Canada)</timezone>

<clearNotifyUser>false</clearNotifyUser>

<connected>false</connected>

</domain>

</list>

Requesting a List of Post Offices in a Domain

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices

Response Status:

200 - OK

JSON Response:

[ {

"id" : "POST_OFFICE.testDom1.testPO1",

"guid" : "56A986B0-0870-0000-8A08-FB644894ACE1",

"name" : "testPO1",

"links" : null,

"timeCreated" : 1370907858000,

"timeLastMod" : 1370907860000,

"legacyDn" : null,

"lastModifiedBy" : "Unknown admin",

"lastModifiedOp" : "MODIFY",

"pendingOp" : null,

"adminChanges" : null,

"accessMode" : "CLIENT_SERVER",

"allowedAddressFormats" : null,

"archiveServiceTrustedAppName" : null,

"clientLockout" : null,

"clientLockoutDate" : null,

"clientLockoutVersion" : null,

"defaultInternetAgentName" : null,

"description" : null,

"domainName" : "testDom1",

"deliveryMode" : "APP_THRESHOLD",

"disableDeltaRecords" : null,

"disableLdapPasswordChange" : null,

"disableLiveMove" : null,

"disableLogins" : false,

"deltaRecordsMaxAge" : null,

"enableICalBrowse" : null,

"externalRecord" : false,

"externalSync" : null,

26 Sample Requests and Responses

"fileId" : "tes1072",

"gwId" : null,

"internetDomainName" : null,

"intruderDetection" : true,

"intruderLockoutAttempts" : 5,

"intruderLockoutAttemptsInterval" : 30,

"intruderLockoutResetInterval" : 30,

"language" : "English - US",

"languageId" : "0",

"ldapDefaultDirectory" : null,

"ldapUser" : null,

"ldapPassword" : null,

"ldapInactiveConnectionTimeout" : null,

"ldapPoolServerResetTimeout" : null,

"ldapQuarantineThreshold" : null,

"linkAddress" : "C:\\Novell\\GroupWise\\testPostOffice1",

"linkAddressType" : "TCP_IP",

"mtpAppName" : "POA",

"mtpMaxSendSize" : null,

"platform" : null,

"postOfficeVersion" : 1212,

"preferredAddressFormat" : null,

"remoteUser" : null,

"remotePassword" : null,

"restoreAreaName" : null,

"securitySettings" : [ "HIGH" ],

"softwareAreaGuid" : null,

"softwareVersion" : null,

"syncContext" : null,

"timezone" : "(GMT-07:00) Mountain Time (US & Canada)",

"timezoneId" : "MST",

"path" : "C:\\Novell\\GroupWise\\testPostOffice1",

"associationsUpdate" : null,

"poaAddress" : null,

"poaCsPort" : null,

"poaMtpPort" : null,

"poaHttpPort" : null,

"timeStamp" : null,

"clientUpdateBumpNumber" : 0,

"poaAdminPort" : null,

"remoteCreation" : null,

"displayName" : "testPO1",

"draggable" : true,

"@type" : "postOffice",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1"

} ]

XML Response:

<list>

<id>POST_OFFICE.testDom1.testPO1</id>

<name>testPO1</name>

<objType>postOffice</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1</url>

Sample Requests and Responses 27

<lastModifiedBy>Unknown admin</lastModifiedBy>

<lastModifiedOp>MODIFY</lastModifiedOp>

<accessMode>CLIENT_SERVER</accessMode>

<domainName>testDom1</domainName>

<deliveryMode>APP_THRESHOLD</deliveryMode>

<disableLogins>false</disableLogins>

<externalEntity>false</externalEntity>

<externalRecord>false</externalRecord>

<language>English - US</language>

<linkAddress>C:\Novell\GroupWise\testPostOffice1</linkAddress>

<timezone>(GMT-07:00) Mountain Time (US & Canada)</timezone>

<path>C:\Novell\GroupWise\testPostOffice1</path>

</postOffice>

</list>

Requesting a List of Users in the GroupWise System

JSON Request:

GET/XML https://localhost:9710/gwadmin-service/list/USER

Response Status:

200 - OK

JSON Response:

[ {

"id" : "USER.testDom1.testPO1.testChineseUser1",

"guid" : "3D438970-09EF-0000-8A08-20888CC82C5A",

"name" : "testChineseUser1",

"links" : null,

"timeCreated" : 1371072312000,

"timeLastMod" : 1371072312000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

28 Sample Requests and Responses

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "77i",

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "????",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

Sample Requests and Responses 29

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "user",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testChineseUser1"

}, {

"id" : "USER.testExtDom1.testExtPO1.testExtUser1",

"guid" : null,

"name" : "testExtUser1",

"links" : null,

"timeCreated" : 1371072312000,

"timeLastMod" : 1371072312000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testExtDom1",

"postOfficeName" : "testExtPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : true,

"externalSync" : null,

"fileId" : null,

"accountId" : null,

"city" : null,

"company" : null,

30 Sample Requests and Responses

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : null,

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "user",

Sample Requests and Responses 31

"@url" : "/gwadmin-service/domains/testExtDom1/postoffices/testExtPO1/

users/testExtUser1"

}, {

"id" : "USER.testDom1.testPO1.testUser1",

"guid" : "3C0BF3D0-09EF-0000-8A08-20888CC82C5A",

"name" : "testUser1",

"links" : null,

"timeCreated" : 1371072310000,

"timeLastMod" : 1371072310000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "fri",

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

32 Sample Requests and Responses

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "testSurname1",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "user",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1"

} ]

XML Response:

<list>

<user>

<id>USER.testDom1.testPO1.testChineseUser1</id>

<name>testChineseUser1</name>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testChineseUser1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

Sample Requests and Responses 33

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

</user>

<user>

<id>USER.testExtDom1.testExtPO1.testExtUser1</id>

<name>testExtUser1</name>

<url>/gwadmin-service/domains/testExtDom1/postoffices/testExtPO1/

users/testExtUser1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testExtDom1</domainName>

<postOfficeName>testExtPO1</postOfficeName>

<visibility>SYSTEM</visibility>

</user>

<user>

<id>USER.testDom1.testPO1.testUser1</id>

<name>testUser1</name>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<surname>testSurname1</surname>

</user>

</list>

Requesting a List of Users in the GroupWise System Using a

Wildcard Character

Request:

GET https://localhost:9710/gwadmin-service/list/USER?name=testGroupMember*

Response Status:

200 - OK

NOTE: The

?name

query automatically does end of name wildcard searching.

34 Sample Requests and Responses

Requesting a List of Users in a Domain

Request:

GET https://localhost:9710/gwadmin-service/list/USER/DOMAIN.testDom1

Response Status:

200 - OK

JSON Response:

[ {

"id" : "USER.testDom1.testPO1.testChineseUser1",

"guid" : "3D438970-09EF-0000-8A08-20888CC82C5A",

"name" : "testChineseUser1",

"links" : null,

"timeCreated" : 1371072312000,

"timeLastMod" : 1371072312000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "77i",

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

Sample Requests and Responses 35

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "????",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "user",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testChineseUser1"

}, {

"id" : "USER.testDom1.testPO1.testUser1",

"guid" : "3C0BF3D0-09EF-0000-8A08-20888CC82C5A",

"name" : "testUser1",

"links" : null,

"timeCreated" : 1371072310000,

"timeLastMod" : 1371072310000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

36 Sample Requests and Responses

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "fri",

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "testSurname1",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

Sample Requests and Responses 37

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "user",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1"

} ]

XML Response:

<list>

<user>

<id>USER.testDom1.testPO1.testChineseUser1</id>

<name>testChineseUser1</name>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testChineseUser1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

</user>

<user>

<id>USER.testDom1.testPO1.testUser1</id>

<name>testUser1</name>

38 Sample Requests and Responses

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<surname>testSurname1</surname>

</user>

</list>

Requesting a List of Users in a Post Office

Request:

GET https://localhost:9710/gwadmin-service/list/USER/

POST_OFFICE.testDom1.testPO1

Response Status:

200 - OK

JSON Response:

[ {

"id" : "USER.testDom1.testPO1.testChineseUser1",

"guid" : "3D438970-09EF-0000-8A08-20888CC82C5A",

"name" : "testChineseUser1",

"links" : null,

"timeCreated" : 1371072312000,

"timeLastMod" : 1371072312000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

Sample Requests and Responses 39

"externalSync" : null,

"fileId" : "77i",

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "????",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

40 Sample Requests and Responses

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "user",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testChineseUser1"

}, {

"id" : "USER.testDom1.testPO1.testUser1",

"guid" : "3C0BF3D0-09EF-0000-8A08-20888CC82C5A",

"name" : "testUser1",

"links" : null,

"timeCreated" : 1371072310000,

"timeLastMod" : 1371072310000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "fri",

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

Sample Requests and Responses 41

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "testSurname1",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "user",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1"

} ]

XML Response:

<list>

<user>

<id>USER.testDom1.testPO1.testChineseUser1</id>

<name>testChineseUser1</name>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testChineseUser1</url>

42 Sample Requests and Responses

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

</user>

<user>

<id>USER.testDom1.testPO1.testUser1</id>

<name>testUser1</name>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<surname>testSurname1</surname>

</user>

</list>

Requesting a List of User Attributes

Request:

GET https://localhost:9710/gwadmin-service/diagnostics/object/

USER.testDom1.testPO1.testUser1

Response Status:

200 - OK

JSON Response:

{

"attr" : [ {

"@id" : "50073",

"$" : "testUser1"

}, {

"@id" : "50072",

"$" : "4"

}, {

"@id" : "58014",

"$" : "testDom1"

}, {

"@id" : "59019",

"$" : "admin.testSystem1"

}, {

Sample Requests and Responses 43

"@id" : "50101",

"$" : "0"

}, {

"@id" : "50087",

"$" : "1"

}, {

"@id" : "50080",

"$" : "3C0BF3D0-09EF-0000-8A08-20888CC82C5A"

}, {

"@id" : "50144",

"$" : "1"

}, {

"@id" : "50038",

"$" : "fri"

}, {

"@id" : "50035",

"$" : "testDom1"

}, {

"@id" : "50064",

"$" : "1371072310"

}, {

"@id" : "50001",

"$" : "2"

}, {

"@id" : "50062",

"$" : "testPO1"

}, {

"@id" : "50093",

"$" : "testSurname1"

}, {

"@id" : "63096",

"$" : "1"

}, {

"@id" : "61109",

"$" : "1371072310"

}, {

"@id" : "50076",

"$" : "2"

}, {

"@id" : "50075",

"$" : "6"

} ],

"@id" : "USER.testDom1.testPO1.testUser1"

}

XML Response:

<id>USER.testDom1.testPO1.testUser1</id>

<attr>

<value>testUser1</value>

</objectAttributes>

44 Sample Requests and Responses

</objectAttributes>

<value>testDom1</value>

</objectAttributes>

<value>admin.testSystem1</value>

</objectAttributes>

</objectAttributes>

</objectAttributes>

</objectAttributes>

</objectAttributes>

</objectAttributes>

<value>testDom1</value>

</objectAttributes>

</objectAttributes>

</objectAttributes>

<value>testPO1</value>

</objectAttributes>

<value>testSurname1</value>

</objectAttributes>

</objectAttributes>

Sample Requests and Responses 45

</objectAttributes>

</objectAttributes>

</objectAttributes>

</attr>

</objectAttributes>

Requesting a List of Groups in the GroupWise System

Request:

GET https://localhost:9710/gwadmin-service/list/GROUP

Response Status:

200 - OK

JSON Response:

[ {

"id" : "GROUP.testDom1.testPO1.testGroup1",

"guid" : "3D593450-09EF-0000-8A08-20888CC82C5A",

"name" : "testGroup1",

"links" : null,

"timeCreated" : 1371072313000,

"timeLastMod" : 1371072313000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "POST_OFFICE",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"postOffice" : null,

"groupType" : "DISTRIBUTION_LIST",

"replicationOverride" : null,

"exclusiveInternetDomain" : false,

"groupAccessControlUpdateList" : null,

46 Sample Requests and Responses

"groupMembershipUpdateList" : null,

"externalSync" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "group",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/groups/

testGroup1"

} ]

XML Response:

<list>

<group>

<id>GROUP.testDom1.testPO1.testGroup1</id>

<name>testGroup1</name>

<objType>group</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/groups/

testGroup1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>POST_OFFICE</visibility>

<groupType>DISTRIBUTION_LIST</groupType>

<exclusiveInternetDomain>false</exclusiveInternetDomain>

</group>

</list>

Requesting a List of Groups in a Domain

Request:

GET https://localhost:9710/gwadmin-service/list/GROUP/DOMAIN.testDom1

Response Status:

200 - OK

JSON Response:

[ {

"id" : "GROUP.testDom1.testPO1.testGroup1",

"guid" : "3D593450-09EF-0000-8A08-20888CC82C5A",

"name" : "testGroup1",

"links" : null,

"timeCreated" : 1371072313000,

"timeLastMod" : 1371072313000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

Sample Requests and Responses 47

"emailAddresses" : null,

"visibility" : "POST_OFFICE",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"postOffice" : null,

"groupType" : "DISTRIBUTION_LIST",

"replicationOverride" : null,

"exclusiveInternetDomain" : false,

"groupAccessControlUpdateList" : null,

"groupMembershipUpdateList" : null,

"externalSync" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "group",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/groups/

testGroup1"

} ]

XML Response:

<list>

<group>

<id>GROUP.testDom1.testPO1.testGroup1</id>

<name>testGroup1</name>

<objType>group</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/groups/

testGroup1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>POST_OFFICE</visibility>

<groupType>DISTRIBUTION_LIST</groupType>

<exclusiveInternetDomain>false</exclusiveInternetDomain>

</group>

</list>

48 Sample Requests and Responses

Requesting a List of Groups in a Post Office

Request:

GET https://localhost:9710/gwadmin-service/list/GROUP/

POST_OFFICE.testDom1.testPO1

Response Status:

200 - OK

JSON Response:

[ {

"id" : "GROUP.testDom1.testPO1.testGroup1",

"guid" : "3D593450-09EF-0000-8A08-20888CC82C5A",

"name" : "testGroup1",

"links" : null,

"timeCreated" : 1371072313000,

"timeLastMod" : 1371072313000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "POST_OFFICE",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"postOffice" : null,

"groupType" : "DISTRIBUTION_LIST",

"replicationOverride" : null,

"exclusiveInternetDomain" : false,

"groupAccessControlUpdateList" : null,

"groupMembershipUpdateList" : null,

"externalSync" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "group",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/groups/

testGroup1"

} ]

XML Response:

<list>

<group>

<id>GROUP.testDom1.testPO1.testGroup1</id>

Sample Requests and Responses 49

<name>testGroup1</name>

<objType>group</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/groups/

testGroup1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>POST_OFFICE</visibility>

<groupType>DISTRIBUTION_LIST</groupType>

<exclusiveInternetDomain>false</exclusiveInternetDomain>

</group>

</list>

Requesting a List of Group Memberships for a User

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/groupmemberships

Response Status:

200 - OK

JSON Response:

[ {

"id" : "GROUP.testDom1.testPO1.testGroup1",

"guid" : null,

"name" : "testGroup1",

"links" : null,

"timeCreated" : null,

"timeLastMod" : null,

"legacyDn" : null,

"lastModifiedBy" : null,

"lastModifiedOp" : null,

"pendingOp" : null,

"postOfficeName" : "testPO1",

"domainName" : "testDom1",

"givenName" : null,

"participation" : "PRIMARY",

"type" : null,

"surname" : null,

"@type" : "membership",

"@url" : null

50 Sample Requests and Responses

} ]

XML Response:

<list>

<id>GROUP.testDom1.testPO1.testGroup1</id>

<name>testGroup1</name>

<objType>membership</objType>

<postOfficeName>testPO1</postOfficeName>

<domainName>testDom1</domainName>

<participation>PRIMARY</participation>

</member>

</list>

Requesting a List of Members in a Group

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/members

Response Status:

200 - OK

JSON Response:

[ {

"id" : "USER.testDom1.testPO1.testUser1",

"guid" : null,

"name" : "testUser1",

"links" : null,

"timeCreated" : null,

"timeLastMod" : null,

"legacyDn" : null,

"lastModifiedBy" : null,

"lastModifiedOp" : null,

"pendingOp" : null,

"postOfficeName" : "testPO1",

"domainName" : "testDom1",

"givenName" : null,

"participation" : "PRIMARY",

"type" : "USER",

"surname" : "testSurname1",

"@type" : "member",

"@url" : null

} ]

Sample Requests and Responses 51

XML Response:

<list>

<id>USER.testDom1.testPO1.testUser1</id>

<name>testUser1</name>

<objType>member</objType>

<postOfficeName>testPO1</postOfficeName>

<domainName>testDom1</domainName>

<participation>PRIMARY</participation>

<surname>testSurname1</surname>

</member>

</list>

Requesting a List of Resources in the GroupWise System

Request:

GET https://localhost:9710/gwadmin-service/list/RESOURCE

Response Status:

200 - OK

JSON Response:

[ {

"id" : "RESOURCE.testDom1.testPO1.testResource1",

"guid" : "3E3CB680-09EF-0000-8A08-20888CC82C5A",

"name" : "testResource1",

"links" : null,

"timeCreated" : 1371072314000,

"timeLastMod" : 1371072314000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

52 Sample Requests and Responses

"fileId" : "66e",

"owner" : "testUser1",

"postOffice" : null,

"resourceType" : "RESOURCE",

"telephoneNumber" : null,

"groupMembershipUpdateList" : null,

"nicknamesUrl" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "resource",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1"

} ]

XML Response:

<list>

<id>RESOURCE.testDom1.testPO1.testResource1</id>

<name>testResource1</name>

<objType>resource</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/resources/

testResource1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<owner>testUser1</owner>

<resourceType>RESOURCE</resourceType>

</resource>

</list>

Requesting a List of Resources in a Domain

Request:

GET https://localhost:9710/gwadmin-service/list/RESOURCE/DOMAIN.testDom1

Response Status:

200 - OK

JSON Response:

[ {

"id" : "RESOURCE.testDom1.testPO1.testResource1",

"guid" : "3E3CB680-09EF-0000-8A08-20888CC82C5A",

"name" : "testResource1",

"links" : null,

"timeCreated" : 1371072314000,

"timeLastMod" : 1371072314000,

"legacyDn" : null,

Sample Requests and Responses 53

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "66e",

"owner" : "testUser1",

"postOffice" : null,

"resourceType" : "RESOURCE",

"telephoneNumber" : null,

"groupMembershipUpdateList" : null,

"nicknamesUrl" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "resource",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1"

} ]

XML Response:

<list>

<id>RESOURCE.testDom1.testPO1.testResource1</id>

<name>testResource1</name>

<objType>resource</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/resources/

54 Sample Requests and Responses

testResource1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<owner>testUser1</owner>

<resourceType>RESOURCE</resourceType>

</resource>

</list>

Requesting a List of Resources in a Post Office

Request:

GET https://localhost:9710/gwadmin-service/list/RESOURCE/

POST_OFFICE.testDom1.testPO1

Response Status:

200 - OK

JSON Response:

[ {

"id" : "RESOURCE.testDom1.testPO1.testResource1",

"guid" : "3E3CB680-09EF-0000-8A08-20888CC82C5A",

"name" : "testResource1",

"links" : null,

"timeCreated" : 1371072314000,

"timeLastMod" : 1371072314000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

Sample Requests and Responses 55

"externalSync" : null,

"fileId" : "66e",

"owner" : "testUser1",

"postOffice" : null,

"resourceType" : "RESOURCE",

"telephoneNumber" : null,

"groupMembershipUpdateList" : null,

"nicknamesUrl" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "resource",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1"

} ]

XML Response:

<list>

<id>RESOURCE.testDom1.testPO1.testResource1</id>

<name>testResource1</name>

<objType>resource</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/resources/

testResource1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<owner>testUser1</owner>

<resourceType>RESOURCE</resourceType>

</resource>

</list>

Requesting a List of Resources That a User Owns

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/resources

Response Status:

200 - OK

JSON Response:

[ {

"id" : "RESOURCE.testDom1.testPO1.testResource1",

"guid" : "3E3CB680-09EF-0000-8A08-20888CC82C5A",

"name" : "testResource1",

"links" : null,

"timeCreated" : 1371072314000,

56 Sample Requests and Responses

"timeLastMod" : 1371072314000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "66e",

"owner" : "testUser1",

"postOffice" : null,

"resourceType" : "RESOURCE",

"telephoneNumber" : null,

"groupMembershipUpdateList" : null,

"nicknamesUrl" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "resource",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1"

} ]

XML Response:

<list>

<id>RESOURCE.testDom1.testPO1.testResource1</id>

<name>testResource1</name>

<objType>resource</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/resources/

Sample Requests and Responses 57

testResource1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<owner>testUser1</owner>

<resourceType>RESOURCE</resourceType>

</resource>

</list>

Requesting a List of Nicknames in the GroupWise System

Request:

GET https://localhost:9710/gwadmin-service/list/NICKNAME

Response Status:

200 - OK

JSON Response:

[ {

"id" : "NICKNAME.testDom1.testPO1.testNicknameName1",

"guid" : "3E2536E0-09EF-0000-8A08-20888CC82C5A",

"name" : "testNicknameName1",

"links" : null,

"timeCreated" : 1371072314000,

"timeLastMod" : 1371072314000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

58 Sample Requests and Responses

"fileId" : null,

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "testNicknameSurname1",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

Sample Requests and Responses 59

"mailboxLicenseType" : null,

"referredUserName" : null,

"userName" : "testUser1",

"userPostOfficeName" : "testPO1",

"userDomainName" : "testDom1",

"realMemberType" : "USER",

"moveComplete" : null,

"directoryUser" : false,

"@type" : "nickname",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

nicknames/testNicknameName1"

} ]

XML Response:

<list>

<id>NICKNAME.testDom1.testPO1.testNicknameName1</id>

<name>testNicknameName1</name>

<objType>nickname</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/nicknames/

testNicknameName1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<surname>testNicknameSurname1</surname>

<userName>testUser1</userName>

<userPostOfficeName>testPO1</userPostOfficeName>

<userDomainName>testDom1</userDomainName>

</nickname>

</list>

Requesting a List of Nicknames in a Domain

Request:

GET https://localhost:9710/gwadmin-service/list/NICKNAME/DOMAIN.testDom1

Response Status:

200 - OK

JSON Response:

[ {

"id" : "NICKNAME.testDom1.testPO1.testNicknameName1",

"guid" : "3E2536E0-09EF-0000-8A08-20888CC82C5A",

"name" : "testNicknameName1",

"links" : null,

"timeCreated" : 1371072314000,

"timeLastMod" : 1371072314000,

60 Sample Requests and Responses

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : null,

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "testNicknameSurname1",

"telephoneNumber" : null,

"title" : null,

Sample Requests and Responses 61

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"referredUserName" : null,

"userName" : "testUser1",

"userPostOfficeName" : "testPO1",

"userDomainName" : "testDom1",

"realMemberType" : "USER",

"moveComplete" : null,

"directoryUser" : false,

"@type" : "nickname",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

nicknames/testNicknameName1"

} ]

XML Response:

<list>

<id>NICKNAME.testDom1.testPO1.testNicknameName1</id>

<name>testNicknameName1</name>

<objType>nickname</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/nicknames/

testNicknameName1</url>

62 Sample Requests and Responses

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<surname>testNicknameSurname1</surname>

<userName>testUser1</userName>

<userPostOfficeName>testPO1</userPostOfficeName>

<userDomainName>testDom1</userDomainName>

</nickname>

</list>

Requesting a List of Nicknames in a Post Office

Request:

GET https://localhost:9710/gwadmin-service/list/NICKNAME/

POST_OFFICE.testDom1.testPO1

Response Status:

200 - OK

JSON Response:

[ {

"id" : "NICKNAME.testDom1.testPO1.testNicknameName1",

"guid" : "3E2536E0-09EF-0000-8A08-20888CC82C5A",

"name" : "testNicknameName1",

"links" : null,

"timeCreated" : 1371072314000,

"timeLastMod" : 1371072314000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

Sample Requests and Responses 63

"externalSync" : null,

"fileId" : null,

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "testNicknameSurname1",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

64 Sample Requests and Responses

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"referredUserName" : null,

"userName" : "testUser1",

"userPostOfficeName" : "testPO1",

"userDomainName" : "testDom1",

"realMemberType" : "USER",

"moveComplete" : null,

"directoryUser" : false,

"@type" : "nickname",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

nicknames/testNicknameName1"

} ]

XML Response:

<list>

<id>NICKNAME.testDom1.testPO1.testNicknameName1</id>

<name>testNicknameName1</name>

<objType>nickname</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/nicknames/

testNicknameName1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<surname>testNicknameSurname1</surname>

<userName>testUser1</userName>

<userPostOfficeName>testPO1</userPostOfficeName>

<userDomainName>testDom1</userDomainName>

</nickname>

</list>

Sample Requests and Responses 65

Requesting a List of Nicknames for a User

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/nicknames

Response Status:

200 - OK

JSON Response:

[ {

"id" : "NICKNAME.testDom1.testPO1.testNicknameName1",

"guid" : "3E2536E0-09EF-0000-8A08-20888CC82C5A",

"name" : "testNicknameName1",

"links" : null,

"timeCreated" : 1371072314000,

"timeLastMod" : 1371072314000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : null,

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

66 Sample Requests and Responses

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "testNicknameSurname1",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"referredUserName" : null,

"userName" : "testUser1",

"userPostOfficeName" : "testPO1",

"userDomainName" : "testDom1",

"realMemberType" : "USER",

"moveComplete" : null,

"directoryUser" : false,

"@type" : "nickname",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

nicknames/testNicknameName1"

} ]

XML Response:

Sample Requests and Responses 67

<list>

<id>NICKNAME.testDom1.testPO1.testNicknameName1</id>

<name>testNicknameName1</name>

<objType>nickname</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/nicknames/

testNicknameName1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<surname>testNicknameSurname1</surname>

<userName>testUser1</userName>

<userPostOfficeName>testPO1</userPostOfficeName>

<userDomainName>testDom1</userDomainName>

</nickname>

</list>

Requesting Statistical Information about the GroupWise

System

Request:

GET https://localhost:9710/gwadmin-service/system/info

Response Status:

200 - OK

JSON Response:

{

"id" : null,

"guid" : null,

"name" : null,

"links" : null,

"timeCreated" : null,

"timeLastMod" : null,

"legacyDn" : null,

"lastModifiedBy" : null,

"lastModifiedOp" : null,

"pendingOp" : null,

"externalDomainCount" : 1,

"externalGatewayCount" : 0,

"externalPostOfficeCount" : 1,

"domainCount" : 2,

"gatewayCount" : 1,

"postOfficeCount" : 2,

"lastAuditDate" : null,

"ownedResourceCount" : null,

68 Sample Requests and Responses

"gatewayAliasCount" : null,

"nicknameCount" : null,

"groupMembershipCount" : null,

"libraryAccessCount" : null,

"accessAccountsCount" : null,

"mailboxSize" : null,

"lastLoginDate" : null,

"lastModTime" : null,

"lastClientType" : null,

"lastClientVersion" : null,

"lastClientLanguage" : null,

"memberCount" : null,

"externalGroupCount" : 0,

"externalLibraryCount" : 0,

"externalResourceCount" : 0,

"externalUserCount" : 1,

"fullLicenseMailboxCount" : 0,

"groupCount" : 1,

"inactiveMailboxCount" : 0,

"libraryCount" : 2,

"limitedLicenseMailboxCount" : 0,

"linuxMailboxCount" : null,

"linux65XMailboxCount" : null,

"linux70XMailboxCount" : null,

"linux80XMailboxCount" : null,

"mac5XMailboxCount" : null,

"mac6XMailboxCount" : null,

"mac70XMailboxCount" : null,

"mac80XMailboxCount" : null,

"macMailboxCount" : null,

"outlookConnector65XMailboxCount" : null,

"outlookConnector70XMailboxCount" : null,

"outlookConnector80XMailboxCount" : null,

"outlookConnectorMailboxCount" : null,

"resourceCount" : 1,

"totalMailboxCount" : 0,

"winX65XMailboxCount" : null,

"winX70XMailboxCount" : null,

"winX80XMailboxCount" : null,

"winXMailboxCount" : null,

"uncategorizedMailboxCount" : null,

"windows65XMailboxCount" : null,

"windows70XMailboxCount" : null,

"windows80XMailboxCount" : null,

"windowsMailboxCount" : null,

"windows2012XMailboxCount" : null,

"userCount" : 8,

"coexistenceExportedUserCount" : null,

"coexistenceImportedUserCount" : null,

"x400Count" : null,

"@type" : null,

"@url" : null

}

XML Response:

Sample Requests and Responses 69

</systemInfo>

Requesting Configuration Information about the

GroupWise System

Request:

GET https://localhost:9710/gwadmin-service/system

Response Status:

200 - OK

JSON Response:

{

"id" : "SYSTEM_RECORD.testSystem1",

"guid" : "B5F73870-086F-0000-AE24-CEFE66AF19D4",

"name" : "testSystem1",

"links" : [ {

"@title" : "adminservices",

"@href" : "/gwadmin-service/system/adminservices"

}, {

"@title" : "calpubhosts",

"@href" : "/gwadmin-service/system/calpubhosts"

}, {

"@title" : "customaddresses",

"@href" : "/gwadmin-service/system/customaddresses"

}, {

"@title" : "customaddressestest",

"@href" : "/gwadmin-service/system/customaddresses/test"

}, {

"@title" : "defaulttimezones",

"@href" : "/gwadmin-service/system/defaulttimezones"

}, {

"@title" : "directories",

70 Sample Requests and Responses

"@href" : "/gwadmin-service/system/directories"

}, {

"@title" : "expired",

"@href" : "/gwadmin-service/system/expired"

}, {

"@title" : "externalsystemsync",

"@href" : "/gwadmin-service/system/externalsystemsync"

}, {

"@title" : "globalsignatures",

"@href" : "/gwadmin-service/system/globalsignatures"

}, {

"@title" : "info",

"@href" : "/gwadmin-service/system/info"

}, {

"@title" : "internetdomains",

"@href" : "/gwadmin-service/system/internetdomains"

}, {

"@title" : "ldapservers",

"@href" : "/gwadmin-service/system/ldapservers"

}, {

"@title" : "maintenance",

"@href" : "/gwadmin-service/system/maintenance"

}, {

"@title" : "moverequests",

"@href" : "/gwadmin-service/system/moverequests"

}, {

"@title" : "pending",

"@href" : "/gwadmin-service/system/pending"

}, {

"@title" : "recoverconnection",

"@href" : "/gwadmin-service/system/recoverconnection"

}, {

"@title" : "acl",

"@href" : "/gwadmin-service/system/acl"

}, {

"@title" : "restoreareas",

"@href" : "/gwadmin-service/system/restoreareas"

}, {

"@title" : "scheduledevents",

"@href" : "/gwadmin-service/system/scheduledevents"

}, {

"@title" : "scheduledeventactions",

"@href" : "/gwadmin-service/system/scheduledeventactions"

}, {

"@title" : "softwareareas",

"@href" : "/gwadmin-service/system/softwareareas"

}, {

"@title" : "timezones",

"@href" : "/gwadmin-service/system/timezones"

}, {

"@title" : "trustedapps",

"@href" : "/gwadmin-service/system/trustedapps"

}, {

"@title" : "userbyemail",

"@href" : "/gwadmin-service/system/userbyemail"

Sample Requests and Responses 71

}, {

"@title" : "domains",

"@href" : "/gwadmin-service/domains"

}, {

"@title" : "gateways",

"@href" : "/gwadmin-service/list/GATEWAY"

}, {

"@title" : "gwias",

"@href" : "/gwadmin-service/list/GWIA"

}, {

"@title" : "groups",

"@href" : "/gwadmin-service/list/GROUP"

}, {

"@title" : "libraries",

"@href" : "/gwadmin-service/list/LIBRARY"

}, {

"@title" : "mtas",

"@href" : "/gwadmin-service/list/MTA"

}, {

"@title" : "nicknames",

"@href" : "/gwadmin-service/list/NICKNAME"

}, {

"@title" : "poas",

"@href" : "/gwadmin-service/list/POA"

}, {

"@title" : "postoffices",

"@href" : "/gwadmin-service/list/POST_OFFICE"

}, {

"@title" : "resources",

"@href" : "/gwadmin-service/list/RESOURCE"

}, {

"@title" : "users",

"@href" : "/gwadmin-service/list/USER"

} ],

"timeCreated" : null,

"timeLastMod" : 1370908693000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "MODIFY",

"pendingOp" : null,

"description" : null,

"externalDomain" : null,

"receiveExternalDomains" : null,

"receiveExternalGroups" : null,

"receiveExternalPostOffices" : null,

"receiveExternalResources" : null,

"receiveExternalUsers" : null,

"sendExternalDomains" : null,

"sendExternalGroups" : null,

"sendExternalPostOffices" : null,

"sendExternalResources" : null,

"sendExternalUsers" : null,

"showDirXMLWarnings" : false,

"allowedAddressFormats" : [ "HOST", "USER", "LAST_FIRST", "FIRST_LAST",

"FLAST" ],

72 Sample Requests and Responses

"allowExternalBusySearch" : false,

"allowExternalStatusTracking" : false,

"archiveServiceApp" : null,

"allowSendDirect" : false,

"autoCreateNickname" : "PROMPT",

"autoSetUserRights" : false,

"defaultGlobalSignatureName" : null,

"defaultInternetAgentName" : "testDom1.GWIA",

"defaultNewUserPassword" : null,

"defaultRoutingDomain" : null,

"domainType" : null,

"emailPublish" : [ "PREFERRED_ADDRESS" ],

"emailPublishFormats" : [ "PREFERRED" ],

"enableICalBrowse" : true,

"firstInitialLastNameMatch" : false,

"forceMessages" : false,

"preferredAddressFormat" : "FULL",

"internetDomainName" : "testdomain.com",

"lockoutOldVersions" : null,

"minSnapinDate" : null,

"minSnapinVersion" : null,

"mtaProfileName" : null,

"nicknameExpireDays" : 30,

"primaryConnectionRequired" : null,

"restrictOpsToPrimaryDom" : true,

"systemType" : "LOCAL",

"systemAdminName" : "admin",

"useFullDN" : true,

"@type" : null,

"@url" : "/gwadmin-service/system"

}

XML Response:

<id>SYSTEM_RECORD.testSystem1</id>

<name>testSystem1</name>

<url>/gwadmin-service/system</url>

<links key="adminservices" href="/gwadmin-service/system/adminservices"/

>

<links key="customaddresses" href="/gwadmin-service/system/

customaddresses"/>

<links key="customaddressestest" href="/gwadmin-service/system/

customaddresses/test"/>

<links key="defaulttimezones" href="/gwadmin-service/system/

defaulttimezones"/>

<links key="externalsystemsync" href="/gwadmin-service/system/

externalsystemsync"/>

<links key="globalsignatures" href="/gwadmin-service/system/

globalsignatures"/>

<links key="internetdomains" href="/gwadmin-service/system/

Sample Requests and Responses 73

internetdomains"/>

<links key="recoverconnection" href="/gwadmin-service/system/

recoverconnection"/>

<links key="scheduledevents" href="/gwadmin-service/system/

scheduledevents"/>

<links key="scheduledeventactions" href="/gwadmin-service/system/

scheduledeventactions"/>

<links key="softwareareas" href="/gwadmin-service/system/softwareareas"/

>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<lastModifiedOp>MODIFY</lastModifiedOp>

<allowedAddressFormats class="AttrNoUsed">LAST_FIRST</

allowedAddressFormats>

<allowedAddressFormats class="AttrNoUsed">FIRST_LAST</

allowedAddressFormats>

<allowedAddressFormats class="AttrNoUsed">FLAST</allowedAddressFormats>

<allowExternalBusySearch>false</allowExternalBusySearch>

<allowExternalStatusTracking>false</allowExternalStatusTracking>

<allowSendDirect>false</allowSendDirect>

<autoCreateNickname>PROMPT</autoCreateNickname>

<autoSetUserRights>false</autoSetUserRights>

<defaultInternetAgentName>testDom1.GWIA</defaultInternetAgentName>

74 Sample Requests and Responses

<emailPublish>PREFERRED_ADDRESS</emailPublish>

<emailPublishFormats>PREFERRED</emailPublishFormats>

<firstInitialLastNameMatch>false</firstInitialLastNameMatch>

<forceMessages>false</forceMessages>

<internetDomainName>testdomain.com</internetDomainName>

<showDirXMLWarnings>false</showDirXMLWarnings>

<systemType>LOCAL</systemType>

<systemAdminName>admin</systemAdminName>

</system>

Requesting Configuration Information about a Domain

Request:

GET https://localhost:9710/gwadmin-service/system/connecteddomain

Response Status:

200 - OK

JSON Response:

{

"id" : "DOMAIN.testDom1",

"guid" : "BC755C40-086F-0000-AE24-CEFE66AF19D4",

"name" : "testDom1",

"links" : [ {

"@title" : "administrator",

"@href" : "/gwadmin-service/domains/testDom1/administrator"

}, {

"@title" : "clientoptions",

"@href" : "/gwadmin-service/domains/testDom1/clientoptions"

}, {

"@title" : "customaddresses",

"@href" : "/gwadmin-service/domains/testDom1/customaddresses"

}, {

"@title" : "customaddressestest",

"@href" : "/gwadmin-service/domains/testDom1/customaddresses/test"

}, {

"@title" : "gatewaysubdirs",

"@href" : "/gwadmin-service/domains/testDom1/gatewaysubdirs"

}, {

"@title" : "info",

"@href" : "/gwadmin-service/domains/testDom1/info"

}, {

"@title" : "maintenance",

"@href" : "/gwadmin-service/domains/testDom1/maintenance"

}, {

"@title" : "moverequests",

"@href" : "/gwadmin-service/domains/testDom1/moverequests"

}, {

"@title" : "mta",

Sample Requests and Responses 75

"@href" : "/gwadmin-service/domains/testDom1/mta"

}, {

"@title" : "postoffices",

"@href" : "/gwadmin-service/domains/testDom1/postoffices"

}, {

"@title" : "acl",

"@href" : "/gwadmin-service/domains/testDom1/acl"

}, {

"@title" : "synchronize",

"@href" : "/gwadmin-service/domains/testDom1/synchronize"

}, {

"@title" : "users",

"@href" : "/gwadmin-service/list/USER/DOMAIN.testDom1"

}, {

"@title" : "mtas",

"@href" : "/gwadmin-service/list/MTA/DOMAIN.testDom1"

}, {

"@title" : "libraries",

"@href" : "/gwadmin-service/list/LIBRARY/DOMAIN.testDom1"

}, {

"@title" : "poas",

"@href" : "/gwadmin-service/list/POA/DOMAIN.testDom1"

}, {

"@title" : "resources",

"@href" : "/gwadmin-service/list/RESOURCE/DOMAIN.testDom1"

}, {

"@title" : "gwias",

"@href" : "/gwadmin-service/list/GWIA/DOMAIN.testDom1"

}, {

"@title" : "groups",

"@href" : "/gwadmin-service/list/GROUP/DOMAIN.testDom1"

} ],

"timeCreated" : null,

"timeLastMod" : 1370885999000,

"legacyDn" : null,

"lastModifiedBy" : "Unknown admin",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"allowedAddressFormats" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : [ "FLAST", "USER", "FIRST_LAST", "HOST",

"LAST_FIRST" ],

"value" : [ "FLAST", "USER", "FIRST_LAST", "HOST", "LAST_FIRST" ]

},

"addressBookView" : null,

"alternateInternetAgentName" : null,

"enableICalBrowse" : {

"value" : true,

"inheritedValue" : true,

"inheritedFrom" : "testSystem1",

"inherited" : true

},

"databaseVersion" : null,

"defaultInternetAgentName" : {

76 Sample Requests and Responses

"value" : "testDom1.GWIA",

"inheritedValue" : "testDom1.GWIA",

"inheritedFrom" : "testSystem1",

"inherited" : true

},

"defaultWebAccess" : null,

"description" : null,

"directoryName" : null,

"directorySyncDomainName" : "testDom1",

"domainRebuildCount" : 0,

"domainType" : "PRIMARY",

"domainVersion" : 1212,

"externalSync" : null,

"fileId" : "tesf6f",

"gwId" : null,

"hideUserComments" : null,

"internetDomainName" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "testdomain.com",

"value" : "testdomain.com",

"exclusive" : null

},

"language" : "English - US",

"languageId" : "0",

"linkedDomainName" : null,

"lockoutOldAdmin" : null,

"minimumAdminReleaseDate" : null,

"minimumAdminVersion" : null,

"platform" : null,

"preferredAddressFormat" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "FULL",

"value" : "FULL"

},

"timezone" : "(GMT-07:00) Mountain Time (US & Canada)",

"timezoneId" : "MST",

"path" : "C:\\Novell\\GroupWise\\testDomain1\\",

"adminChanges" : null,

"mtaAddress" : null,

"mtaMtpPort" : null,

"mtaHttpPort" : null,

"mtaAdminPort" : null,

"remoteCreation" : null,

"notifyUser" : null,

"clearNotifyUser" : false,

"connected" : true,

"@type" : null,

"@url" : "/gwadmin-service/domains/testDom1"

}

XML Response:

<id>DOMAIN.testDom1</id>

Sample Requests and Responses 77

<name>testDom1</name>

<url>/gwadmin-service/domains/testDom1</url>

<links key="administrator" href="/gwadmin-service/domains/testDom1/

administrator"/>

<links key="clientoptions" href="/gwadmin-service/domains/testDom1/

clientoptions"/>

<links key="customaddresses" href="/gwadmin-service/domains/testDom1/

customaddresses"/>

<links key="customaddressestest" href="/gwadmin-service/domains/

testDom1/customaddresses/test"/>

<links key="gatewaysubdirs" href="/gwadmin-service/domains/testDom1/

gatewaysubdirs"/>

<links key="maintenance" href="/gwadmin-service/domains/testDom1/

maintenance"/>

<links key="moverequests" href="/gwadmin-service/domains/testDom1/

moverequests"/>

<links key="postoffices" href="/gwadmin-service/domains/testDom1/

postoffices"/>

<links key="synchronize" href="/gwadmin-service/domains/testDom1/

synchronize"/>

<links key="libraries" href="/gwadmin-service/list/LIBRARY/

DOMAIN.testDom1"/>

<links key="resources" href="/gwadmin-service/list/RESOURCE/

DOMAIN.testDom1"/>

<lastModifiedBy>Unknown admin</lastModifiedBy>

<inheritedFrom>testSystem1</inheritedFrom>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</inheritedValue>

<value>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</value>

</allowedAddressFormats>

78 Sample Requests and Responses

<inheritedFrom>testSystem1</inheritedFrom>

</enableICalBrowse>

<value class="string">testDom1.GWIA</value>

<inheritedValue class="string">testDom1.GWIA</inheritedValue>

<inheritedFrom>testSystem1</inheritedFrom>

</defaultInternetAgentName>

<directorySyncDomainName>testDom1</directorySyncDomainName>

<domainType>PRIMARY</domainType>

<inheritedFrom>testSystem1</inheritedFrom>

<inheritedValue>testdomain.com</inheritedValue>

<value>testdomain.com</value>

</internetDomainName>

<language>English - US</language>

<inheritedFrom>testSystem1</inheritedFrom>

</preferredAddressFormat>

<timezone>(GMT-07:00) Mountain Time (US & Canada)</timezone>

<path>C:\Novell\GroupWise\testDomain1\</path>

<clearNotifyUser>false</clearNotifyUser>

</domain>

Requesting Configuration Information about an MTA

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/mta

Response Status:

200 - OK

JSON Response:

{

"id" : "MTA.testDom1",

"guid" : "BC7694C0-086F-0000-AE24-CEFE66AF19D4",

"name" : "MTA",

"links" : [ {

"@title" : "manage",

"@href" : "/gwadmin-service/domains/testDom1/mta/manage"

Sample Requests and Responses 79

}, {

"@title" : "refevents",

"@href" : "/gwadmin-service/domains/testDom1/mta/refevents"

}, {

"@title" : "domain",

"@href" : "/gwadmin-service/domains/testDom1"

} ],

"timeCreated" : null,

"timeLastMod" : 1370970807000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "MODIFY",

"pendingOp" : null,

"adminName" : null,

"agentType" : "MTA",

"bindExclusive" : null,

"description" : "GroupWise Message Transfer Agent",

"httpPort" : 7180,

"httpUser" : "admin",

"logFilePath" : null,

"logLevel" : "NORMAL",

"logMaxAge" : 30,

"logMaxSize" : 102400,

"platform" : "WINDOWS",

"snmpCommunityGetString" : null,

"sslCertfile" : null,

"sslKeyFile" : null,

"sslKeyPassword" : null,

"ipAddress" : "127.0.0.1",

"ipPort" : null,

"sslEnabled" : null,

"domainName" : "testDom1",

"postOfficeName" : null,

"timezoneId" : null,

"languageId" : null,

"timezone" : null,

"language" : null,

"externalSync" : null,

"httpPortUsesSsl" : "DISABLED",

"attachRetry" : 60,

"autoDBRecovery" : true,

"collectDeliveryStatusReports" : null,

"collectOtherStatusReports" : null,

"correlateDeliveryStatusReports" : null,

"defaultRoutingDomain" : null,

"messageLogFilePath" : null,

"messageLogging" : "OFF",

"mtpPortUsesSsl" : "DISABLED",

"mtaRouteDelivery" : 0,

"mtaSendDirect" : 0,

"mtpPort" : 7100,

"reportsCleanupDays" : null,

"scanCycle" : 15,

"scanHigh" : 5,

"trackAdminMessages" : null,

80 Sample Requests and Responses

"use2ndHighScanner" : true,

"use2ndMailScanner" : true,

"serverFlags" : 1,

"adminPort" : 9710,

"syncLdapServerName" : null,

"httpEnabled" : null,

"httpPassword" : null,

"exchangeCoexistenceProfiles" : null,

"coexistenceSyncInterval" : 0,

"coexistenceSyncStartOffset" : 0,

"@type" : null,

"@url" : "/gwadmin-service/domains/testDom1/mta",

"FID" : null

}

XML Response:

<mta>

<id>MTA.testDom1</id>

<url>/gwadmin-service/domains/testDom1/mta</url>

<links key="manage" href="/gwadmin-service/domains/testDom1/mta/manage"/

>

<links key="refevents" href="/gwadmin-service/domains/testDom1/mta/

refevents"/>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<lastModifiedOp>MODIFY</lastModifiedOp>

<description>GroupWise Message Transfer Agent</description>

<logLevel>NORMAL</logLevel>

<platform>WINDOWS</platform>

<domainName>testDom1</domainName>

<httpPortUsesSsl>DISABLED</httpPortUsesSsl>

Sample Requests and Responses 81

<mtpPortUsesSsl>DISABLED</mtpPortUsesSsl>

<httpUser>admin</httpUser>

</mta>

Requesting Configuration Information about a POA

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/poas

Response Status:

200 - OK

JSON Response:

[ {

"id" : "POA.testDom1.testPO1.POA",

"guid" : "56A986B1-0870-0000-8A08-FB644894ACE1",

"name" : "POA",

"links" : null,

"timeCreated" : null,

"timeLastMod" : 1370970807000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "MODIFY",

"pendingOp" : null,

"adminName" : null,

"agentType" : "POA",

"bindExclusive" : false,

"description" : "GroupWise Post Office Agent",

"httpPort" : 7181,

"httpUser" : "admin",

"logFilePath" : null,

"logLevel" : "NORMAL",

"logMaxAge" : 30,

"logMaxSize" : 102400,

"platform" : "WINDOWS",

"snmpCommunityGetString" : null,

"sslCertfile" : null,

"sslKeyFile" : null,

"sslKeyPassword" : null,

"ipAddress" : "127.0.0.1",

"ipPort" : null,

"sslEnabled" : null,

82 Sample Requests and Responses

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"timezoneId" : null,

"languageId" : null,

"timezone" : null,

"language" : null,

"externalSync" : null,

"httpPortUsesSsl" : "DISABLED",

"address" : null,

"adminAgentFlag" : 0,

"administrationTaskProcessingDisabled" : false,

"appConnections" : 2048,

"cacheEnabled" : true,

"calendarPublishingEnabled" : true,

"calendarPublishingPort" : 7171,

"calendarPublishingThreads" : 4,

"clientServerEnabled" : true,

"clientServerThreads" : 10,

"cpuUtilization" : 85,

"delayTime" : 100,

"externalIpAddress" : null,

"externalClientServerPort" : 0,

"fileId" : null,

"httpEnabled" : true,

"httpPassword" : null,

"imapEnabled" : false,

"imapPort" : 143,

"imapSslPort" : 993,

"imapThreads" : 40,

"internalClientServerPort" : 1677,

"ipxAddress" : null,

"messageFileProcessing" : "ALL_MESSAGES",

"messageHandlerThreads" : 6,

"mtaport" : null,

"mtpPort" : 7101,

"physicalConnections" : 2048,

"primeMoveThreadUsage" : 30,

"snmpEnabled" : false,

"soapPort" : 7191,

"soapExternalPort" : 7191,

"soapEnabled" : true,

"soapThreads" : 40,

"quickFinderEnabled" : true,

"quickFinderIndexBase" : 20,

"quickFinderIndexBaseMinute" : 59,

"quickFinderInterval" : 23,

"quickFinderIntervalMinute" : 59,

"quickFinderQuarantineFiles" : false,

"autoDBRecovery" : true,

"maintenanceHandlerThreads" : 4,

"performUserUpkeep" : true,

"userUpkeepOffset" : 1,

"generateRemoteAddressBook" : true,

"generateRemoteAddressBookOffset" : 0,

"diskCheckInterval" : 5,

Sample Requests and Responses 83

"diskCheckDelay" : 2,

"clientServerExtUsesSsl" : "ENABLED",

"clientServerUsesSsl" : "ENABLED",

"imapUsesSsl" : "DISABLED",

"soapUsesSsl" : "DISABLED",

"mtpPortUsesSsl" : "DISABLED",

"adminPort" : 9710,

"@type" : "poa",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/poas/

POA",

"FID" : null

} ]

XML Response:

<list>

<poa>

<id>POA.testDom1.testPO1.POA</id>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/poas/POA</

url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<lastModifiedOp>MODIFY</lastModifiedOp>

<bindExclusive>false</bindExclusive>

<description>GroupWise Post Office Agent</description>

<logLevel>NORMAL</logLevel>

<platform>WINDOWS</platform>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<administrationTaskProcessingDisabled>false</

administrationTaskProcessingDisabled>

<httpUser>admin</httpUser>

<imapEnabled>false</imapEnabled>

84 Sample Requests and Responses

<messageFileProcessing>ALL_MESSAGES</messageFileProcessing>

<snmpEnabled>false</snmpEnabled>

<quickFinderQuarantineFiles>false</quickFinderQuarantineFiles>

<clientServerExtUsesSsl>ENABLED</clientServerExtUsesSsl>

<clientServerUsesSsl>ENABLED</clientServerUsesSsl>

<imapUsesSsl>DISABLED</imapUsesSsl>

<soapUsesSsl>DISABLED</soapUsesSsl>

<httpPortUsesSsl>DISABLED</httpPortUsesSsl>

<mtpPortUsesSsl>DISABLED</mtpPortUsesSsl>

</poa>

</list>

Sample Requests and Responses 85

Creating a GroupWise User

JSON Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users

expirationDate=0

postOfficeName=testPO1

name=testUser1

surname=testSurname1

directoryUser=false

domainName=testDom1

XML Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users

<user>

<name>testUser1</name>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<surname>testSurname1</surname>

</user>

Response Status:

201 - Created

URL location of the User = https://localhost:9710/gwadmin-service/domains/

testDom1/postoffices/testPO1/users/testUser1

86 Sample Requests and Responses

Creating an External User

JSON Request:

POST https://localhost:9710/gwadmin-service/domains/testExtDom1/

postoffices/testExtPO1/users

expirationDate=0

postOfficeName=testExtPO1

name=testExtUser1

directoryUser=false

domainName=testExtDom1

XML Request:

POST https://localhost:9710/gwadmin-service/domains/testExtDom1/

postoffices/testExtPO1/users

<user>

<name>testExtUser1</name>

<domainName>testExtDom1</domainName>

<postOfficeName>testExtPO1</postOfficeName>

</user>

Response Status:

201 - Created

URL location of the external User = https://localhost:9710/gwadmin-service/

domains/testExtDom1/postoffices/testExtPO1/users/testExtUser1

Sample Requests and Responses 87

Creating a GroupWise User with Chinese Characters in the

Last Name

JSON Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users

expirationDate=0

postOfficeName=testPO1

name=testChineseUser1

surname=????

directoryUser=false

domainName=testDom1

XML Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users

<user>

<name>testChineseUser1</name>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

</user>

Response Status:

201 - Created

URL location of the User = https://localhost:9710/gwadmin-service/domains/

testDom1/postoffices/testPO1/users/testChineseUser1

88 Sample Requests and Responses

Updating a User’s First Name That Has Chinese Characters

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testChineseUser1

streetAddress=??

expirationDate=0

directoryUser=false

givenName=?????????

country=China

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testChineseUser1

<user>

<country>China</country>

</user>

Response Status:

200 - OK

Renaming a User

JSON Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/rename

objectId=USER.testDom1.testPO1.testChineseUser1

newObjectId=testRenamedUser1

XML Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/rename

<objectId>USER.testDom1.testPO1.testChineseUser1</objectId>

<newObjectId>testRenamedUser1</newObjectId>

</renameRequest>

Response Status:

200 - OK

Sample Requests and Responses 89

Creating a GroupWise Group

JSON Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups

exclusiveInternetDomain=false

postOfficeName=testPO1

name=testGroup1

directoryUser=false

domainName=testDom1

XML Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups

<group>

<name>testGroup1</name>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<exclusiveInternetDomain>false</exclusiveInternetDomain>

</group>

Response Status:

201 - Created

URL location of the Group = https://localhost:9710/gwadmin-service/domains/

testDom1/postoffices/testPO1/groups/testGroup1

Adding a Member to a Group

JSON Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/members

id=GROUP.testDom1.testPO1.testUser1

participation=PRIMARY

XML Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/members

<id>GROUP.testDom1.testPO1.testUser1</id>

<participation>PRIMARY</participation>

</member>

Response Status:

201 - Created

90 Sample Requests and Responses

Updating the Participation of a Member of a Group

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/members/USER.testDom1.testPO1.testUser1

participation=CARBON_COPY

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/members/USER.testDom1.testPO1.testUser1

<participation>CARBON_COPY</participation>

</member>

Response Status:

200 - OK

Requesting an Access Control List for a Group

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/acl

Response Status:

200 - OK

JSON Response:

[ {

"id" : "USER.testDom1.testPO1.testGroupMember3",

"guid" : null,

"name" : "testGroupMember3",

"links" : null,

"timeCreated" : null,

"timeLastMod" : null,

"legacyDn" : null,

"lastModifiedBy" : null,

"lastModifiedOp" : null,

"pendingOp" : null,

"postOfficeName" : "testPO1",

"domainName" : "testDom1",

"rights" : "READ",

"@type" : "accessControl",

"@url" : null

}, {

"id" : "USER.testDom1.testPO1.testGroupMember4",

"guid" : null,

"name" : "testGroupMember4",

"links" : null,

"timeCreated" : null,

"timeLastMod" : null,

"legacyDn" : null,

"lastModifiedBy" : null,

Sample Requests and Responses 91

"lastModifiedOp" : null,

"pendingOp" : null,

"postOfficeName" : "testPO1",

"domainName" : "testDom1",

"rights" : "READ",

"@type" : "accessControl",

"@url" : null

}, {

"id" : "USER.testDom1.testPO1.testGroupMember5",

"guid" : null,

"name" : "testGroupMember5",

"links" : null,

"timeCreated" : null,

"timeLastMod" : null,

"legacyDn" : null,

"lastModifiedBy" : null,

"lastModifiedOp" : null,

"pendingOp" : null,

"postOfficeName" : "testPO1",

"domainName" : "testDom1",

"rights" : "READ",

"@type" : "accessControl",

"@url" : null

}, {

"id" : "USER.testDom1.testPO1.testGroupMember6",

"guid" : null,

"name" : "testGroupMember6",

"links" : null,

"timeCreated" : null,

"timeLastMod" : null,

"legacyDn" : null,

"lastModifiedBy" : null,

"lastModifiedOp" : null,

"pendingOp" : null,

"postOfficeName" : "testPO1",

"domainName" : "testDom1",

"rights" : "READ",

"@type" : "accessControl",

"@url" : null

} ]

XML Response:

<list>

<objType>accessControl</objType>

<postOfficeName>testPO1</postOfficeName>

<domainName>testDom1</domainName>

<name>testGroupMember3</name>

<id>USER.testDom1.testPO1.testGroupMember3</id>

</accessControl>

<objType>accessControl</objType>

92 Sample Requests and Responses

<postOfficeName>testPO1</postOfficeName>

<domainName>testDom1</domainName>

<name>testGroupMember4</name>

<id>USER.testDom1.testPO1.testGroupMember4</id>

</accessControl>

<objType>accessControl</objType>

<postOfficeName>testPO1</postOfficeName>

<domainName>testDom1</domainName>

<name>testGroupMember5</name>

<id>USER.testDom1.testPO1.testGroupMember5</id>

</accessControl>

<objType>accessControl</objType>

<postOfficeName>testPO1</postOfficeName>

<domainName>testDom1</domainName>

<name>testGroupMember6</name>

<id>USER.testDom1.testPO1.testGroupMember6</id>

</accessControl>

</list>

Creating a GroupWise Resource

JSON Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/resources

expirationDate=0

postOfficeName=testPO1

name=testResource1

owner=testUser1

directoryUser=false

domainName=testDom1

XML Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/resources

<name>testResource1</name>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<owner>testUser1</owner>

</resource>

Response Status:

201 - Created

URL location of the Resource = https://localhost:9710/gwadmin-service/

domains/testDom1/postoffices/testPO1/resources/testResource1

Sample Requests and Responses 93

Creating a GroupWise Nickname

JSON Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/nicknames

userPostOfficeName=testPO1

expirationDate=0

postOfficeName=testPO1

name=testNicknameName1

userName=testUser1

surname=testNicknameSurname1

directoryUser=false

domainName=testDom1

userDomainName=testDom1

XML Request:

POST https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/nicknames

<name>testNicknameName1</name>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<surname>testNicknameSurname1</surname>

<userName>testUser1</userName>

<userPostOfficeName>testPO1</userPostOfficeName>

<userDomainName>testDom1</userDomainName>

</nickname>

Response Status:

201 - Created

URL location of the Nickname = https://localhost:9710/gwadmin-service/

domains/testDom1/postoffices/testPO1/nicknames/testNicknameName1

Finding a Domain by Name

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1

Response Status:

200 - OK

JSON Response:

{

"id" : "DOMAIN.testDom1",

"guid" : "BC755C40-086F-0000-AE24-CEFE66AF19D4",

"name" : "testDom1",

"links" : [ {

"@title" : "administrator",

"@href" : "/gwadmin-service/domains/testDom1/administrator"

}, {

"@title" : "clientoptions",

94 Sample Requests and Responses

"@href" : "/gwadmin-service/domains/testDom1/clientoptions"

}, {

"@title" : "customaddresses",

"@href" : "/gwadmin-service/domains/testDom1/customaddresses"

}, {

"@title" : "customaddressestest",

"@href" : "/gwadmin-service/domains/testDom1/customaddresses/test"

}, {

"@title" : "gatewaysubdirs",

"@href" : "/gwadmin-service/domains/testDom1/gatewaysubdirs"

}, {

"@title" : "info",

"@href" : "/gwadmin-service/domains/testDom1/info"

}, {

"@title" : "maintenance",

"@href" : "/gwadmin-service/domains/testDom1/maintenance"

}, {

"@title" : "moverequests",

"@href" : "/gwadmin-service/domains/testDom1/moverequests"

}, {

"@title" : "mta",

"@href" : "/gwadmin-service/domains/testDom1/mta"

}, {

"@title" : "postoffices",

"@href" : "/gwadmin-service/domains/testDom1/postoffices"

}, {

"@title" : "acl",

"@href" : "/gwadmin-service/domains/testDom1/acl"

}, {

"@title" : "synchronize",

"@href" : "/gwadmin-service/domains/testDom1/synchronize"

}, {

"@title" : "users",

"@href" : "/gwadmin-service/list/USER/DOMAIN.testDom1"

}, {

"@title" : "mtas",

"@href" : "/gwadmin-service/list/MTA/DOMAIN.testDom1"

}, {

"@title" : "libraries",

"@href" : "/gwadmin-service/list/LIBRARY/DOMAIN.testDom1"

}, {

"@title" : "poas",

"@href" : "/gwadmin-service/list/POA/DOMAIN.testDom1"

}, {

"@title" : "resources",

"@href" : "/gwadmin-service/list/RESOURCE/DOMAIN.testDom1"

}, {

"@title" : "gwias",

"@href" : "/gwadmin-service/list/GWIA/DOMAIN.testDom1"

}, {

"@title" : "groups",

"@href" : "/gwadmin-service/list/GROUP/DOMAIN.testDom1"

} ],

"timeCreated" : null,

"timeLastMod" : 1370885999000,

Sample Requests and Responses 95

"legacyDn" : null,

"lastModifiedBy" : "Unknown admin",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"allowedAddressFormats" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : [ "FLAST", "USER", "FIRST_LAST", "HOST",

"LAST_FIRST" ],

"value" : [ "FLAST", "USER", "FIRST_LAST", "HOST", "LAST_FIRST" ]

},

"addressBookView" : null,

"alternateInternetAgentName" : null,

"enableICalBrowse" : {

"value" : true,

"inheritedValue" : true,

"inheritedFrom" : "testSystem1",

"inherited" : true

},

"databaseVersion" : null,

"defaultInternetAgentName" : {

"value" : "testDom1.GWIA",

"inheritedValue" : "testDom1.GWIA",

"inheritedFrom" : "testSystem1",

"inherited" : true

},

"defaultWebAccess" : null,

"description" : null,

"directoryName" : null,

"directorySyncDomainName" : "testDom1",

"domainRebuildCount" : 0,

"domainType" : "PRIMARY",

"domainVersion" : 1212,

"externalSync" : null,

"fileId" : "tesf6f",

"gwId" : null,

"hideUserComments" : null,

"internetDomainName" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "testdomain.com",

"value" : "testdomain.com",

"exclusive" : null

},

"language" : "English - US",

"languageId" : "0",

"linkedDomainName" : null,

"lockoutOldAdmin" : null,

"minimumAdminReleaseDate" : null,

"minimumAdminVersion" : null,

"platform" : null,

"preferredAddressFormat" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "FULL",

96 Sample Requests and Responses

"value" : "FULL"

},

"timezone" : "(GMT-07:00) Mountain Time (US & Canada)",

"timezoneId" : "MST",

"path" : "C:\\Novell\\GroupWise\\testDomain1\\",

"adminChanges" : null,

"mtaAddress" : null,

"mtaMtpPort" : null,

"mtaHttpPort" : null,

"mtaAdminPort" : null,

"remoteCreation" : null,

"notifyUser" : null,

"clearNotifyUser" : false,

"connected" : true,

"@type" : null,

"@url" : "/gwadmin-service/domains/testDom1"

}

XML Response:

<id>DOMAIN.testDom1</id>

<name>testDom1</name>

<url>/gwadmin-service/domains/testDom1</url>

<links key="administrator" href="/gwadmin-service/domains/testDom1/

administrator"/>

<links key="clientoptions" href="/gwadmin-service/domains/testDom1/

clientoptions"/>

<links key="customaddresses" href="/gwadmin-service/domains/testDom1/

customaddresses"/>

<links key="customaddressestest" href="/gwadmin-service/domains/

testDom1/customaddresses/test"/>

<links key="gatewaysubdirs" href="/gwadmin-service/domains/testDom1/

gatewaysubdirs"/>

<links key="maintenance" href="/gwadmin-service/domains/testDom1/

maintenance"/>

<links key="moverequests" href="/gwadmin-service/domains/testDom1/

moverequests"/>

<links key="postoffices" href="/gwadmin-service/domains/testDom1/

postoffices"/>

<links key="synchronize" href="/gwadmin-service/domains/testDom1/

synchronize"/>

<links key="libraries" href="/gwadmin-service/list/LIBRARY/

DOMAIN.testDom1"/>

<links key="resources" href="/gwadmin-service/list/RESOURCE/

DOMAIN.testDom1"/>

Sample Requests and Responses 97

<lastModifiedBy>Unknown admin</lastModifiedBy>

<inheritedFrom>testSystem1</inheritedFrom>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</inheritedValue>

<value>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</value>

</allowedAddressFormats>

<inheritedFrom>testSystem1</inheritedFrom>

</enableICalBrowse>

<value class="string">testDom1.GWIA</value>

<inheritedValue class="string">testDom1.GWIA</inheritedValue>

<inheritedFrom>testSystem1</inheritedFrom>

</defaultInternetAgentName>

<directorySyncDomainName>testDom1</directorySyncDomainName>

<domainType>PRIMARY</domainType>

<inheritedFrom>testSystem1</inheritedFrom>

<inheritedValue>testdomain.com</inheritedValue>

<value>testdomain.com</value>

</internetDomainName>

98 Sample Requests and Responses

<language>English - US</language>

<inheritedFrom>testSystem1</inheritedFrom>

</preferredAddressFormat>

<timezone>(GMT-07:00) Mountain Time (US & Canada)</timezone>

<path>C:\Novell\GroupWise\testDomain1\</path>

<clearNotifyUser>false</clearNotifyUser>

</domain>

Finding a Domain by Type

Request:

GET https://localhost:9710/gwadmin-service/list/

DOMAIN?domainType=SECONDARY

Response Status:

200 - OK

JSON Response:

[ {

"id" : "DOMAIN.testDom2",

"guid" : "5FC6CEE0-08FE-0000-8A08-5BB4E7C4BAB9",

"name" : "testDom2",

"links" : null,

"timeCreated" : 1370968862000,

"timeLastMod" : 1370968863000,

"legacyDn" : null,

"lastModifiedBy" : "Unknown admin",

"lastModifiedOp" : "MODIFY",

"pendingOp" : "MODIFY",

"allowedAddressFormats" : null,

"addressBookView" : null,

"alternateInternetAgentName" : null,

"enableICalBrowse" : null,

"databaseVersion" : null,

"defaultInternetAgentName" : null,

"defaultWebAccess" : null,

"description" : null,

"directoryName" : null,

"directorySyncDomainName" : "testDom2",

"domainRebuildCount" : 1,

"domainType" : "SECONDARY",

"domainVersion" : 1212,

"externalSync" : null,

"fileId" : "tesfebe",

"gwId" : null,

"hideUserComments" : null,

"internetDomainName" : null,

Sample Requests and Responses 99

"language" : "English - US",

"languageId" : "0",

"linkedDomainName" : null,

"lockoutOldAdmin" : null,

"minimumAdminReleaseDate" : null,

"minimumAdminVersion" : null,

"platform" : null,

"preferredAddressFormat" : null,

"timezone" : "(GMT-07:00) Mountain Time (US & Canada)",

"timezoneId" : "MST",

"path" : "C:\\Novell\\GroupWise\\testDomain2",

"adminChanges" : null,

"mtaAddress" : null,

"mtaMtpPort" : null,

"mtaHttpPort" : null,

"mtaAdminPort" : null,

"remoteCreation" : null,

"notifyUser" : null,

"clearNotifyUser" : false,

"connected" : false,

"@type" : "domain",

"@url" : "/gwadmin-service/domains/testDom2"

} ]

XML Response:

<list>

<id>DOMAIN.testDom2</id>

<name>testDom2</name>

<objType>domain</objType>

<url>/gwadmin-service/domains/testDom2</url>

<lastModifiedBy>Unknown admin</lastModifiedBy>

<lastModifiedOp>MODIFY</lastModifiedOp>

<pendingOp>MODIFY</pendingOp>

<directorySyncDomainName>testDom2</directorySyncDomainName>

<domainType>SECONDARY</domainType>

<fileId>tesfebe</fileId>

<language>English - US</language>

<timezone>(GMT-07:00) Mountain Time (US & Canada)</timezone>

<path>C:\Novell\GroupWise\testDomain2</path>

<clearNotifyUser>false</clearNotifyUser>

<connected>false</connected>

</domain>

</list>

100 Sample Requests and Responses

Finding a Post Office

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1

Response Status:

200 - OK

JSON Response:

{

"id" : "POST_OFFICE.testDom1.testPO1",

"guid" : "56A986B0-0870-0000-8A08-FB644894ACE1",

"name" : "testPO1",

"links" : [ {

"@title" : "aliases",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

aliases"

}, {

"@title" : "bumpclientupdate",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

bumpclientupdate"

}, {

"@title" : "certificatefiles",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

certificatefiles"

}, {

"@title" : "clientoptions",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

clientoptions"

}, {

"@title" : "info",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/info"

}, {

"@title" : "groups",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

groups"

}, {

"@title" : "gwcheck",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

gwcheck"

}, {

"@title" : "libraries",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

libraries"

}, {

"@title" : "maintenance",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

maintenance"

}, {

"@title" : "moverequests",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

moverequests"

}, {

Sample Requests and Responses 101

"@title" : "nicknames",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

nicknames"

}, {

"@title" : "poas",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/poas"

}, {

"@title" : "acl",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/acl"

}, {

"@title" : "refldapservers",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

refldapservers"

}, {

"@title" : "resources",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources"

}, {

"@title" : "synchronize",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

synchronize"

}, {

"@title" : "timestamp",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

timestamp"

}, {

"@title" : "users",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users"

}, {

"@title" : "rename",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

rename"

}, {

"@title" : "domain",

"@href" : "/gwadmin-service/domains/testDom1"

} ],

"timeCreated" : 1370907858000,

"timeLastMod" : 1370907860000,

"legacyDn" : null,

"lastModifiedBy" : "Unknown admin",

"lastModifiedOp" : "MODIFY",

"pendingOp" : null,

"adminChanges" : null,

"accessMode" : "CLIENT_SERVER",

"allowedAddressFormats" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : [ "FLAST", "USER", "FIRST_LAST", "HOST",

"LAST_FIRST" ],

"value" : [ "FLAST", "USER", "FIRST_LAST", "HOST", "LAST_FIRST" ]

},

"archiveServiceTrustedAppName" : null,

"clientLockout" : null,

"clientLockoutDate" : null,

"clientLockoutVersion" : null,

102 Sample Requests and Responses

"defaultInternetAgentName" : null,

"description" : null,

"domainName" : "testDom1",

"deliveryMode" : "APP_THRESHOLD",

"disableDeltaRecords" : null,

"disableLdapPasswordChange" : null,

"disableLiveMove" : null,

"disableLogins" : false,

"deltaRecordsMaxAge" : null,

"enableICalBrowse" : {

"value" : true,

"inheritedValue" : true,

"inheritedFrom" : "testSystem1",

"inherited" : true

},

"externalRecord" : false,

"externalSync" : null,

"fileId" : "tes1072",

"gwId" : null,

"internetDomainName" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "testdomain.com",

"value" : "testdomain.com",

"exclusive" : null

},

"intruderDetection" : true,

"intruderLockoutAttempts" : 5,

"intruderLockoutAttemptsInterval" : 30,

"intruderLockoutResetInterval" : 30,

"language" : "English - US",

"languageId" : "0",

"ldapDefaultDirectory" : null,

"ldapUser" : null,

"ldapPassword" : null,

"ldapInactiveConnectionTimeout" : null,

"ldapPoolServerResetTimeout" : null,

"ldapQuarantineThreshold" : null,

"linkAddress" : "C:\\Novell\\GroupWise\\testPostOffice1",

"linkAddressType" : "TCP_IP",

"mtpAppName" : "POA",

"mtpMaxSendSize" : null,

"platform" : null,

"postOfficeVersion" : 1212,

"preferredAddressFormat" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "FULL",

"value" : "FULL"

},

"remoteUser" : null,

"remotePassword" : null,

"restoreAreaName" : null,

"securitySettings" : [ "HIGH" ],

"softwareAreaGuid" : null,

Sample Requests and Responses 103

"softwareVersion" : null,

"syncContext" : null,

"timezone" : "(GMT-07:00) Mountain Time (US & Canada)",

"timezoneId" : "MST",

"path" : "C:\\Novell\\GroupWise\\testPostOffice1",

"associationsUpdate" : null,

"poaAddress" : null,

"poaCsPort" : null,

"poaMtpPort" : null,

"poaHttpPort" : null,

"timeStamp" : null,

"clientUpdateBumpNumber" : 0,

"poaAdminPort" : null,

"remoteCreation" : null,

"displayName" : "testPO1",

"draggable" : true,

"@type" : null,

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1"

}

XML Response:

<id>POST_OFFICE.testDom1.testPO1</id>

<name>testPO1</name>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1</url>

<links key="aliases" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/aliases"/>

<links key="bumpclientupdate" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/bumpclientupdate"/>

<links key="certificatefiles" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/certificatefiles"/>

<links key="clientoptions" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/clientoptions"/>

<links key="info" href="/gwadmin-service/domains/testDom1/postoffices/

testPO1/info"/>

<links key="groups" href="/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups"/>

<links key="gwcheck" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/gwcheck"/>

<links key="libraries" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/libraries"/>

<links key="maintenance" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/maintenance"/>

<links key="moverequests" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/moverequests"/>

<links key="nicknames" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/nicknames"/>

<links key="poas" href="/gwadmin-service/domains/testDom1/postoffices/

testPO1/poas"/>

<links key="acl" href="/gwadmin-service/domains/testDom1/postoffices/

testPO1/acl"/>

<links key="refldapservers" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/refldapservers"/>

<links key="resources" href="/gwadmin-service/domains/testDom1/

104 Sample Requests and Responses

postoffices/testPO1/resources"/>

<links key="synchronize" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/synchronize"/>

<links key="timestamp" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/timestamp"/>

<links key="users" href="/gwadmin-service/domains/testDom1/postoffices/

testPO1/users"/>

<links key="rename" href="/gwadmin-service/domains/testDom1/postoffices/

testPO1/rename"/>

<lastModifiedBy>Unknown admin</lastModifiedBy>

<lastModifiedOp>MODIFY</lastModifiedOp>

<accessMode>CLIENT_SERVER</accessMode>

<inheritedFrom>testSystem1</inheritedFrom>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</inheritedValue>

<value>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</value>

</allowedAddressFormats>

<domainName>testDom1</domainName>

<deliveryMode>APP_THRESHOLD</deliveryMode>

<disableLogins>false</disableLogins>

<inheritedFrom>testSystem1</inheritedFrom>

</enableICalBrowse>

<externalEntity>false</externalEntity>

<externalRecord>false</externalRecord>

<inheritedFrom>testSystem1</inheritedFrom>

<inheritedValue>testdomain.com</inheritedValue>

<value>testdomain.com</value>

</internetDomainName>

Sample Requests and Responses 105

<language>English - US</language>

<linkAddress>C:\Novell\GroupWise\testPostOffice1</linkAddress>

<inheritedFrom>testSystem1</inheritedFrom>

</preferredAddressFormat>

<timezone>(GMT-07:00) Mountain Time (US & Canada)</timezone>

<path>C:\Novell\GroupWise\testPostOffice1</path>

</postOffice>

Finding a User in the GroupWise System

Request:

GET https://localhost:9710/gwadmin-service/list/USER?filter=name match

'testUser1'

Response Status:

200 - OK

JSON Response:

{

"id" : "USER.testDom1.testPO1.testUser1",

"guid" : "3C0BF3D0-09EF-0000-8A08-20888CC82C5A",

"name" : "testUser1",

"links" : null,

"timeCreated" : 1371072310000,

"timeLastMod" : 1371072310000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

106 Sample Requests and Responses

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "fri",

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "testSurname1",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

Sample Requests and Responses 107

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "user",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1"

}

XML Response:

<user>

<id>USER.testDom1.testPO1.testUser1</id>

<name>testUser1</name>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<surname>testSurname1</surname>

</user>

Finding a User in a Domain

Request:

GET https://localhost:9710/gwadmin-service/list/USER/

DOMAIN.testDom1?name=testUser1

Response Status:

200 - OK

JSON Response:

{

"id" : "USER.testDom1.testPO1.testUser1",

"guid" : "3C0BF3D0-09EF-0000-8A08-20888CC82C5A",

"name" : "testUser1",

"links" : null,

"timeCreated" : 1371072310000,

"timeLastMod" : 1371072310000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

108 Sample Requests and Responses

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "fri",

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "testSurname1",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

Sample Requests and Responses 109

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "user",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1"

}

XML Response:

<user>

<id>USER.testDom1.testPO1.testUser1</id>

<name>testUser1</name>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<surname>testSurname1</surname>

</user>

NOTE: The

?name

query automatically does end of name wildcard searching.

110 Sample Requests and Responses

Finding a User in a Post Office

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1

Response Status:

200 - OK

JSON Response:

{

"id" : "USER.testDom1.testPO1.testUser1",

"guid" : "3C0BF3D0-09EF-0000-8A08-20888CC82C5A",

"name" : "testUser1",

"links" : [ {

"@title" : "administeredgroups",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1/administeredgroups"

}, {

"@title" : "aliases",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1/aliases"

}, {

"@title" : "clientoptions",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1/clientoptions"

}, {

"@title" : "info",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1/info"

}, {

"@title" : "emailaddresses",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1/emailaddresses"

}, {

"@title" : "groupmemberships",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1/groupmemberships"

}, {

"@title" : "gwcheck",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1/gwcheck"

}, {

"@title" : "resources",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1/resources"

}, {

"@title" : "nicknames",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1/nicknames"

}, {

"@title" : "synchronize",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1/synchronize"

Sample Requests and Responses 111

}, {

"@title" : "restorearea",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1/restorearea"

}, {

"@title" : "restoremailbox",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1/restoremailbox"

}, {

"@title" : "domain",

"@href" : "/gwadmin-service/domains/testDom1"

}, {

"@title" : "postoffice",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1"

} ],

"timeCreated" : 1371072310000,

"timeLastMod" : 1371072310000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : [ "testUser1.testPO1.testDom1@testdomain.com" ],

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : [ "FLAST", "USER", "FIRST_LAST", "HOST",

"LAST_FIRST" ],

"value" : [ "FLAST", "USER", "FIRST_LAST", "HOST", "LAST_FIRST" ]

},

"internetDomainName" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "testdomain.com",

"value" : "testdomain.com",

"exclusive" : null

},

"preferredAddressFormat" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "FULL",

"value" : "FULL"

},

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : {

"value" : true,

"inheritedValue" : true,

112 Sample Requests and Responses

"inheritedFrom" : "testSystem1",

"inherited" : true

},

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "fri",

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "testSurname1",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

Sample Requests and Responses 113

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : null,

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1"

}

XML Response:

<user>

<id>USER.testDom1.testPO1.testUser1</id>

<name>testUser1</name>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testUser1</url>

<links key="administeredgroups" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testUser1/administeredgroups"/>

<links key="aliases" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testUser1/aliases"/>

<links key="clientoptions" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testUser1/clientoptions"/>

<links key="info" href="/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/info"/>

<links key="emailaddresses" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testUser1/emailaddresses"/>

<links key="groupmemberships" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testUser1/groupmemberships"/>

<links key="gwcheck" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testUser1/gwcheck"/>

<links key="resources" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testUser1/resources"/>

<links key="nicknames" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testUser1/nicknames"/>

<links key="synchronize" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testUser1/synchronize"/>

<links key="restorearea" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testUser1/restorearea"/>

<links key="restoremailbox" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testUser1/restoremailbox"/>

<links key="postoffice" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1"/>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

114 Sample Requests and Responses

<postOfficeName>testPO1</postOfficeName>

<string>testUser1.testPO1.testDom1@testdomain.com</string>

</emailAddresses>

<visibility>SYSTEM</visibility>

<inheritedFrom>testSystem1</inheritedFrom>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</inheritedValue>

<value>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</value>

</allowedAddressFormats>

<inheritedFrom>testSystem1</inheritedFrom>

<inheritedValue>testdomain.com</inheritedValue>

<value>testdomain.com</value>

</internetDomainName>

<inheritedFrom>testSystem1</inheritedFrom>

</preferredAddressFormat>

<inheritedFrom>testSystem1</inheritedFrom>

</enableICalBrowse>

<surname>testSurname1</surname>

</user>

Sample Requests and Responses 115

Finding a User in a Group

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/members/GROUP.testDom1.testPO1.testUser1

Response Status:

200 - OK

JSON Response:

{

"id" : "USER.testDom1.testPO1.testUser1",

"guid" : null,

"name" : "testUser1",

"links" : null,

"timeCreated" : null,

"timeLastMod" : null,

"legacyDn" : null,

"lastModifiedBy" : null,

"lastModifiedOp" : null,

"pendingOp" : null,

"postOfficeName" : "testPO1",

"domainName" : "testDom1",

"givenName" : null,

"participation" : "PRIMARY",

"type" : "USER",

"surname" : "testSurname1",

"@type" : null,

"@url" : null

}

XML Response:

<id>USER.testDom1.testPO1.testUser1</id>

<name>testUser1</name>

<postOfficeName>testPO1</postOfficeName>

<domainName>testDom1</domainName>

<participation>PRIMARY</participation>

<surname>testSurname1</surname>

</member>

116 Sample Requests and Responses

Finding a User’s Last Name That Has Chinese Characters

Request:

GET https://localhost:9710/gwadmin-service/list/USER?surname=????

Response Status:

200 - OK

JSON Response:

{

"id" : "USER.testDom1.testPO1.testChineseUser1",

"guid" : "3D438970-09EF-0000-8A08-20888CC82C5A",

"name" : "testChineseUser1",

"links" : null,

"timeCreated" : 1371072312000,

"timeLastMod" : 1371072312000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "77i",

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

Sample Requests and Responses 117

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "????",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "user",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testChineseUser1"

}

XML Response:

<user>

<id>USER.testDom1.testPO1.testChineseUser1</id>

<name>testChineseUser1</name>

118 Sample Requests and Responses

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/users/

testChineseUser1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

</user>

Finding a Group in the GroupWise System

Request:

GET https://localhost:9710/gwadmin-service/list/GROUP?name=testGroup1

Response Status:

200 - OK

JSON Response:

{

"id" : "GROUP.testDom1.testPO1.testGroup1",

"guid" : "3D593450-09EF-0000-8A08-20888CC82C5A",

"name" : "testGroup1",

"links" : null,

"timeCreated" : 1371072313000,

"timeLastMod" : 1371072313000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "POST_OFFICE",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"postOffice" : null,

"groupType" : "DISTRIBUTION_LIST",

"replicationOverride" : null,

"exclusiveInternetDomain" : false,

"groupAccessControlUpdateList" : null,

Sample Requests and Responses 119

"groupMembershipUpdateList" : null,

"externalSync" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "group",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/groups/

testGroup1"

}

XML Response:

<group>

<id>GROUP.testDom1.testPO1.testGroup1</id>

<name>testGroup1</name>

<objType>group</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/groups/

testGroup1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>POST_OFFICE</visibility>

<groupType>DISTRIBUTION_LIST</groupType>

<exclusiveInternetDomain>false</exclusiveInternetDomain>

</group>

NOTE: The

?name

query automatically does end of name wildcard searching.

Finding a Group in a Post Office

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1

Response Status:

200 - OK

JSON Response:

{

"id" : "GROUP.testDom1.testPO1.testGroup1",

"guid" : "3D593450-09EF-0000-8A08-20888CC82C5A",

"name" : "testGroup1",

"links" : [ {

"@title" : "groupmemberships",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

groups/testGroup1/groupmemberships"

}, {

"@title" : "nicknames",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

groups/testGroup1/nicknames"

120 Sample Requests and Responses

}, {

"@title" : "members",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

groups/testGroup1/members"

}, {

"@title" : "acl",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

groups/testGroup1/acl"

}, {

"@title" : "domain",

"@href" : "/gwadmin-service/domains/testDom1"

}, {

"@title" : "postoffice",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1"

} ],

"timeCreated" : 1371072313000,

"timeLastMod" : 1371072313000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : [ "testGroup1.testPO1.testDom1@testdomain.com" ],

"visibility" : "POST_OFFICE",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : [ "FLAST", "USER", "FIRST_LAST", "HOST",

"LAST_FIRST" ],

"value" : [ "FLAST", "USER", "FIRST_LAST", "HOST", "LAST_FIRST" ]

},

"internetDomainName" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "testdomain.com",

"value" : "testdomain.com",

"exclusive" : null

},

"preferredAddressFormat" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "FULL",

"value" : "FULL"

},

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"postOffice" : null,

"groupType" : "DISTRIBUTION_LIST",

"replicationOverride" : null,

Sample Requests and Responses 121

"exclusiveInternetDomain" : false,

"groupAccessControlUpdateList" : null,

"groupMembershipUpdateList" : null,

"externalSync" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : null,

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/groups/

testGroup1"

}

XML Response:

<group>

<id>GROUP.testDom1.testPO1.testGroup1</id>

<name>testGroup1</name>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/groups/

testGroup1</url>

<links key="groupmemberships" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/groups/testGroup1/groupmemberships"/>

<links key="nicknames" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/groups/testGroup1/nicknames"/>

<links key="members" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/groups/testGroup1/members"/>

<links key="acl" href="/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/acl"/>

<links key="postoffice" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1"/>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<string>testGroup1.testPO1.testDom1@testdomain.com</string>

</emailAddresses>

<visibility>POST_OFFICE</visibility>

<inheritedFrom>testSystem1</inheritedFrom>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</inheritedValue>

<value>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

122 Sample Requests and Responses

</value>

</allowedAddressFormats>

<inheritedFrom>testSystem1</inheritedFrom>

<inheritedValue>testdomain.com</inheritedValue>

<value>testdomain.com</value>

</internetDomainName>

<inheritedFrom>testSystem1</inheritedFrom>

</preferredAddressFormat>

<groupType>DISTRIBUTION_LIST</groupType>

<exclusiveInternetDomain>false</exclusiveInternetDomain>

</group>

Finding a Resource in the GroupWise System

Request:

GET https://localhost:9710/gwadmin-service/list/

RESOURCE?name=testResource1

Response Status:

200 - OK

JSON Response:

{

"id" : "RESOURCE.testDom1.testPO1.testResource1",

"guid" : "3E3CB680-09EF-0000-8A08-20888CC82C5A",

"name" : "testResource1",

"links" : null,

"timeCreated" : 1371072314000,

"timeLastMod" : 1371072314000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

Sample Requests and Responses 123

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "66e",

"owner" : "testUser1",

"postOffice" : null,

"resourceType" : "RESOURCE",

"telephoneNumber" : null,

"groupMembershipUpdateList" : null,

"nicknamesUrl" : null,

"moveComplete" : null,

"directoryUser" : false,

"@type" : "resource",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1"

}

XML Response:

<id>RESOURCE.testDom1.testPO1.testResource1</id>

<name>testResource1</name>

<objType>resource</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/resources/

testResource1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<owner>testUser1</owner>

<resourceType>RESOURCE</resourceType>

</resource>

NOTE: The

?name

query automatically does end of name wildcard searching.

124 Sample Requests and Responses

Finding a Resource in a Post Office

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/resources/testResource1

Response Status:

200 - OK

JSON Response:

{

"id" : "RESOURCE.testDom1.testPO1.testResource1",

"guid" : "3E3CB680-09EF-0000-8A08-20888CC82C5A",

"name" : "testResource1",

"links" : [ {

"@title" : "clientoptions",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1/clientoptions"

}, {

"@title" : "emailaddresses",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1/emailaddresses"

}, {

"@title" : "groupmemberships",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1/groupmemberships"

}, {

"@title" : "gwcheck",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1/gwcheck"

}, {

"@title" : "nicknames",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1/nicknames"

}, {

"@title" : "restorearea",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1/restorearea"

}, {

"@title" : "restoremailbox",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1/restoremailbox"

}, {

"@title" : "domain",

"@href" : "/gwadmin-service/domains/testDom1"

}, {

"@title" : "postoffice",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1"

} ],

"timeCreated" : 1371072314000,

"timeLastMod" : 1371072314000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

Sample Requests and Responses 125

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : [ "testResource1.testPO1.testDom1@testdomain.com" ],

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : [ "FLAST", "USER", "FIRST_LAST", "HOST",

"LAST_FIRST" ],

"value" : [ "FLAST", "USER", "FIRST_LAST", "HOST", "LAST_FIRST" ]

},

"internetDomainName" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "testdomain.com",

"value" : "testdomain.com",

"exclusive" : null

},

"preferredAddressFormat" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "FULL",

"value" : "FULL"

},

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : {

"value" : true,

"inheritedValue" : true,

"inheritedFrom" : "testSystem1",

"inherited" : true

},

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : "66e",

"owner" : "testUser1",

"postOffice" : null,

"resourceType" : "RESOURCE",

"telephoneNumber" : null,

"groupMembershipUpdateList" : null,

"nicknamesUrl" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1/nicknames",

"moveComplete" : null,

"directoryUser" : false,

"@type" : null,

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

resources/testResource1"

126 Sample Requests and Responses

}

XML Response:

<id>RESOURCE.testDom1.testPO1.testResource1</id>

<name>testResource1</name>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/resources/

testResource1</url>

<links key="clientoptions" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/resources/testResource1/clientoptions"/>

<links key="emailaddresses" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/resources/testResource1/emailaddresses"/>

<links key="groupmemberships" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/resources/testResource1/groupmemberships"/>

<links key="gwcheck" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/resources/testResource1/gwcheck"/>

<links key="nicknames" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/resources/testResource1/nicknames"/>

<links key="restorearea" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/resources/testResource1/restorearea"/>

<links key="restoremailbox" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/resources/testResource1/restoremailbox"/>

<links key="postoffice" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1"/>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<string>testResource1.testPO1.testDom1@testdomain.com</string>

</emailAddresses>

<visibility>SYSTEM</visibility>

<inheritedFrom>testSystem1</inheritedFrom>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</inheritedValue>

<value>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</value>

</allowedAddressFormats>

Sample Requests and Responses 127

<inheritedFrom>testSystem1</inheritedFrom>

<inheritedValue>testdomain.com</inheritedValue>

<value>testdomain.com</value>

</internetDomainName>

<inheritedFrom>testSystem1</inheritedFrom>

</preferredAddressFormat>

<inheritedFrom>testSystem1</inheritedFrom>

</enableICalBrowse>

<owner>testUser1</owner>

<resourceType>RESOURCE</resourceType>

</resource>

Finding a Nickname in the GroupWise System

Request:

GET https://localhost:9710/gwadmin-service/list/

NICKNAME?name=testNicknameName1

Response Status:

200 - OK

JSON Response:

{

"id" : "NICKNAME.testDom1.testPO1.testNicknameName1",

"guid" : "3E2536E0-09EF-0000-8A08-20888CC82C5A",

"name" : "testNicknameName1",

"links" : null,

"timeCreated" : 1371072314000,

"timeLastMod" : 1371072314000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : null,

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : null,

"internetDomainName" : null,

"preferredAddressFormat" : null,

"preferredEmailId" : null,

128 Sample Requests and Responses

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : null,

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "testNicknameSurname1",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

Sample Requests and Responses 129

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"referredUserName" : null,

"userName" : "testUser1",

"userPostOfficeName" : "testPO1",

"userDomainName" : "testDom1",

"realMemberType" : "USER",

"moveComplete" : null,

"directoryUser" : false,

"@type" : "nickname",

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

nicknames/testNicknameName1"

}

XML Response:

<id>NICKNAME.testDom1.testPO1.testNicknameName1</id>

<name>testNicknameName1</name>

<objType>nickname</objType>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/nicknames/

testNicknameName1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<visibility>SYSTEM</visibility>

<surname>testNicknameSurname1</surname>

<userName>testUser1</userName>

<userPostOfficeName>testPO1</userPostOfficeName>

<userDomainName>testDom1</userDomainName>

</nickname>

NOTE: The

?name

query automatically does end of name wildcard searching.

130 Sample Requests and Responses

Finding a Nickname in a Post Office

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/nicknames/testNicknameName1

Response Status:

200 - OK

JSON Response:

{

"id" : "NICKNAME.testDom1.testPO1.testNicknameName1",

"guid" : "3E2536E0-09EF-0000-8A08-20888CC82C5A",

"name" : "testNicknameName1",

"links" : [ {

"@title" : "domain",

"@href" : "/gwadmin-service/domains/testDom1"

}, {

"@title" : "postoffice",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1"

}, {

"@title" : "emailaddresses",

"@href" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

nicknames/testNicknameName1/emailaddresses"

} ],

"timeCreated" : 1371072314000,

"timeLastMod" : 1371072314000,

"legacyDn" : null,

"lastModifiedBy" : "admin.testSystem1",

"lastModifiedOp" : "ADD",

"pendingOp" : null,

"domainName" : "testDom1",

"postOfficeName" : "testPO1",

"description" : null,

"emailAddresses" : [ "testNicknameName1.testPO1.testDom1@testdomain.com"

],

"visibility" : "SYSTEM",

"defaultInternetAgentName" : null,

"allowedAddressFormats" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : [ "FLAST", "USER", "FIRST_LAST", "HOST",

"LAST_FIRST" ],

"value" : [ "FLAST", "USER", "FIRST_LAST", "HOST", "LAST_FIRST" ]

},

"internetDomainName" : {

"inherited" : true,

"inheritedFrom" : "testSystem1",

"inheritedValue" : "testdomain.com",

"value" : "testdomain.com",

"exclusive" : null

},

"preferredAddressFormat" : {

"inherited" : true,

Sample Requests and Responses 131

"inheritedFrom" : "testSystem1",

"inheritedValue" : "FULL",

"value" : "FULL"

},

"preferredEmailId" : null,

"moveStatus" : null,

"ldapDn" : null,

"ldapId" : null,

"directoryId" : null,

"enableICalBrowse" : null,

"restoreArea" : null,

"expirationDate" : 0,

"externalRecord" : null,

"externalSync" : null,

"fileId" : null,

"accountId" : null,

"city" : null,

"company" : null,

"country" : null,

"department" : null,

"externalEntity" : null,

"externalSyncOverride" : null,

"faxNumber" : null,

"gatewayAccess" : null,

"givenName" : null,

"gwId" : null,

"homePhoneNumber" : null,

"ldapAuthentication" : null,

"location" : null,

"lastClientLoginTime" : null,

"lastClientType" : null,

"loginDisabled" : null,

"mailboxId" : null,

"middleInitial" : null,

"mobilePhoneNumber" : null,

"networkId" : null,

"otherPhoneNumber" : null,

"pagerNumber" : null,

"postalZipCode" : null,

"postOfficeBox" : null,

"stateProvince" : null,

"streetAddress" : null,

"suffix" : null,

"surname" : "testNicknameSurname1",

"telephoneNumber" : null,

"title" : null,

"groupAccessControlUpdateList" : null,

"groupMembersUpdateList" : null,

"adminDefined1" : null,

"adminDefined2" : null,

"adminDefined3" : null,

"adminDefined4" : null,

"adminDefined5" : null,

"adminDefined6" : null,

"adminDefined7" : null,

132 Sample Requests and Responses

"adminDefined8" : null,

"adminDefined9" : null,

"adminDefined10" : null,

"adminDefined11" : null,

"adminDefined12" : null,

"adminDefined13" : null,

"adminDefined14" : null,

"adminDefined15" : null,

"adminDefined16" : null,

"adminDefined17" : null,

"adminDefined18" : null,

"adminDefined19" : null,

"adminDefined20" : null,

"mailboxSizeMb" : null,

"mailboxLicenseType" : null,

"referredUserName" : null,

"userName" : "testUser1",

"userPostOfficeName" : "testPO1",

"userDomainName" : "testDom1",

"realMemberType" : "USER",

"moveComplete" : null,

"directoryUser" : false,

"@type" : null,

"@url" : "/gwadmin-service/domains/testDom1/postoffices/testPO1/

nicknames/testNicknameName1"

}

XML Response:

<id>NICKNAME.testDom1.testPO1.testNicknameName1</id>

<name>testNicknameName1</name>

<url>/gwadmin-service/domains/testDom1/postoffices/testPO1/nicknames/

testNicknameName1</url>

<links key="postoffice" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1"/>

<links key="emailaddresses" href="/gwadmin-service/domains/testDom1/

postoffices/testPO1/nicknames/testNicknameName1/emailaddresses"/>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<domainName>testDom1</domainName>

<postOfficeName>testPO1</postOfficeName>

<string>testNicknameName1.testPO1.testDom1@testdomain.com</string>

</emailAddresses>

<visibility>SYSTEM</visibility>

<inheritedFrom>testSystem1</inheritedFrom>

<AttrNoUsed>FLAST</AttrNoUsed>

Sample Requests and Responses 133

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</inheritedValue>

<value>

<AttrNoUsed>FLAST</AttrNoUsed>

<AttrNoUsed>FIRST_LAST</AttrNoUsed>

<AttrNoUsed>LAST_FIRST</AttrNoUsed>

</value>

</allowedAddressFormats>

<inheritedFrom>testSystem1</inheritedFrom>

<inheritedValue>testdomain.com</inheritedValue>

<value>testdomain.com</value>

</internetDomainName>

<inheritedFrom>testSystem1</inheritedFrom>

</preferredAddressFormat>

<surname>testNicknameSurname1</surname>

<userName>testUser1</userName>

<userPostOfficeName>testPO1</userPostOfficeName>

<userDomainName>testDom1</userDomainName>

</nickname>

Moving Users to a Different Post Office

JSON Request:

POST https://localhost:9710/gwadmin-service/system/moverequests

sources=[{id=USER.testDom1.testPO1.testMoveUser1},

{id=USER.testDom1.testPO1.testMoveUser2},

{id=USER.testDom1.testPO1.testMoveUser3}]

postOfficeId=POST_OFFICE.testDom2.testPO2

JSON Response:

{

"succeeded" : 2,

"failed" : [ {

"id" : "USER.testDom1.testPO1.testMoveUser2",

"status" : {

"error" : true,

"httpStatusCode" : 403,

"statusCode" : 56073,

"statusMsg" : "User owns resources that must be transferred before it

can be deleted",

"locationHeader" : null

}

134 Sample Requests and Responses

} ]

}

XML Request:

POST https://localhost:9710/gwadmin-service/system/moverequests

<moveRequest><sources><id>USER.testDom1.testPO1.testMoveUser1</id></

sources><sources><id>USER.testDom1.testPO1.testMoveUser2</id></

sources><sources><id>USER.testDom1.testPO1.testMoveUser3</id></

sources><postOfficeId>POST_OFFICE.testDom2.testPO2</postOfficeId></

moveRequest>

XML Response:

<id>USER.testDom1.testPO1.testMoveUser2</id>

<statusMsg>User owns resources that must be transferred before it

can be deleted</statusMsg>

</status>

</failed>

</batchResult>

Response Status:

200 - OK

Moving a Group to a Different Post Office

JSON Request:

POST https://localhost:9710/gwadmin-service/system/moverequests

sources=[{id=GROUP.testDom1.testPO1.testMoveGroup1}]

postOfficeId=POST_OFFICE.testDom2.testPO2

JSON Response:

{

"succeeded" : 0,

"failed" : [ {

"id" : "GROUP.testDom1.testPO1.testMoveGroup1",

"status" : {

"error" : true,

"httpStatusCode" : 404,

"statusCode" : 56074,

"statusMsg" : "The object is invalid.

testDom1.testPO1.testMoveGroup1.",

"locationHeader" : null

}

} ]

}

XML Request:

POST https://localhost:9710/gwadmin-service/system/moverequests

Sample Requests and Responses 135

<moveRequest><sources><id>GROUP.testDom1.testPO1.testMoveGroup1</id></

sources><postOfficeId>POST_OFFICE.testDom2.testPO2</postOfficeId></

moveRequest>

XML Response:

<id>GROUP.testDom1.testPO1.testMoveGroup1</id>

<statusMsg>The object is invalid.

testDom1.testPO1.testMoveGroup1.</statusMsg>

</status>

</failed>

</batchResult>

Response Status:

200 - OK

Moving a Resource to a Different Post Office

JSON Request:

POST https://localhost:9710/gwadmin-service/system/moverequests

"sources":[{"id":"RESOURCE.testDom1.testPO1.testMoveResource1",

"resourceOwnerId":"testMoveUser1"}]

"postOfficeId":"POST_OFFICE.testDom2.testPO2"

JSON Response:

{

"succeeded" : 0,

"failed" : [ {

"id" : "RESOURCE.testDom1.testPO1.testMoveResource1",

"status" : {

"error" : true,

"httpStatusCode" : 404,

"statusCode" : 56074,

"statusMsg" : "The object is invalid.

testDom1.testPO1.testMoveResource1.",

"locationHeader" : null

}

} ]

}

XML Request:

POST https://localhost:9710/gwadmin-service/system/moverequests

<moveRequest><sources><id>RESOURCE.testDom1.testPO1.testMoveResource1</

id><resourceOwnerId>testMoveUser1</resourceOwnerId></

sources><postOfficeId>POST_OFFICE.testDom2.testPO2</postOfficeId></

moveRequest>

XML Response:

136 Sample Requests and Responses

<id>RESOURCE.testDom1.testPO1.testMoveResource1</id>

<statusMsg>The object is invalid.

testDom1.testPO1.testMoveResource1.</statusMsg>

</status>

</failed>

</batchResult>

Response Status:

200 - OK

Deleting a User from the GroupWise System

Request:

DELETE https://localhost:9710/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testUser1

Response Status:

200 - OK

Sample Requests and Responses 137

Deleting a User That Owns Resources from the GroupWise

System

Request:

DELETE https://localhost:9710/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testMoveUser2

JSON Response:

{

"error" : true,

"httpStatusCode" : 403,

"statusCode" : 56073,

"statusMsg" : "User owns resources that must be transferred before it can

be deleted",

"locationHeader" : null

}

XML Response:

<statusMsg>User owns resources that must be transferred before it can be

deleted</statusMsg>

</apiStatus>

Response Status:

403 - Forbidden

56073: User owns resources that must be transferred before it can be

deleted

138 Sample Requests and Responses

Deleting a User That Has Been Moved from the GroupWise

System

Request:

DELETE https://localhost:9710/gwadmin-service/domains/testDom1/

postoffices/testPO1/users/testMoveUser3

JSON Response:

{

"error" : true,

"httpStatusCode" : 500,

"statusCode" : 56064,

"statusMsg" : "Pending move or delete operation",

"locationHeader" : null

}

XML Response:

<statusMsg>Pending move or delete operation</statusMsg>

</apiStatus>

Response Status:

500 - Internal Server Error

56064: Pending move or delete operation

Deleting a Group from the GroupWise System

Request:

DELETE https://localhost:9710/gwadmin-service/domains/testDom1/

postoffices/testPO1/groups/testGroup1

Response Status:

200 - OK

Deleting a Member from a Group

Request:

DELETE https://localhost:9710/gwadmin-service/domains/testDom1/

postoffices/testPO1/groups/testGroup1/members/

GROUP.testDom1.testPO1.testUser1

Response Status:

200 - OK

Sample Requests and Responses 139

Deleting a Resource from the GroupWise System

Request:

DELETE https://localhost:9710/gwadmin-service/domains/testDom1/

postoffices/testPO1/resources/testResource1

Response Status:

200 - OK

Deleting a Nickname from the GroupWise System

Request:

DELETE https://localhost:9710/gwadmin-service/domains/testDom1/

postoffices/testPO1/nicknames/testNicknameName1

Response Status:

200 - OK

Requesting the Client Options for a User

Request:

GET https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

Response Status:

200 - OK

JSON Response:

{

"id" : null,

"guid" : null,

"name" : null,

"links" : null,

"timeCreated" : null,

"timeLastMod" : null,

"legacyDn" : null,

"lastModifiedBy" : null,

"lastModifiedOp" : null,

"pendingOp" : null,

"alarmDefaultTime" : {

"lock" : null,

"value" : {

"hours" : 0,

"minutes" : 5,

"timeInMinutes" : 5

},

"restore" : false

},

"alarmWhenAccepted" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

140 Sample Requests and Responses

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"appointmentAcceptedNotification" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"appointmentCleanupAction" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "MANUAL_DELETE_ARCHIVE",

"restore" : false

},

"appointmentCleanupDays" : {

"lock" : null,

"value" : 14,

"restore" : false

},

"appointmentDefaultLength" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : {

"hours" : 1,

"minutes" : 0,

"timeInMinutes" : 60

},

"restore" : false

},

"appointmentDeletedNotification" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

Sample Requests and Responses 141

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"appointmentDisplayMode" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "DURATION",

"restore" : false

},

"appointmentIncludeSelf" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"appointmentOpenedNotification" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"appointmentTrackingAction" : {

"lock" : null,

"value" : "ALL_INFORMATION",

"restore" : false

},

"archiveLocationLinux" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "",

"restore" : false

},

"archiveLocationUnc" : {

142 Sample Requests and Responses

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "",

"restore" : false

},

"autoDeleteSentMail" : {

"lock" : null,

"value" : false,

"restore" : false

},

"autoUpdateUrl" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "",

"restore" : false

},

"autoUpdateEnabled" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"autoUpdateForce" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"autoUpdateGraceLogins" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

Sample Requests and Responses 143

},

"value" : 0,

"restore" : false

},

"autoUpdateAlwaysPrompt" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"boxSizeLimit" : {

"lock" : null,

"value" : 0,

"restore" : false

},

"boxSizeNotify" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"boxSizeWarningThreshold" : {

"lock" : null,

"value" : 0,

"restore" : false

},

"boxThresholdNotify" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"busySearchAppointmentLength" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

144 Sample Requests and Responses

"value" : {

"hours" : 0,

"minutes" : 15,

"timeInMinutes" : 15

},

"restore" : false

},

"busySearchDays" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : [ "THURSDAY", "FRIDAY", "MONDAY", "TUESDAY", "WEDNESDAY" ],

"restore" : false

},

"busySearchFromTime" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : {

"hours" : 8,

"minutes" : 0,

"timeInMinutes" : 480

},

"restore" : false

},

"busySearchRange" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : 7,

"restore" : false

},

"busySearchToTime" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : {

"hours" : 17,

"minutes" : 0,

Sample Requests and Responses 145

"timeInMinutes" : 1020

},

"restore" : false

},

"cachingGraceDays" : {

"lock" : null,

"value" : 14,

"restore" : false

},

"cachingMode" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "ALLOW",

"restore" : false

},

"calendarEndTime" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : {

"hours" : 17,

"minutes" : 0,

"timeInMinutes" : 1020

},

"restore" : false

},

"calendarFirstOfWeek" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "SUNDAY",

"restore" : false

},

"calendarHighlightDays" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : [ "SUNDAY", "SATURDAY" ],

146 Sample Requests and Responses

"restore" : false

},

"calendarShowWeekNumber" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"calendarStartTime" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : {

"hours" : 8,

"minutes" : 0,

"timeInMinutes" : 480

},

"restore" : false

},

"calendarWorkdays" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : [ "THURSDAY", "FRIDAY", "MONDAY", "TUESDAY", "WEDNESDAY" ],

"restore" : false

},

"certificateDownloadUrl" : {

"lock" : null,

"value" : "",

"restore" : false

},

"checkSpelling" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

Sample Requests and Responses 147

"checkSpellingAsYouType" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"classification" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NORMAL",

"restore" : false

},

"clientLicense" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "FULL",

"restore" : false

},

"collaborationSingleSignon" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"colorScheme" : {

"lock" : null,

"value" : "SKY_BLUE",

"restore" : false

},

"composeViews" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

148 Sample Requests and Responses

"modifiable" : true

},

"value" : [ "TEXT", "HTML" ],

"restore" : false

},

"conferencingUrl" : null,

"conferencingEnabled" : null,

"concealSubject" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"convertAttachments" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"createTrackingItem" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"customViewsLocationUnc" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "",

"restore" : false

},

"defaultComposeView" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

Sample Requests and Responses 149

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "HTML",

"restore" : false

},

"defaultLibrary" : {

"lock" : null,

"value" : "",

"restore" : false

},

"defaultReadView" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "HTML",

"restore" : false

},

"delayDelivery" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : -1,

"restore" : false

},

"disableHTMLView" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"displayFolderList" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

150 Sample Requests and Responses

},

"displayMainMenu" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"displayMainToolBar" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"displayNavBar" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"displayQuickViewer" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"doNotPurgeBeforeBackup" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

Sample Requests and Responses 151

},

"edirectoryAuthentication" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"encryptForRecipients" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"encryptionAlgorithm" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"encryptionKeySize" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"forceCacheCleanup" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

152 Sample Requests and Responses

},

"frequentContacts" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : null,

"restore" : false

},

"folderListViewType" : {

"lock" : null,

"value" : [ "FAVORITES", "SIMPLE", "FULL" ],

"restore" : false

},

"globalSignatureApplication" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "EXTERNAL_MESSAGES",

"restore" : false

},

"globalSignatureList" : {

"lock" : null,

"value" : [ "Novell_Global_Signature" ],

"restore" : false

},

"globalSignatureName" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "<Default Global Signature>",

"restore" : false

},

"handleJunkMail" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

Sample Requests and Responses 153

"internetMailTracking" : {

"lock" : null,

"value" : true,

"restore" : false

},

"junkMailCleanupAction" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "AUTO_PURGE",

"restore" : false

},

"junkMailCleanupDays" : {

"lock" : null,

"value" : 14,

"restore" : false

},

"limitsApplyToCache" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"longFolderList" : null,

"mailCleanupAction" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "MANUAL_DELETE_ARCHIVE",

"restore" : false

},

"mailCleanupDays" : {

"lock" : null,

"value" : 30,

"restore" : false

},

"mailDeletedNotification" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

154 Sample Requests and Responses

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"mailOpenedNotification" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"mailTrackingAction" : {

"lock" : null,

"value" : "DELIVERED_OPENED",

"restore" : false

},

"maxMessageSize" : {

"lock" : null,

"value" : 0,

"restore" : false

},

"messageRetention" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"mimeEncoding" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "UTF8",

"restore" : false

},

"moveToPublishedCalendar" : {

"lock" : {

"lockLevel" : "SET_DOMAIN",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

Sample Requests and Responses 155

},

"value" : true,

"restore" : false

},

"noteAcceptedNotification" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"noteDeletedNotification" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"noteOpenedNotification" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"noteTrackingAction" : {

"lock" : null,

"value" : "DELIVERED_OPENED",

"restore" : false

},

"notifyPollInterval" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : {

"minutes" : 1,

"seconds" : 0,

"timeInSeconds" : 60

},

156 Sample Requests and Responses

"restore" : false

},

"openNewView" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"passwordCaching" : null,

"performMaintenancePurges" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"personalAddressBookUserDefinedFields" : {

"lock" : null,

"value" : true,

"restore" : false

},

"promptBeforePurge" : {

"lock" : null,

"value" : false,

"restore" : false

},

"publishCalendar" : {

"lock" : {

"lockLevel" : "SET_DOMAIN",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"publishFreeBusySearch" : {

"lock" : {

"lockLevel" : "SET_DOMAIN",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

Sample Requests and Responses 157

"restore" : false

},

"publishingHost" : {

"lock" : {

"lockLevel" : "SET_DOMAIN",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "testCalPubHost1",

"restore" : false

},

"HTMLReplyFormat" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "GROUPWISE_CLASSIC",

"restore" : false

},

"HTMLReplyFormatIncludeHeaders" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"HTMLReplyFormatTypePosition" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "TOP",

"restore" : false

},

"HTMLReplyFormatIncludeDate" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

158 Sample Requests and Responses

"restore" : false

},

"HTMLReplyFormatIncludeID" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"HTMLReplyFormatIncludeName" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"HTMLReplyFormatIncludeAddress" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"HTMLReplyFormatIncludeSeparator" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"plainTextReplyFormat" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "GROUPWISE_CLASSIC",

Sample Requests and Responses 159

"restore" : false

},

"plainTextReplyFormatSeparatorChar" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : ">",

"restore" : false

},

"plainTextReplyFormatTypePosition" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "TOP",

"restore" : false

},

"plainTextReplyFormatIncludeAddress" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"plainTextReplyFormatIncludeName" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"plainTextReplyFormatIncludeDate" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

160 Sample Requests and Responses

"restore" : false

},

"plainTextReplyFormatIncludeID" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"plainTextReplyFormatIncludeSeparator" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"quickViewerPosition" : {

"lock" : null,

"value" : "BOTTOM",

"restore" : false

},

"readNext" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"readViews" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : [ "TEXT", "HTML" ],

"restore" : false

},

"refreshInterval" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

Sample Requests and Responses 161

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : {

"minutes" : 1,

"seconds" : 0,

"timeInSeconds" : 60

},

"restore" : false

},

"remoteMode" : {

"lock" : null,

"value" : true,

"restore" : false

},

"requirePassword" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"ruleReplyAll" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"ruleReplyLoop" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"sendExpireDays" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

162 Sample Requests and Responses

"modifiable" : true

},

"value" : 0,

"restore" : false

},

"sendIllegalExtensions" : {

"lock" : null,

"value" : "",

"restore" : false

},

"sendNotify" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"sendPriority" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "STANDARD",

"restore" : false

},

"sendRecipientLimit" : {

"lock" : null,

"value" : 0,

"restore" : false

},

"sendReplyRequested" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : 255,

"restore" : false

},

"sharedAddressBook" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

Sample Requests and Responses 163

},

"value" : true,

"restore" : false

},

"sharedFolder" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"showMessengerPresence" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"signDigitally" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"singleSignon" : {

"lock" : null,

"value" : true,

"restore" : false

},

"subscribeCalendar" : {

"lock" : {

"lockLevel" : "SET_DOMAIN",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"taskAcceptedNotification" : {

"lock" : {

164 Sample Requests and Responses

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"taskCompletedNotification" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"taskDeletedNotification" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"taskOpenedNotification" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "NONE",

"restore" : false

},

"taskTrackingAction" : {

"lock" : null,

"value" : "ALL_INFORMATION",

"restore" : false

},

"trashCleanupAction" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

Sample Requests and Responses 165

"value" : "AUTO_PURGE",

"restore" : false

},

"trashCleanupDays" : {

"lock" : null,

"value" : 7,

"restore" : false

},

"treatImapLikeGW" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : null,

"restore" : false

},

"tutorialUrl" : {

"lock" : null,

"value" : "",

"restore" : false

},

"useBlockMailList" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"useColorSchemes" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"useJunkMailList" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

166 Sample Requests and Responses

"restore" : false

},

"useNntpAccounts" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"usePersonalAddressBook" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"usePersonalAddressBookForCalendar" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"usePopImapAccounts" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"userLimits" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

Sample Requests and Responses 167

"restore" : false

},

"userPasswordEnabled" : null,

"userPassword" : null,

"useSmime" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"vibeEnabled" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : false,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"vibeUrl" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "",

"restore" : false

},

"wildcardAddressing" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "LIMITED_TO_POST_OFFICE",

"restore" : false

},

"htmlreplyFormatIncludeHeaders" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

168 Sample Requests and Responses

},

"value" : false,

"restore" : false

},

"htmlreplyFormatTypePosition" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "TOP",

"restore" : false

},

"htmlreplyFormatIncludeDate" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"htmlreplyFormatIncludeName" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"htmlreplyFormatIncludeAddress" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : false,

"restore" : false

},

"htmlreplyFormatIncludeSeparator" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

Sample Requests and Responses 169

},

"value" : true,

"restore" : false

},

"htmlreplyFormat" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : "GROUPWISE_CLASSIC",

"restore" : false

},

"htmlreplyFormatIncludeID" : {

"lock" : {

"lockLevel" : "NONE",

"itemLocked" : false,

"lockAvailable" : true,

"lockRights" : "LOCK_USER",

"modifiable" : true

},

"value" : true,

"restore" : false

},

"@type" : null,

"@url" : null

}

XML Response:

</value>

<restore>false</restore>

</alarmDefaultTime>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</alarmWhenAccepted>

<lock>

<itemLocked>false</itemLocked>

170 Sample Requests and Responses

</lock>

<restore>false</restore>

</appointmentAcceptedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">MANUAL_DELETE_ARCHIVE</value>

<restore>false</restore>

</appointmentCleanupAction>

<restore>false</restore>

</appointmentCleanupDays>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</appointmentDefaultLength>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</appointmentDeletedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

Sample Requests and Responses 171

<value class="AttrNoUsed">DURATION</value>

<restore>false</restore>

</appointmentDisplayMode>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</appointmentIncludeSelf>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</appointmentOpenedNotification>

<value class="AttrNoUsed">ALL_INFORMATION</value>

<restore>false</restore>

</appointmentTrackingAction>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</archiveLocationLinux>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</archiveLocationUnc>

<value class="boolean">false</value>

<restore>false</restore>

</autoDeleteSentMail>

172 Sample Requests and Responses

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<restore>false</restore>

</autoUpdateUrl>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<restore>false</restore>

</autoUpdateEnabled>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</autoUpdateForce>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<restore>false</restore>

</autoUpdateGraceLogins>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</autoUpdateAlwaysPrompt>

Sample Requests and Responses 173

<restore>false</restore>

</boxSizeLimit>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</boxSizeNotify>

<restore>false</restore>

</boxSizeWarningThreshold>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</boxThresholdNotify>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</busySearchAppointmentLength>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value>WEDNESDAY</value>

<value>TUESDAY</value>

<value>MONDAY</value>

174 Sample Requests and Responses

<value>THURSDAY</value>

<value>FRIDAY</value>

</busySearchDays>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</busySearchFromTime>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</busySearchRange>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</busySearchToTime>

<restore>false</restore>

</cachingGraceDays>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="AttrNoUsed">ALLOW</value>

Sample Requests and Responses 175

<restore>false</restore>

</cachingMode>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</calendarEndTime>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">SUNDAY</value>

<restore>false</restore>

</calendarFirstOfWeek>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value>SATURDAY</value>

<value>SUNDAY</value>

</calendarHighlightDays>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</calendarShowWeekNumber>

<lock>

<itemLocked>false</itemLocked>

176 Sample Requests and Responses

</lock>

</value>

<restore>false</restore>

</calendarStartTime>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value>WEDNESDAY</value>

<value>TUESDAY</value>

<value>MONDAY</value>

<value>THURSDAY</value>

<value>FRIDAY</value>

</calendarWorkdays>

<restore>false</restore>

</certificateDownloadUrl>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</checkSpelling>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</checkSpellingAsYouType>

<lock>

<itemLocked>false</itemLocked>

Sample Requests and Responses 177

</lock>

<value class="AttrNoUsed">NORMAL</value>

<restore>false</restore>

</classification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</clientLicense>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</collaborationSingleSignon>

<restore>false</restore>

</colorScheme>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

</composeViews>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</concealSubject>

<lock>

178 Sample Requests and Responses

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</convertAttachments>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</createTrackingItem>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</customViewsLocationUnc>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</defaultComposeView>

<restore>false</restore>

</defaultLibrary>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

Sample Requests and Responses 179

</defaultReadView>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</delayDelivery>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</disableHTMLView>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</displayFolderList>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</displayMainMenu>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

180 Sample Requests and Responses

</displayMainToolBar>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</displayNavBar>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</displayQuickViewer>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</doNotPurgeBeforeBackup>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</edirectoryAuthentication>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

Sample Requests and Responses 181

</encryptForRecipients>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</encryptionAlgorithm>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</encryptionKeySize>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</forceCacheCleanup>

<lock>

<itemLocked>false</itemLocked>

</lock>

</frequentContacts>

<value>FAVORITES</value>

<value>SIMPLE</value>

</folderListViewType>

<lock>

<itemLocked>false</itemLocked>

182 Sample Requests and Responses

</lock>

<value class="AttrNoUsed">EXTERNAL_MESSAGES</value>

<restore>false</restore>

</globalSignatureApplication>

<string>Novell_Global_Signature</string>

</value>

<restore>false</restore>

</globalSignatureList>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</globalSignatureName>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<restore>false</restore>

</handleJunkMail>

<restore>false</restore>

</internetMailTracking>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">AUTO_PURGE</value>

<restore>false</restore>

</junkMailCleanupAction>

<restore>false</restore>

</junkMailCleanupDays>

<lock>

<itemLocked>false</itemLocked>

Sample Requests and Responses 183

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</limitsApplyToCache>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">MANUAL_DELETE_ARCHIVE</value>

<restore>false</restore>

</mailCleanupAction>

<restore>false</restore>

</mailCleanupDays>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</mailDeletedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</mailOpenedNotification>

<value class="AttrNoUsed">DELIVERED_OPENED</value>

<restore>false</restore>

</mailTrackingAction>

<restore>false</restore>

</maxMessageSize>

<lock>

184 Sample Requests and Responses

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</messageRetention>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</mimeEncoding>

<lock>

<lockLevel>SET_DOMAIN</lockLevel>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</moveToPublishedCalendar>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</noteAcceptedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</noteDeletedNotification>

<lock>

Sample Requests and Responses 185

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</noteOpenedNotification>

<value class="AttrNoUsed">DELIVERED_OPENED</value>

<restore>false</restore>

</noteTrackingAction>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</notifyPollInterval>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</openNewView>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</performMaintenancePurges>

<restore>false</restore>

</personalAddressBookUserDefinedFields>

<value class="boolean">false</value>

<restore>false</restore>

186 Sample Requests and Responses

</promptBeforePurge>

<lock>

<lockLevel>SET_DOMAIN</lockLevel>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</publishCalendar>

<lock>

<lockLevel>SET_DOMAIN</lockLevel>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</publishFreeBusySearch>

<lock>

<lockLevel>SET_DOMAIN</lockLevel>

<itemLocked>false</itemLocked>

</lock>

<value class="string">testCalPubHost1</value>

<restore>false</restore>

</publishingHost>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">GROUPWISE_CLASSIC</value>

<restore>false</restore>

</HTMLReplyFormat>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

Sample Requests and Responses 187

</HTMLReplyFormatIncludeHeaders>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</HTMLReplyFormatTypePosition>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</HTMLReplyFormatIncludeDate>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</HTMLReplyFormatIncludeID>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</HTMLReplyFormatIncludeName>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

188 Sample Requests and Responses

</HTMLReplyFormatIncludeAddress>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</HTMLReplyFormatIncludeSeparator>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">GROUPWISE_CLASSIC</value>

<restore>false</restore>

</plainTextReplyFormat>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</plainTextReplyFormatSeparatorChar>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</plainTextReplyFormatTypePosition>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

Sample Requests and Responses 189

</plainTextReplyFormatIncludeAddress>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</plainTextReplyFormatIncludeName>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</plainTextReplyFormatIncludeDate>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</plainTextReplyFormatIncludeID>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</plainTextReplyFormatIncludeSeparator>

<value class="AttrNoUsed">BOTTOM</value>

<restore>false</restore>

</quickViewerPosition>

<lock>

<itemLocked>false</itemLocked>

190 Sample Requests and Responses

</lock>

<restore>false</restore>

</readNext>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

</readViews>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</refreshInterval>

<restore>false</restore>

</remoteMode>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</requirePassword>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

Sample Requests and Responses 191

</ruleReplyAll>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</ruleReplyLoop>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</sendExpireDays>

<restore>false</restore>

</sendIllegalExtensions>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</sendNotify>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">STANDARD</value>

<restore>false</restore>

</sendPriority>

<restore>false</restore>

</sendRecipientLimit>

<lock>

192 Sample Requests and Responses

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</sendReplyRequested>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</sharedAddressBook>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</sharedFolder>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</showMessengerPresence>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</signDigitally>

Sample Requests and Responses 193

<restore>false</restore>

</singleSignon>

<lock>

<lockLevel>SET_DOMAIN</lockLevel>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</subscribeCalendar>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</taskAcceptedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</taskCompletedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</taskDeletedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

194 Sample Requests and Responses

<restore>false</restore>

</taskOpenedNotification>

<value class="AttrNoUsed">ALL_INFORMATION</value>

<restore>false</restore>

</taskTrackingAction>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">AUTO_PURGE</value>

<restore>false</restore>

</trashCleanupAction>

<restore>false</restore>

</trashCleanupDays>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<restore>false</restore>

</treatImapLikeGW>

<restore>false</restore>

</tutorialUrl>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</useBlockMailList>

<lock>

<itemLocked>false</itemLocked>

</lock>

Sample Requests and Responses 195

<restore>false</restore>

</useColorSchemes>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</useJunkMailList>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</useNntpAccounts>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</usePersonalAddressBook>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</usePersonalAddressBookForCalendar>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

196 Sample Requests and Responses

<restore>false</restore>

</usePopImapAccounts>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</userLimits>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<restore>false</restore>

</useSmime>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</vibeEnabled>

<lock>

<itemLocked>false</itemLocked>

</lock>

Sample Requests and Responses 197

<restore>false</restore>

</vibeUrl>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">LIMITED_TO_POST_OFFICE</value>

<restore>false</restore>

</wildcardAddressing>

</clientOptions>

Updating the Client Options of a User

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

trashCleanupDays={value=7, restore=false}

sendReplyRequested={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=255,

restore=false}

readViews={lock={lockLevel=NONE, itemLocked=false, lockAvailable=false,

lockRights=LOCK_USER, modifiable=true}, value=[TEXT, HTML], restore=false}

appointmentDefaultLength={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value={hours=1, minutes=0, timeInMinutes=60}, restore=false}

taskDeletedNotification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

junkMailCleanupAction={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=AUTO_PURGE, restore=false}

publishFreeBusySearch={lock={lockLevel=LOCK_USER, itemLocked=true,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

cachingMode={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=ALLOW,

restore=false}

concealSubject={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

checkSpellingAsYouType={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

cachingGraceDays={value=14, restore=false}

boxSizeWarningThreshold={value=0, restore=false}

sharedFolder={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

messageRetention={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=false,

198 Sample Requests and Responses

restore=false}

displayMainToolBar={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

autoUpdateUrl={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=,

restore=false}

plainTextReplyFormatIncludeID={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

appointmentIncludeSelf={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

boxThresholdNotify={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

defaultComposeView={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=HTML,

restore=false}

showMessengerPresence={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

plainTextReplyFormatIncludeDate={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

htmlreplyFormatIncludeID={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

usePersonalAddressBookForCalendar={lock={lockLevel=NONE,

itemLocked=false, lockAvailable=true, lockRights=LOCK_USER,

modifiable=true}, value=false, restore=false}

vibeUrl={lock={lockLevel=SET_USER, itemLocked=false, lockAvailable=true,

lockRights=LOCK_USER, modifiable=true}, value=https://vibe.novell.com,

restore=false}

plainTextReplyFormatIncludeName={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

promptBeforePurge={value=false, restore=false}

archiveLocationUnc={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=,

restore=false}

useBlockMailList={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

HTMLReplyFormatIncludeSeparator={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

frequentContacts={value=[SEND_SAVE_INT, RECV_SAVE_INT, RECV_SAVE_EXT,

SEND_SAVE_EXT, RECV_SAVE_TO_ME, AUTO_SAVE], restore=false}

collaborationSingleSignon={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

alarmDefaultTime={value={hours=1, minutes=0, timeInMinutes=60},

restore=false}

htmlreplyFormatIncludeAddress={lock={lockLevel=NONE, itemLocked=false,

Sample Requests and Responses 199

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

useSmime={lock={lockLevel=NONE, itemLocked=false, lockAvailable=false,

lockRights=LOCK_USER, modifiable=true}, value=true, restore=false}

plainTextReplyFormatIncludeSeparator={lock={lockLevel=NONE,

itemLocked=false, lockAvailable=true, lockRights=LOCK_USER,

modifiable=true}, value=true, restore=false}

sendPriority={lock={lockLevel=SET_USER, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=HIGH,

restore=false}

plainTextReplyFormat={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=GROUPWISE_CLASSIC, restore=false}

edirectoryAuthentication={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

noteAcceptedNotification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

personalAddressBookUserDefinedFields={value=true, restore=false}

appointmentCleanupDays={value=14, restore=false}

calendarFirstOfWeek={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=SUNDAY,

restore=false}

busySearchFromTime={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value={hours=8, minutes=0, timeInMinutes=480}, restore=false}

plainTextReplyFormatTypePosition={lock={lockLevel=NONE,

itemLocked=false, lockAvailable=true, lockRights=LOCK_USER,

modifiable=true}, value=TOP, restore=false}

noteDeletedNotification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

calendarWorkdays={lock={lockLevel=SET_USER, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=[THURSDAY, MONDAY, TUESDAY, WEDNESDAY], restore=false}

mailDeletedNotification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

noteOpenedNotification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

plainTextReplyFormatSeparatorChar={lock={lockLevel=NONE,

itemLocked=false, lockAvailable=true, lockRights=LOCK_USER,

modifiable=true}, value=>, restore=false}

sendNotify={lock={lockLevel=NONE, itemLocked=false, lockAvailable=true,

lockRights=LOCK_USER, modifiable=true}, value=true, restore=false}

refreshInterval={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value={minutes=1, seconds=0, timeInSeconds=60}, restore=false}

plainTextReplyFormatIncludeAddress={lock={lockLevel=NONE,

itemLocked=false, lockAvailable=true, lockRights=LOCK_USER,

modifiable=true}, value=false, restore=false}

appointmentAcceptedNotification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

200 Sample Requests and Responses

restore=false}

moveToPublishedCalendar={lock={lockLevel=SET_DOMAIN, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

userLimits={lock={lockLevel=NONE, itemLocked=false, lockAvailable=false,

lockRights=LOCK_USER, modifiable=true}, value=false, restore=false}

useJunkMailList={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

encryptionAlgorithm={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

publishingHost={lock={lockLevel=SET_DOMAIN, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=testCalPubHost1, restore=false}

limitsApplyToCache={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

htmlreplyFormatTypePosition={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=TOP,

restore=false}

usePopImapAccounts={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

delayDelivery={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=-1,

restore=false}

vibeEnabled={lock={lockLevel=SET_USER, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

mailOpenedNotification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

composeViews={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=[TEXT,

HTML], restore=false}

busySearchToTime={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value={hours=17, minutes=0, timeInMinutes=1020}, restore=false}

globalSignatureApplication={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=EXTERNAL_MESSAGES, restore=false}

ruleReplyLoop={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

boxSizeLimit={value=0, restore=false}

taskOpenedNotification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

mailTrackingAction={value=DELIVERED_OPENED, restore=false}

customViewsLocationUnc={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=,

restore=false}

HTMLReplyFormatIncludeHeaders={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

Sample Requests and Responses 201

restore=false}

HTMLReplyFormatIncludeDate={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

junkMailCleanupDays={value=14, restore=false}

displayMainMenu={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

sendRecipientLimit={value=0, restore=false}

appointmentCleanupAction={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=MANUAL_DELETE_ARCHIVE, restore=false}

useNntpAccounts={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

handleJunkMail={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

globalSignatureName={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=<Default

Global Signature>, restore=false}

displayNavBar={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

taskAcceptedNotification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

certificateDownloadUrl={value=, restore=false}

classification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NORMAL,

restore=false}

sendExpireDays={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=0,

restore=false}

encryptionKeySize={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

trashCleanupAction={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=AUTO_PURGE, restore=false}

HTMLReplyFormatIncludeName={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

autoUpdateForce={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

sharedAddressBook={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

calendarStartTime={lock={lockLevel=SET_USER, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value={hours=7, minutes=30, timeInMinutes=450}, restore=false}

displayFolderList={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

202 Sample Requests and Responses

mailCleanupDays={value=30, restore=false}

HTMLReplyFormat={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=GROUPWISE_CLASSIC, restore=false}

folderListViewType={value=[FAVORITES, SIMPLE, FULL], restore=false}

tutorialUrl={value=, restore=false}

subscribeCalendar={lock={lockLevel=SET_DOMAIN, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

maxMessageSize={value=0, restore=false}

appointmentDisplayMode={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=DURATION, restore=false}

appointmentTrackingAction={value=ALL_INFORMATION, restore=false}

performMaintenancePurges={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

notifyPollInterval={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value={minutes=1, seconds=0, timeInSeconds=60}, restore=false}

ruleReplyAll={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

checkSpelling={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

taskCompletedNotification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

requirePassword={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

globalSignatureList={value=[Novell_Global_Signature], restore=false}

defaultLibrary={value=, restore=false}

openNewView={lock={lockLevel=NONE, itemLocked=false, lockAvailable=true,

lockRights=LOCK_USER, modifiable=true}, value=false, restore=false}

quickViewerPosition={value=BOTTOM, restore=false}

forceCacheCleanup={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

autoUpdateGraceLogins={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=0,

restore=false}

HTMLReplyFormatIncludeID={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

busySearchDays={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=[THURSDAY, FRIDAY, MONDAY, TUESDAY, WEDNESDAY], restore=false}

treatImapLikeGW={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=null,

restore=false}

htmlreplyFormatIncludeName={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

Sample Requests and Responses 203

busySearchRange={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=7,

restore=false}

busySearchAppointmentLength={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value={hours=0, minutes=15, timeInMinutes=15}, restore=false}

calendarEndTime={lock={lockLevel=SET_USER, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value={hours=18, minutes=30, timeInMinutes=1110}, restore=false}

boxSizeNotify={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

publishCalendar={lock={lockLevel=SET_DOMAIN, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

htmlreplyFormatIncludeHeaders={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

sendIllegalExtensions={value=, restore=false}

createTrackingItem={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

internetMailTracking={value=true, restore=false}

signDigitally={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

alarmWhenAccepted={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

calendarShowWeekNumber={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

htmlreplyFormatIncludeSeparator={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

convertAttachments={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

HTMLReplyFormatTypePosition={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=TOP,

restore=false}

autoDeleteSentMail={value=false, restore=false}

doNotPurgeBeforeBackup={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

htmlreplyFormatIncludeDate={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

mimeEncoding={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=UTF8,

restore=false}

archiveLocationLinux={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=,

restore=false}

mailCleanupAction={lock={lockLevel=NONE, itemLocked=false,

204 Sample Requests and Responses

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=MANUAL_DELETE_ARCHIVE, restore=false}

noteTrackingAction={value=DELIVERED_OPENED, restore=false}

disableHTMLView={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

useColorSchemes={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

colorScheme={value=SKY_BLUE, restore=false}

htmlreplyFormat={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=GROUPWISE_CLASSIC, restore=false}

singleSignon={value=true, restore=false}

wildcardAddressing={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true},

value=LIMITED_TO_POST_OFFICE, restore=false}

remoteMode={value=true, restore=false}

displayQuickViewer={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

usePersonalAddressBook={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

clientLicense={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=FULL,

restore=false}

readNext={lock={lockLevel=NONE, itemLocked=false, lockAvailable=true,

lockRights=LOCK_USER, modifiable=true}, value=true, restore=false}

taskTrackingAction={value=ALL_INFORMATION, restore=false}

calendarHighlightDays={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=[SUNDAY,

SATURDAY], restore=false}

autoUpdateEnabled={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=true,

restore=false}

autoUpdateAlwaysPrompt={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=false, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

defaultReadView={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=HTML,

restore=false}

appointmentDeletedNotification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

encryptForRecipients={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

HTMLReplyFormatIncludeAddress={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=false,

restore=false}

appointmentOpenedNotification={lock={lockLevel=NONE, itemLocked=false,

lockAvailable=true, lockRights=LOCK_USER, modifiable=true}, value=NONE,

restore=false}

Sample Requests and Responses 205

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

</value>

<restore>false</restore>

</alarmDefaultTime>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</alarmWhenAccepted>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</appointmentAcceptedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">MANUAL_DELETE_ARCHIVE</value>

<restore>false</restore>

</appointmentCleanupAction>

<restore>false</restore>

</appointmentCleanupDays>

<lock>

<itemLocked>false</itemLocked>

206 Sample Requests and Responses

</lock>

</value>

<restore>false</restore>

</appointmentDefaultLength>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</appointmentDeletedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">DURATION</value>

<restore>false</restore>

</appointmentDisplayMode>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</appointmentIncludeSelf>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</appointmentOpenedNotification>

<value class="AttrNoUsed">ALL_INFORMATION</value>

<restore>false</restore>

Sample Requests and Responses 207

</appointmentTrackingAction>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</archiveLocationLinux>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</archiveLocationUnc>

<value class="boolean">false</value>

<restore>false</restore>

</autoDeleteSentMail>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<restore>false</restore>

</autoUpdateUrl>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<restore>false</restore>

</autoUpdateEnabled>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

208 Sample Requests and Responses

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</autoUpdateForce>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<restore>false</restore>

</autoUpdateGraceLogins>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</autoUpdateAlwaysPrompt>

<restore>false</restore>

</boxSizeLimit>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</boxSizeNotify>

<restore>false</restore>

</boxSizeWarningThreshold>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

Sample Requests and Responses 209

<restore>false</restore>

</boxThresholdNotify>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</busySearchAppointmentLength>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value>WEDNESDAY</value>

<value>TUESDAY</value>

<value>MONDAY</value>

<value>THURSDAY</value>

<value>FRIDAY</value>

</busySearchDays>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</busySearchFromTime>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</busySearchRange>

210 Sample Requests and Responses

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</busySearchToTime>

<restore>false</restore>

</cachingGraceDays>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="AttrNoUsed">ALLOW</value>

<restore>false</restore>

</cachingMode>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</calendarEndTime>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">SUNDAY</value>

<restore>false</restore>

</calendarFirstOfWeek>

Sample Requests and Responses 211

<lock>

<itemLocked>false</itemLocked>

</lock>

<value>SATURDAY</value>

<value>SUNDAY</value>

</calendarHighlightDays>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</calendarShowWeekNumber>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</calendarStartTime>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value>WEDNESDAY</value>

<value>TUESDAY</value>

<value>MONDAY</value>

<value>THURSDAY</value>

</calendarWorkdays>

<restore>false</restore>

</certificateDownloadUrl>

<lock>

212 Sample Requests and Responses

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</checkSpelling>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</checkSpellingAsYouType>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">NORMAL</value>

<restore>false</restore>

</classification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</clientLicense>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</collaborationSingleSignon>

<restore>false</restore>

Sample Requests and Responses 213

</colorScheme>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

</composeViews>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</concealSubject>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</convertAttachments>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</createTrackingItem>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

214 Sample Requests and Responses

</customViewsLocationUnc>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</defaultComposeView>

<restore>false</restore>

</defaultLibrary>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</defaultReadView>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</delayDelivery>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</disableHTMLView>

<lock>

<itemLocked>false</itemLocked>

Sample Requests and Responses 215

</lock>

<restore>false</restore>

</displayFolderList>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</displayMainMenu>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</displayMainToolBar>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</displayNavBar>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</displayQuickViewer>

<lock>

<itemLocked>false</itemLocked>

216 Sample Requests and Responses

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</doNotPurgeBeforeBackup>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</edirectoryAuthentication>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</encryptForRecipients>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</encryptionAlgorithm>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</encryptionKeySize>

<lock>

<itemLocked>false</itemLocked>

Sample Requests and Responses 217

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</forceCacheCleanup>

</frequentContacts>

<value>FAVORITES</value>

<value>SIMPLE</value>

</folderListViewType>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">EXTERNAL_MESSAGES</value>

<restore>false</restore>

</globalSignatureApplication>

<string>Novell_Global_Signature</string>

</value>

<restore>false</restore>

</globalSignatureList>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</globalSignatureName>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

218 Sample Requests and Responses

<restore>false</restore>

</handleJunkMail>

<restore>false</restore>

</internetMailTracking>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">AUTO_PURGE</value>

<restore>false</restore>

</junkMailCleanupAction>

<restore>false</restore>

</junkMailCleanupDays>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</limitsApplyToCache>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">MANUAL_DELETE_ARCHIVE</value>

<restore>false</restore>

</mailCleanupAction>

<restore>false</restore>

</mailCleanupDays>

<lock>

<itemLocked>false</itemLocked>

</lock>

Sample Requests and Responses 219

<restore>false</restore>

</mailDeletedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</mailOpenedNotification>

<value class="AttrNoUsed">DELIVERED_OPENED</value>

<restore>false</restore>

</mailTrackingAction>

<restore>false</restore>

</maxMessageSize>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</messageRetention>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</mimeEncoding>

<lock>

<lockLevel>SET_DOMAIN</lockLevel>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</moveToPublishedCalendar>

220 Sample Requests and Responses

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</noteAcceptedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</noteDeletedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</noteOpenedNotification>

<value class="AttrNoUsed">DELIVERED_OPENED</value>

<restore>false</restore>

</noteTrackingAction>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</notifyPollInterval>

<lock>

<itemLocked>false</itemLocked>

Sample Requests and Responses 221

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</openNewView>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</performMaintenancePurges>

<restore>false</restore>

</personalAddressBookUserDefinedFields>

<value class="boolean">false</value>

<restore>false</restore>

</promptBeforePurge>

<lock>

<lockLevel>SET_DOMAIN</lockLevel>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</publishCalendar>

<lock>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</publishFreeBusySearch>

<lock>

<lockLevel>SET_DOMAIN</lockLevel>

<itemLocked>false</itemLocked>

222 Sample Requests and Responses

</lock>

<value class="string">testCalPubHost1</value>

<restore>false</restore>

</publishingHost>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">GROUPWISE_CLASSIC</value>

<restore>false</restore>

</HTMLReplyFormat>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</HTMLReplyFormatIncludeHeaders>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</HTMLReplyFormatTypePosition>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</HTMLReplyFormatIncludeDate>

<lock>

<itemLocked>false</itemLocked>

Sample Requests and Responses 223

</lock>

<restore>false</restore>

</HTMLReplyFormatIncludeID>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</HTMLReplyFormatIncludeName>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</HTMLReplyFormatIncludeAddress>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</HTMLReplyFormatIncludeSeparator>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">GROUPWISE_CLASSIC</value>

<restore>false</restore>

</plainTextReplyFormat>

<lock>

<itemLocked>false</itemLocked>

224 Sample Requests and Responses

</lock>

<restore>false</restore>

</plainTextReplyFormatSeparatorChar>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</plainTextReplyFormatTypePosition>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</plainTextReplyFormatIncludeAddress>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</plainTextReplyFormatIncludeName>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</plainTextReplyFormatIncludeDate>

<lock>

<itemLocked>false</itemLocked>

Sample Requests and Responses 225

</lock>

<restore>false</restore>

</plainTextReplyFormatIncludeID>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</plainTextReplyFormatIncludeSeparator>

<value class="AttrNoUsed">BOTTOM</value>

<restore>false</restore>

</quickViewerPosition>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</readNext>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

</readViews>

<lock>

<itemLocked>false</itemLocked>

</lock>

</value>

<restore>false</restore>

</refreshInterval>

226 Sample Requests and Responses

<restore>false</restore>

</remoteMode>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</requirePassword>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</ruleReplyAll>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</ruleReplyLoop>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</sendExpireDays>

<restore>false</restore>

</sendIllegalExtensions>

<lock>

Sample Requests and Responses 227

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</sendNotify>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</sendPriority>

<restore>false</restore>

</sendRecipientLimit>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</sendReplyRequested>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</sharedAddressBook>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

228 Sample Requests and Responses

</sharedFolder>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</showMessengerPresence>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</signDigitally>

<restore>false</restore>

</singleSignon>

<lock>

<lockLevel>SET_DOMAIN</lockLevel>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</subscribeCalendar>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</taskAcceptedNotification>

<lock>

<itemLocked>false</itemLocked>

Sample Requests and Responses 229

</lock>

<restore>false</restore>

</taskCompletedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</taskDeletedNotification>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</taskOpenedNotification>

<value class="AttrNoUsed">ALL_INFORMATION</value>

<restore>false</restore>

</taskTrackingAction>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">AUTO_PURGE</value>

<restore>false</restore>

</trashCleanupAction>

<restore>false</restore>

</trashCleanupDays>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<restore>false</restore>

230 Sample Requests and Responses

</treatImapLikeGW>

<restore>false</restore>

</tutorialUrl>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</useBlockMailList>

<lock>

<itemLocked>false</itemLocked>

</lock>

<restore>false</restore>

</useColorSchemes>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</useJunkMailList>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</useNntpAccounts>

<lock>

<itemLocked>false</itemLocked>

Sample Requests and Responses 231

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</usePersonalAddressBook>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</usePersonalAddressBookForCalendar>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</usePopImapAccounts>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</userLimits>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

</lock>

<restore>false</restore>

</useSmime>

<lock>

<itemLocked>false</itemLocked>

<lockAvailable>false</lockAvailable>

232 Sample Requests and Responses

</lock>

<restore>false</restore>

</vibeEnabled>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="string">https://vibe.novell.com</value>

<restore>false</restore>

</vibeUrl>

<lock>

<itemLocked>false</itemLocked>

</lock>

<value class="AttrNoUsed">LIMITED_TO_POST_OFFICE</value>

<restore>false</restore>

</wildcardAddressing>

</clientOptions>

Response Status:

200 - OK

Setting the GroupWise Password of a User

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

userPassword={value=novell2012, restore=false}

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

<value class="string">novell2012</value>

<restore>false</restore>

</userPassword>

</clientOptions>

Response Status:

200 - OK

Sample Requests and Responses 233

Clearing the GroupWise Password of a User

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

userPassword={restore=true}

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

</userPassword>

</clientOptions>

Response Status:

200 - OK

Restoring the Compose Views of a User

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

composeViews={restore=true}

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

</composeViews>

</clientOptions>

Response Status:

200 - OK

234 Sample Requests and Responses

Modifying the Send Priority Settings of a User

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

sendPriority={value=HIGH, restore=false}

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

<restore>false</restore>

</sendPriority>

</clientOptions>

Response Status:

200 - OK

Modifying the Calendar Settings of a User

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

calendarStartTime={value={hours=7, minutes=30, timeInMinutes=450},

restore=false}

calendarEndTime={value={hours=18, minutes=30, timeInMinutes=1110},

restore=false}

calendarShowWeekNumber={value=false, restore=false}

calendarWorkdays={value=[THURSDAY, MONDAY, TUESDAY, WEDNESDAY],

restore=false}

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

</value>

<restore>false</restore>

</calendarEndTime>

<value class="boolean">false</value>

<restore>false</restore>

</calendarShowWeekNumber>

Sample Requests and Responses 235

</value>

<restore>false</restore>

</calendarStartTime>

<value>WEDNESDAY</value>

<value>TUESDAY</value>

<value>MONDAY</value>

<value>THURSDAY</value>

</calendarWorkdays>

</clientOptions>

Response Status:

200 - OK

Modifying the Alarm Settings of a User

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

alarmDefaultTime={value={hours=1, minutes=0, timeInMinutes=60},

restore=false}

alarmWhenAccepted={value=true, restore=false}

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

</value>

<restore>false</restore>

</alarmDefaultTime>

<restore>false</restore>

</alarmWhenAccepted>

</clientOptions>

Response Status:

200 - OK

236 Sample Requests and Responses

Disabling and Locking the Publish Free Busy Setting of a

User

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

publishFreeBusySearch={lock={itemLocked=true, lockAvailable=false,

modifiable=false}, value=false, restore=false}

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

<lock>

<lockAvailable>false</lockAvailable>

<modifiable>false</modifiable>

</lock>

<value class="boolean">false</value>

<restore>false</restore>

</publishFreeBusySearch>

</clientOptions>

Response Status:

200 - OK

Sample Requests and Responses 237

Enabling the Vibe Access and Configuring the Vibe URL of

a User

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

vibeEnabled={value=true, restore=false}

vibeUrl={value=https://vibe.novell.com, restore=false}

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/users/testUser1/clientoptions

<restore>false</restore>

</vibeEnabled>

<value class="string">https://vibe.novell.com</value>

<restore>false</restore>

</vibeUrl>

</clientOptions>

Response Status:

200 - OK

Performing a Batch Operation to Add Members to a Group

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/members

add=[{id=USER.testDom1.testPO1.testGroupMember4, participation=PRIMARY},

{id=USER.testDom1.testPO1.testGroupMember3, participation=PRIMARY},

{id=USER.testDom1.testPO1.testGroupMember6, participation=PRIMARY},

{id=USER.testDom1.testPO1.testGroupMember5, participation=PRIMARY},

{id=USER.testDom1.testPO1.testGroupMember2, participation=PRIMARY},

{id=USER.testDom1.testPO1.testGroupMember1, participation=PRIMARY}]

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/members

<add>

<id>USER.testDom1.testPO1.testGroupMember4</id>

<participation>PRIMARY</participation>

</add>

<add>

<id>USER.testDom1.testPO1.testGroupMember3</id>

238 Sample Requests and Responses

<participation>PRIMARY</participation>

</add>

<add>

<id>USER.testDom1.testPO1.testGroupMember6</id>

<participation>PRIMARY</participation>

</add>

<add>

<id>USER.testDom1.testPO1.testGroupMember5</id>

<participation>PRIMARY</participation>

</add>

<add>

<id>USER.testDom1.testPO1.testGroupMember2</id>

<participation>PRIMARY</participation>

</add>

<add>

<id>USER.testDom1.testPO1.testGroupMember1</id>

<participation>PRIMARY</participation>

</add>

</groupMemberListUpdate>

Response Status:

200 - OK

Performing a Batch Operation to Modify Members of a

Group

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/members

update=[{id=USER.testDom1.testPO1.testGroupMember4,

participation=CARBON_COPY}, {id=USER.testDom1.testPO1.testGroupMember3,

participation=CARBON_COPY}]

remove=[USER.testDom1.testPO1.testGroupMember5,

USER.testDom1.testPO1.testGroupMember6]

add=[{id=USER.testDom1.testPO1.testGroupMember2, participation=PRIMARY},

{id=USER.testDom1.testPO1.testGroupMember1, participation=PRIMARY}]

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/members

<add>

<id>USER.testDom1.testPO1.testGroupMember2</id>

<participation>PRIMARY</participation>

</add>

<add>

<id>USER.testDom1.testPO1.testGroupMember1</id>

Sample Requests and Responses 239

<participation>PRIMARY</participation>

</add>

<id>USER.testDom1.testPO1.testGroupMember4</id>

<participation>CARBON_COPY</participation>

</update>

<id>USER.testDom1.testPO1.testGroupMember3</id>

<participation>CARBON_COPY</participation>

</update>

<remove>USER.testDom1.testPO1.testGroupMember5</remove>

<remove>USER.testDom1.testPO1.testGroupMember6</remove>

</groupMemberListUpdate>

Response Status:

200 - OK

Performing a Batch Operation to Add ACL Members to a

Group

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/acl

add=[{id=USER.testDom1.testPO1.testGroupMember4, rights=READ},

{id=USER.testDom1.testPO1.testGroupMember3, rights=READ},

{id=USER.testDom1.testPO1.testGroupMember6, rights=READ},

{id=USER.testDom1.testPO1.testGroupMember5, rights=READ}]

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/acl

<add>

<id>USER.testDom1.testPO1.testGroupMember4</id>

</add>

<add>

<id>USER.testDom1.testPO1.testGroupMember3</id>

</add>

240 Sample Requests and Responses

<add>

<id>USER.testDom1.testPO1.testGroupMember6</id>

</add>

<add>

<id>USER.testDom1.testPO1.testGroupMember5</id>

</add>

</accessControlListUpdate>

Response Status:

200 - OK

Performing a Batch Operation to Modify ACL Members of a

Group

JSON Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/acl

update=[{id=USER.testDom1.testPO1.testGroupMember4, rights=WRITE},

{id=USER.testDom1.testPO1.testGroupMember3, rights=WRITE}]

remove=[USER.testDom1.testPO1.testGroupMember5,

USER.testDom1.testPO1.testGroupMember6]

add=[{id=USER.testDom1.testPO1.testGroupMember2, rights=READ},

{id=USER.testDom1.testPO1.testGroupMember1, rights=READ}]

XML Request:

PUT https://localhost:9710/gwadmin-service/domains/testDom1/postoffices/

testPO1/groups/testGroup1/acl

<add>

<id>USER.testDom1.testPO1.testGroupMember2</id>

</add>

<add>

<id>USER.testDom1.testPO1.testGroupMember1</id>

</add>

Sample Requests and Responses 241

<id>USER.testDom1.testPO1.testGroupMember4</id>

<rights>WRITE</rights>

</update>

<id>USER.testDom1.testPO1.testGroupMember3</id>

<rights>WRITE</rights>

</update>

<remove>USER.testDom1.testPO1.testGroupMember5</remove>

<remove>USER.testDom1.testPO1.testGroupMember6</remove>

</accessControlListUpdate>

Response Status:

200 - OK

Creating a Trusted Application Record

JSON Request:

POST https://localhost:9710/gwadmin-service/system/trustedapps

NMAPEnabled=true

enabled=false

archiveServiceAddress=127.0.0.1

queuingDisabled=false

archiveServiceRequiresSsl=true

providesRetentionService=true

name=testTrustedApp1

requiresSsl=true

ipPort=123

allowArchiveService=true

nmapenabled=true

archiveServicePort=456

ipAddress=127.0.0.1

XML Request:

POST https://localhost:9710/gwadmin-service/system/trustedapps

<name>testTrustedApp1</name>

242 Sample Requests and Responses

<enabled>false</enabled>

<queuingDisabled>false</queuingDisabled>

</trustedapp>

Response Status:

201 - Created

Trusted App Key is =

3E52134109EF0000B83CF42E441DDB433E52134209EF0000B5CEAD10E8D9F721

Updating a Trusted Application Record

JSON Request:

PUT https://localhost:9710/gwadmin-service/system/trustedapps/

testTrustedApp1

NMAPEnabled=true

enabled=false

archiveServiceAddress=127.0.0.1

queuingDisabled=false

providesRetentionService=true

timeLastMod=1371072314000

requiresSsl=false

ipPort=123

timeCreated=1371072314000

nmapenabled=true

archiveServicePort=456

id=TRUSTED_APP.testTrustedApp1

lastModifiedOp=ADD

archiveServiceRequiresSsl=true

@url=/gwadmin-service/system/trustedapps/testTrustedApp1

description=Trusted App is modified.

name=testTrustedApp1

lastModifiedBy=admin.testSystem1

allowArchiveService=false

ipAddress=127.0.0.1

XML Request:

PUT https://localhost:9710/gwadmin-service/system/trustedapps/

testTrustedApp1

<id>TRUSTED_APP.testTrustedApp1</id>

<name>testTrustedApp1</name>

<url>/gwadmin-service/system/trustedapps/testTrustedApp1</url>

<lastModifiedBy>admin.testSystem1</lastModifiedBy>

<allowArchiveService>false</allowArchiveService>

Sample Requests and Responses 243

<description>Trusted App is modified.</description>

<requiresSsl>false</requiresSsl>

<enabled>false</enabled>

<queuingDisabled>false</queuingDisabled>

</trustedapp>

Response Status:

200 - OK

Deleting a Trusted Application Record

Request:

DELETE https://localhost:9710/gwadmin-service/system/trustedapps/

testTrustedApp1

Response Status:

200 - OK

244 Sample Requests and Responses

B

Valid and Invalid Characters 245

B

Valid and Invalid Characters

Although most characters in the languages supported by GroupWise can be used in GroupWise

object names and Internet email addresses, some cannot.

 “Invalid Characters in GroupWise Object Names” on page 245

 “Valid Characters in Internet Email Addresses” on page 245

Invalid Characters in GroupWise Object Names

Do not use any of the characters listed below in the names of GroupWise objects:

 ASCII characters 0-31

 Asterisk *

 At sign @

 Braces { }

 Colon :

 Comma ,

 Double quote "

 Extended ASCII characters that are graphical or typographical symbols

IMPORTANT: Accented characters in the extended range can be used in GroupWise object

names.

 Parentheses ( )

 Period .

Valid Characters in Internet Email Addresses

Internet email addresses must include only RFC-compliant characters in the string before the @

symbol. For example:

Dave.Nelso[email protected]om

Valid characters before the @ include those listed below.

 Numbers 0-9

 Uppercase letters A-Z

 Lowercase letters a-z

 Plus sign +

 Hyphen -

 Underscore _

 Tilde ~

 Exclamation point !

 Number sign #

 Dollar sign $

 Percent sign %

 Ampersand &

 Single quote ‘

 Period .

 Forward slash /

 Equal sign =

 Caret ^

 Accent mark '

 Left curly brace {

 Vertical bar |

 Right curly brace }

246 Valid and Invalid Characters

In the names of GroupWise objects that can appear in email addresses (users, distribution lists, and

resources), use underscores (_) rather than spaces as separators between words to facilitate

addressing across the Internet.

If it is important for GroupWise object names to include characters that are invalid in email

addresses, you can set up preferred email IDs for those objects in order to give them valid email

addresses.

For instructions on providing valid email addresses for GroupWise objects, see the following sections

in the GroupWise Administration Guide:

 “Changing a User’s Internet Addressing Settings”

 “Changing a Group’s Internet Addressing Settings”

 “Changing a Resource’s Internet Addressing Settings”