BlackBerry Web Services for Enterprise Administration
v6.2.0.35
BlackBerry Device Service
v6.2.0.42

API Reference
BlackBerry Device Service 6.2.0 - BlackBerry Web Services for Enterprise Administration

The BlackBerry Web Services for Enterprise Administration are a collection of document-style web services that you can use to create applications to manage your organization's MDM domain.

See:
          Description

Packages
com.rim.ws.enterprise.admin  

 

The BlackBerry Web Services for Enterprise Administration are a collection of document-style web services that you can use to create applications to manage your organization's MDM domain. You can use the BlackBerry Web Services to automate many of the tasks that administrators typically perform using the administration console. For example, you can create an application that automates the process of adding user accounts to the MDM domain, or you can create a self-service portal that allows device users to perform basic management tasks.

The BlackBerry Web Services are installed automatically when you install the administration console for the MDM domain. To use the BlackBerry Web Services, you should be proficient in one of the supported programming languages and in the use of common web services concepts such as XML, SOAP, and WSDL. You should be familiar with the configuration and administration of the MDM domain, including the management of user accounts, groups, IT policies, software configurations, and security settings.

For more information about the BlackBerry Web Services, visit docs.blackberry.com/BWS to read the BlackBerry Web Services Feature and Technical Overview and the BlackBerry Web Services Getting Started Guide.

This API documentation is generated for use with the Apache CXF Web Service framework. Actual syntax may differ on other web service frameworks. The BlackBerry Web Services proxy classes can be successfully generated on the following frameworks:

Language Web Service Framework
Java SE 5.0 Apache CXF 2.6.1 (binary distribution)
  Axis2 v1.5.1
Microsoft Visual Studio 2008 C# Microsoft .NET Framework v2.0-3.0

Additional Definitions

Here is a list of definitions of words that will be used within the API documentation.

BWS date format

A date and time in the format of MM/dd/yyyy HH:mm:ss (eg. 02/29/1992 08:10:24). This value will also be in UTC and no timezone information will be returned.

Enumeration implementation

An implementation of an enumeration to preserve backwards compatibility. Enumeration implementation classes contain a value field and a set of boolean fields where exactly one boolean must be true. It is good practice to set the value field to the name of the boolean field that is set to true, so that if the server does not support the field that is set to true, it can log the value and return it in the error message. This could potentially happen when a new client attempts to pass a boolean to an old server. When the server encounters an enum value which it doesn't support an enumeration implementation object with its UNSUPPORTED_VALUE boolean field set will occur in a response. In this case the name of the unsupported value will be stored in the value field of the enumeration implementation.

Policy

Administrators create and use policies to configure user permissions and security settings on devices. Policies consist of policy rules that administrators can configure to change device functionality. IT policies, Wi-Fi profiles, and VPN profiles are all classified as policies.

RequestMetadata creation

private final static String CLIENT_VERSION = "6.2.0";
private final static String LOCALE = "en_US";
private final static String ORG_UID = "0";

private final static RequestMetadata REQUEST_METADATA = new RequestMetadata();

private static void initializeRequestMetadata()
{
        REQUEST_METADATA.setClientVersion(CLIENT_VERSION);
        REQUEST_METADATA.setLocale(LOCALE);
        REQUEST_METADATA.setOrganizationUid(ORG_UID);
}
       


BlackBerry Web Services for Enterprise Administration
v6.2.0.35
BlackBerry Device Service
v6.2.0.42

Copyright 2010-2012 Research In Motion Limited. All Rights Reserved.