POST Api/Message/GetMessages
Request Information
URI Parameters
None.
Body Parameters
GetMessagesRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| MobileApplicationID | Applications |
None. |
|
| MessageTypeID | MessageTypes |
None. |
|
| ScrollPosition | integer |
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,
"MessageTypeID": 1,
"ScrollPosition": 1,
"Username": "sample string 2",
"Password": "sample string 3",
"DeviceManufacturer": "sample string 4",
"DeviceModel": "sample string 5",
"DeviceSDKInt": "sample string 6",
"DeviceSDKVersion": "sample string 7"
}
application/xml, text/xml
Sample:
<GetMessagesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models"> <DeviceManufacturer>sample string 4</DeviceManufacturer> <DeviceModel>sample string 5</DeviceModel> <DeviceSDKInt>sample string 6</DeviceSDKInt> <DeviceSDKVersion>sample string 7</DeviceSDKVersion> <Password>sample string 3</Password> <Username>sample string 2</Username> <MessageTypeID>MeterConnections</MessageTypeID> <MobileApplicationID>SwitchOneConnectAndroid</MobileApplicationID> <ScrollPosition>1</ScrollPosition> </GetMessagesRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
GetMessagesResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Messages | Collection of Message |
None. |
|
| Success | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| ServerDateTime | string |
None. |
|
| ErrorType | Errors |
None. |
Response Formats
application/json, text/json
Sample:
{
"Messages": [
{
"MessageRequestID": "c69b09f5-5835-4a20-9b24-ed344870f691",
"DateCreated": "2026-05-17T03:23:48.099322+02:00",
"Title": "sample string 3",
"Body": "sample string 4",
"MessageRead": true
},
{
"MessageRequestID": "c69b09f5-5835-4a20-9b24-ed344870f691",
"DateCreated": "2026-05-17T03:23:48.099322+02:00",
"Title": "sample string 3",
"Body": "sample string 4",
"MessageRead": true
}
],
"Success": true,
"ErrorMessage": "sample string 2",
"ServerDateTime": "sample string 3",
"ErrorType": 0
}
application/xml, text/xml
Sample:
<GetMessagesResponse 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>
<Messages>
<Message>
<Body>sample string 4</Body>
<DateCreated>2026-05-17T03:23:48.099322+02:00</DateCreated>
<MessageRead>true</MessageRead>
<MessageRequestID>c69b09f5-5835-4a20-9b24-ed344870f691</MessageRequestID>
<Title>sample string 3</Title>
</Message>
<Message>
<Body>sample string 4</Body>
<DateCreated>2026-05-17T03:23:48.099322+02:00</DateCreated>
<MessageRead>true</MessageRead>
<MessageRequestID>c69b09f5-5835-4a20-9b24-ed344870f691</MessageRequestID>
<Title>sample string 3</Title>
</Message>
</Messages>
</GetMessagesResponse>