GET Exchange Mailbox Blackberry Statistics

From Hostway API Documentation
Jump to: navigation, search

Get Blackberry Service Statistics of an existing Exchange Mailbox

Parameters

account_number - string
The account-number that the Exchange resource belongs to
domain_name - string
The domain-name that is associated with the Exchange resource
username - string
The username of the requested mailbox

Response Body

{
   "statistics": {
      "name": "John Lee",
      "pin": 0,
      "deviceType": "unknown",
      "deviceStatus": "Initializing",
      "dataService": 0,
      "forwarded": 0,
      "sent": 0,
      "pending": 0,
      "filtered": 0,
      "lastTransactionResult": "N/A",
      "lastFwdTime": "12/31/1999 16:00:00",
      "lastSentTime": "12/31/1999 16:00:00"
   },
   "links":[
      {"rel": "self", "href": "https://{server_name}/account/{account-id}/exchange/{domain-name}/mailboxes/{username}/blackberry/statistics"}
   ]
} 
 
name - string
name of the mailbox relevant to the Blackberry service
pin - int
Blackberry service's pin code. Returns null when such one does not exist.
deviceType - string
type of the Blackberry device. Returns null when such one is not provided.
deviceStatus - string
current status of the Blackberry device.
dataService - int
show if the data service is enabled. The values can be 0 or 1.
forwarded - int
number of the messages forwarded
sent - int
number of the messages sent
pending - int
number of the messages pending
filtered - int
number of the messages filtered
lastTransactionResult - string
result of the last transaction
lastFwdTime - string
last time when a message was forwarded. Returns null when such one is not provided.
lastSentTime - string
last time when a message was sent. Returns null when such one is not provided.
links - list
Hypermedia for this resource. Links to self.

Response Codes

200
Ok
405
Unsupported method
404
No blackberry service enabled for the relevant mailbox
502
Internal server error
Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox