POST Api/Message/GetGroupedMessages

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
MobileApplicationID	Applications	None.
Username	string	None.
Password	string	None.
DeviceManufacturer	string	None.
DeviceModel	string	None.
DeviceSDKInt	string	None.
DeviceSDKVersion	string	None.

Request Formats

application/json, text/json

Sample:

{
  "MobileApplicationID": 1,
  "Username": "sample string 1",
  "Password": "sample string 2",
  "DeviceManufacturer": "sample string 3",
  "DeviceModel": "sample string 4",
  "DeviceSDKInt": "sample string 5",
  "DeviceSDKVersion": "sample string 6"
}

application/xml, text/xml

Sample:

<GetGroupedMessagesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <DeviceManufacturer>sample string 3</DeviceManufacturer>
  <DeviceModel>sample string 4</DeviceModel>
  <DeviceSDKInt>sample string 5</DeviceSDKInt>
  <DeviceSDKVersion>sample string 6</DeviceSDKVersion>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
  <MobileApplicationID>SwitchOneConnectAndroid</MobileApplicationID>
</GetGroupedMessagesRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetGroupedMessagesRequest'.

Response Information

Resource Description

GetGroupedMessagesResponse

Name	Type	Additional information
GroupedMessages	Collection of GroupedMessage	None.
Success	boolean	None.
ErrorMessage	string	None.
ServerDateTime	string	None.
ErrorType	Errors	None.

Response Formats

application/json, text/json

Sample:

{
  "GroupedMessages": [
    {
      "MessageTypeID": 1,
      "Header": "sample string 1",
      "SubHeader": "sample string 2",
      "UnreadMessages": 3
    },
    {
      "MessageTypeID": 1,
      "Header": "sample string 1",
      "SubHeader": "sample string 2",
      "UnreadMessages": 3
    }
  ],
  "Success": true,
  "ErrorMessage": "sample string 2",
  "ServerDateTime": "sample string 3",
  "ErrorType": 0
}

application/xml, text/xml

Sample:

<GetGroupedMessagesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <ErrorType>SystemError</ErrorType>
  <ServerDateTime>sample string 3</ServerDateTime>
  <Success>true</Success>
  <GroupedMessages>
    <GroupedMessage>
      <Header>sample string 1</Header>
      <MessageTypeID>MeterConnections</MessageTypeID>
      <SubHeader>sample string 2</SubHeader>
      <UnreadMessages>3</UnreadMessages>
    </GroupedMessage>
    <GroupedMessage>
      <Header>sample string 1</Header>
      <MessageTypeID>MeterConnections</MessageTypeID>
      <SubHeader>sample string 2</SubHeader>
      <UnreadMessages>3</UnreadMessages>
    </GroupedMessage>
  </GroupedMessages>
</GetGroupedMessagesResponse>