POST Api/Message/ProcessMessage

Request Information

URI Parameters

None.

Body Parameters

ProcessMessageRequest
NameDescriptionTypeAdditional information
MobileApplicationID

Applications

None.

MessageRequestID

globally unique identifier

None.

MessageResponseType

MessageResponseTypes

None.

ConfirmationValue

ConfirmationValues

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,
  "MessageRequestID": "20dbdae1-0b92-4ed4-92fb-2ef6d6bc640f",
  "MessageResponseType": 1,
  "ConfirmationValue": 0,
  "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:
<ProcessMessageRequest 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>
  <ConfirmationValue>Ignored</ConfirmationValue>
  <MessageRequestID>20dbdae1-0b92-4ed4-92fb-2ef6d6bc640f</MessageRequestID>
  <MessageResponseType>Read</MessageResponseType>
  <MobileApplicationID>SwitchOneConnectAndroid</MobileApplicationID>
</ProcessMessageRequest>

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 'ProcessMessageRequest'.

Response Information

Resource Description

ProcessMessageResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

ErrorMessage

string

None.

ServerDateTime

string

None.

ErrorType

Errors

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "ErrorMessage": "sample string 2",
  "ServerDateTime": "sample string 3",
  "ErrorType": 0
}

application/xml, text/xml

Sample:
<ProcessMessageResponse 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>
</ProcessMessageResponse>