GET api/v3/Messages/GetOutboxMessages

Returns all the outbox messages for a user.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Array of MessageResult objects for all the messages in the users Inbox

Collection of MessageResultV3
NameDescriptionTypeAdditional information
Mid

Message Identifier for this message

integer

None.

Sub

Subject of the Message

string

None.

Uid

UserId of the sending user

string

None.

Bdy

Body of the message (may contain html)

string

None.

Son

When the message was sent on

date

None.

Typ

Message Type (0 = Normal, 1 = Callback, 2 = Poll)

integer

None.

Exp

When does the message expire (used for Polls and Callbacks)

date

None.

Rsp

Has the user responded to the message (For Callback and Poll)

boolean

None.

Not

Note for Response (for Callback and Poll)

string

None.

Ron

Responded/Read on (for Callback and Poll)

date

None.

Rty

Response Type

string

None.

Sys

Was this message system generated (i.e. email import)

boolean

None.

Rcpts

Collection of MessageRecipientResult

None.

Response Formats

application/json

Sample:
[
  {
    "Mid": 1,
    "Sub": "sample string 2",
    "Uid": "sample string 3",
    "Bdy": "sample string 4",
    "Son": "2017-05-23T14:45:41.6997634+00:00",
    "Typ": 6,
    "Exp": "2017-05-23T14:45:41.6997634+00:00",
    "Rsp": true,
    "Not": "sample string 8",
    "Ron": "2017-05-23T14:45:41.6997634+00:00",
    "Rty": "sample string 9",
    "Sys": true,
    "Rcpts": [
      {
        "Mid": 1,
        "Uid": "sample string 2",
        "Ron": "2017-05-23T14:45:41.6997634+00:00",
        "Rty": "sample string 3",
        "Not": "sample string 4"
      },
      {
        "Mid": 1,
        "Uid": "sample string 2",
        "Ron": "2017-05-23T14:45:41.6997634+00:00",
        "Rty": "sample string 3",
        "Not": "sample string 4"
      }
    ]
  },
  {
    "Mid": 1,
    "Sub": "sample string 2",
    "Uid": "sample string 3",
    "Bdy": "sample string 4",
    "Son": "2017-05-23T14:45:41.6997634+00:00",
    "Typ": 6,
    "Exp": "2017-05-23T14:45:41.6997634+00:00",
    "Rsp": true,
    "Not": "sample string 8",
    "Ron": "2017-05-23T14:45:41.6997634+00:00",
    "Rty": "sample string 9",
    "Sys": true,
    "Rcpts": [
      {
        "Mid": 1,
        "Uid": "sample string 2",
        "Ron": "2017-05-23T14:45:41.6997634+00:00",
        "Rty": "sample string 3",
        "Not": "sample string 4"
      },
      {
        "Mid": 1,
        "Uid": "sample string 2",
        "Ron": "2017-05-23T14:45:41.6997634+00:00",
        "Rty": "sample string 3",
        "Not": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfMessageResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Messages">
  <MessageResult>
    <Bdy>sample string 4</Bdy>
    <Exp>2017-05-23T14:45:41.6997634+00:00</Exp>
    <Mid>1</Mid>
    <Not>sample string 8</Not>
    <Rcpts>
      <MessageRecipientResult>
        <Mid>1</Mid>
        <Not>sample string 4</Not>
        <Ron>2017-05-23T14:45:41.6997634+00:00</Ron>
        <Rty>sample string 3</Rty>
        <Uid>sample string 2</Uid>
      </MessageRecipientResult>
      <MessageRecipientResult>
        <Mid>1</Mid>
        <Not>sample string 4</Not>
        <Ron>2017-05-23T14:45:41.6997634+00:00</Ron>
        <Rty>sample string 3</Rty>
        <Uid>sample string 2</Uid>
      </MessageRecipientResult>
    </Rcpts>
    <Ron>2017-05-23T14:45:41.6997634+00:00</Ron>
    <Rsp>true</Rsp>
    <Rty>sample string 9</Rty>
    <Son>2017-05-23T14:45:41.6997634+00:00</Son>
    <Sub>sample string 2</Sub>
    <Sys>true</Sys>
    <Typ>6</Typ>
    <Uid>sample string 3</Uid>
  </MessageResult>
  <MessageResult>
    <Bdy>sample string 4</Bdy>
    <Exp>2017-05-23T14:45:41.6997634+00:00</Exp>
    <Mid>1</Mid>
    <Not>sample string 8</Not>
    <Rcpts>
      <MessageRecipientResult>
        <Mid>1</Mid>
        <Not>sample string 4</Not>
        <Ron>2017-05-23T14:45:41.6997634+00:00</Ron>
        <Rty>sample string 3</Rty>
        <Uid>sample string 2</Uid>
      </MessageRecipientResult>
      <MessageRecipientResult>
        <Mid>1</Mid>
        <Not>sample string 4</Not>
        <Ron>2017-05-23T14:45:41.6997634+00:00</Ron>
        <Rty>sample string 3</Rty>
        <Uid>sample string 2</Uid>
      </MessageRecipientResult>
    </Rcpts>
    <Ron>2017-05-23T14:45:41.6997634+00:00</Ron>
    <Rsp>true</Rsp>
    <Rty>sample string 9</Rty>
    <Son>2017-05-23T14:45:41.6997634+00:00</Son>
    <Sub>sample string 2</Sub>
    <Sys>true</Sys>
    <Typ>6</Typ>
    <Uid>sample string 3</Uid>
  </MessageResult>
</ArrayOfMessageResult>