GET api/v1/systems/{systemPhoneNumber}/mailboxesWithCounts

Provides info with counts on mailboxes for the application with the given system phone number that the user has access to

Request Information

URI Parameters

Name	Description	Type	Additional information
systemPhoneNumber	A system phone number on the app containing the mailboxes	string	Required

Body Parameters

None.

Response Information

Resource Description

200 status code and mailbox info such as unread messages count, display name and mailbox number for each mailbox. 402 status code will be returned if system number is on hold. 403 status code will be returned if user doesn't have permission to use that system or presentation number.

Collection of MailboxWithCounts

Name	Type	Additional information
MailboxNumber	integer	None.
DisplayName	string	None.
UnreadMessages	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "MailboxNumber": 80,
    "DisplayName": "New",
    "UnreadMessages": 25
  },
  {
    "MailboxNumber": 80,
    "DisplayName": "Saved",
    "UnreadMessages": 15
  }
]

application/xml, text/xml

Sample:

<ArrayOfMailboxWithCounts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.WebLink.Models">
  <MailboxWithCounts>
    <DisplayName>New</DisplayName>
    <MailboxNumber>80</MailboxNumber>
    <UnreadMessages>25</UnreadMessages>
  </MailboxWithCounts>
  <MailboxWithCounts>
    <DisplayName>Saved</DisplayName>
    <MailboxNumber>80</MailboxNumber>
    <UnreadMessages>15</UnreadMessages>
  </MailboxWithCounts>
</ArrayOfMailboxWithCounts>