Standard and additional elements

The Push Service implements both the elements that are required by the Push Access Protocol (PAP) standard, and some additional elements that provide subscription information. You can use the additional elements to query the Push Service for subscription status.

The standard elements that are available to you depends on the level of service that you selected when you registered with Research In Motion to use the Push Service. The additional elements are available to users of both the Push Essentials and Push Plus levels of service.

Standard elements

The PAP standard describes the following elements. For more information about the PAP standard, visit http://www.openmobilealliance.org to read WAP-247-PAP-20010429-a. You need to accept the use agreement on the website to access the PAP standard.

Element

Attributes supported

Level of Service

<address>

address-value: yes

Push Essentials and Push Plus

<bad-message-response>

  • bad-message-fragment: yes
  • code: yes
  • desc: yes

Push Essentials and Push Plus

<cancel-message>

push-id: yes

Push Plus

<cancel-response>

  • address: yes
  • push-id: yes

Push Plus

<cancel-result>

  • code: yes
  • desc: yes

Push Plus

<ccq-message>

element not supported

<ccq-response>

element not supported

<progress-note>

element not supported

<push-message>

  • deliver-after-timestamp: no
  • deliver-before-timestamp: yes
  • ppg-notify-requested-to: yes
  • progress-notes-requested: no
  • push-id: yes
  • replace-method: no
  • replace-push-id: no
  • source-reference: yes

Push Essentials and Push Plus

<push-response>

  • push-id: yes
  • reply-time: yes
  • sender-address: yes
  • sender-name: yes

Push Essentials and Push Plus

<quality-of-service>

  • bearer: no
  • bearer-required: no
  • delivery-method: yes
  • network: no
  • network-required: no
  • priority: no

Push Essentials and Push Plus

<response-result>

  • code: yes
  • desc: yes

Push Essentials and Push Plus

<resultnotification-message>

  • code: yes
  • desc: yes
  • event-time: yes
  • message-state: yes
  • push-id: yes
  • received-time: yes
  • sender-address: yes
  • sender-name: yes

Push Plus

<resultnotification-response>

  • code: yes
  • desc: yes
  • push-id: yes

Push Plus

<statusquery-message>

  • address: yes
  • push-id: yes

Push Plus

<statusquery-response>

push-id: yes

Push Plus

Additional elements

The Push Service supports the following extensions to the XML commands that are specified in the PAP standard.

Element

Attributes supported

Description

<bpds>

version

This element is a container for RIM-specific commands.

<status>

status-value

This element specifies the status in a query.

<subscriptionquery-detail>

  • event-time
  • status

This element provides information about a specific status.

<subscriptionquery-message>

pushservice-id

This element queries for subscription information. It is sent from the push initiator to the PPG.

<subscriptionquery-response>

pushservice-id

This element contains the response from the PPG to the push initiator.

<subscriptionquery-result>

  • code
  • desc
  • event-time

This element contains the response to a specific query.