Difference between revisions of "NATS5 REST API Notification GET view"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Notification GET view to NATS5 REST API Notification GET view: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''GET /notification/view''' == | == '''GET /notification/view''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get a notification | * Get a notification | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 28: | Line 29: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/notification/view</nowiki><br/> | URL: <nowiki>http://domain/api/notification/view</nowiki><br/> | ||
| − | Query String: <nowiki>notificationid= | + | Query String: <nowiki>notificationid=2</nowiki><br/> |
Response: | Response: | ||
| Line 35: | Line 36: | ||
"success": true, | "success": true, | ||
"notification": { | "notification": { | ||
| − | "notificationid": " | + | "notificationid": "2", |
| − | "added": " | + | "added": "1565382566", |
"added_by": "1", | "added_by": "1", | ||
"loginid": "1", | "loginid": "1", | ||
| Line 49: | Line 50: | ||
"added_by_nice": "productsupport", | "added_by_nice": "productsupport", | ||
"loginid_nice": "productsupport", | "loginid_nice": "productsupport", | ||
| − | "send_date": " | + | "send_date": "1565382566", |
| − | "send_datetime": "2019- | + | "send_datetime": "2019-08-09 16:29:26" |
} | } | ||
} | } | ||
| Line 71: | Line 72: | ||
$data = Array( | $data = Array( | ||
| − | 'notificationid' => ' | + | 'notificationid' => '2', |
); | ); | ||
| Line 113: | Line 114: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_notification_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
[[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Revision as of 15:45, 9 August 2019
GET /notification/view
Description
- Get a notification
Resource URL
- http://domain/api/notification/view
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- notificationid
- type: digit
- required
Example Request
Method: GET
URL: http://domain/api/notification/view
Query String: notificationid=2
Response:
{
"success": true,
"notification": {
"notificationid": "2",
"added": "1565382566",
"added_by": "1",
"loginid": "1",
"subject": "unit test notification",
"body": "This is a test of the unit test system. This is only a test.",
"viewed": "0",
"deleted": "0",
"severe": "0",
"popup": "0",
"notification_type_id": "0",
"body_nice": "This is a test of the unit test system. This is only a test.",
"added_by_nice": "productsupport",
"loginid_nice": "productsupport",
"send_date": "1565382566",
"send_datetime": "2019-08-09 16:29:26"
}
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = Array(
'notificationid' => '2',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/notification/view',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
