Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
DescriptionWhen a user has read the the device notification the device notification status must change from NEW to CHECKED. Update the device notification status using this REST API.
Resource Path/{id}/{status}
URL/mdm-admin/notifications/{id}/{status}
HTTP MethodPUT
Request/Response Formatapplication/json
cURL command
Code Block
curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -d @'<JSON_PAYLOAD>' -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/notifications/{id}/{status}
  • For more information on how to generate the <EMM_API_TOKEN>, see Generating the EMM API Token.
  • Define the path to the JSON file, which includes the required properties to update the device notification as the <JSON_PAYLOAD> value. For more information, see the Sample JSON Definition.
  • By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.
  • Provide the ID of the notification you wish you update as the value for {id}.
  • Provide the notification status you wish to update it to as the value for {status}.

    Info

    You can provide NEW or CHECKED as the value for status.

Example: Updating the notification having the device notification ID 3 from the unread to the read status.

Code Block
curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/notifications/3/CHECKED
 Sample output
Code Block
> PUT /mdm-admin/notifications/3/CHECKED HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer c5e2952bd8da8c7d73c68aa92573f3ea
> 
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Fri, 11 Mar 2016 11:23:15 GMT
< Content-Type: application/json
< Content-Length: 82
< Server: WSO2 Carbon Server
{"statusCode":200,"messageFromServer":"Notification status updated successfully."}