POST api/RTO/device/PushNotification
To send notification message to SmartPhone device
POST api/RTO/device/PushNotification
Request Information
URI Parameters
None.
Body Parameters
NotificationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| DeviceId |
This is the unique user id of the student which they use for login into RTOManager |
string |
None. |
| UserName |
RTOM User name of the student |
string |
None. |
| ApplicationUrl |
RTOM Instance Url, Required if the userName is provided But not required if the device id is provided. |
string |
None. |
| Url |
RTOM Url |
string |
None. |
| MessageTitle |
Title of message should be provided here ( this is mandatory) |
string |
Required |
| MessageBody |
Body of message should be provided here ( this is optional) |
string |
None. |
| AppAccessToken |
The token is for internal communication only. For example to send message from RTOM to mobile |
string |
Required |
Request Formats
application/json, text/json
{
"DeviceId": "sample string 1",
"UserName": "sample string 2",
"ApplicationUrl": "sample string 3",
"Url": "sample string 4",
"MessageTitle": "sample string 5",
"MessageBody": "sample string 6",
"AppAccessToken": "sample string 7"
}
application/xml, text/xml
<NotificationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MobileApp_WebAPI.Models.RTO"> <AppAccessToken>sample string 7</AppAccessToken> <ApplicationUrl>sample string 3</ApplicationUrl> <DeviceId>sample string 1</DeviceId> <MessageBody>sample string 6</MessageBody> <MessageTitle>sample string 5</MessageTitle> <Url>sample string 4</Url> <UserName>sample string 2</UserName> </NotificationModel>
Response Information
Resource Description
ServiceResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Code |
Response code 0 for success and 1 for error |
string |
Required |
| Message |
Message with description of error in case the response is 1 |
string |
Required |
Response Formats
application/json, text/json
{
"Code": "sample string 1",
"Message": "sample string 2"
}
application/xml, text/xml
<ServiceResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MobileApp_WebAPI.Models.RTO"> <Code>sample string 1</Code> <Message>sample string 2</Message> </ServiceResponseModel>