Difference between revisions of "NATS5 REST API Message GET view"
From TMM Wiki
Jump to navigationJump to search| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_message_section = true |
}} | }} | ||
== '''GET /message/view''' == | == '''GET /message/view''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get a message | * Get a message | ||
| 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 25: | Line 26: | ||
** required | ** required | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/message/view</nowiki><br/> | ||
| + | Query String: <nowiki>messageid=3</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "message": { | ||
| + | "messageid": "3", | ||
| + | "send_date": "1565382565", | ||
| + | "sent_by": "1", | ||
| + | "recip_id": "1", | ||
| + | "subject": "testSubject", | ||
| + | "body": "testBody", | ||
| + | "viewed": "0", | ||
| + | "deleted": "0", | ||
| + | "msg_grp": "1", | ||
| + | "body_nice": "testBody", | ||
| + | "added_by": "1", | ||
| + | "loginid": "1", | ||
| + | "added": "1565382565", | ||
| + | "send_datetime": "2019-08-09 16:29:25", | ||
| + | "notificationid": "3", | ||
| + | "added_by_nice": "productsupport", | ||
| + | "loginid_nice": "productsupport", | ||
| + | "recip_list": [ | ||
| + | { | ||
| + | "loginid": 1, | ||
| + | "username": "productsupport" | ||
| + | }, | ||
| + | { | ||
| + | "loginid": 2, | ||
| + | "username": "tmmvaffiliate" | ||
| + | }, | ||
| + | { | ||
| + | "loginid": 3, | ||
| + | "username": "affiliateTest" | ||
| + | }, | ||
| + | { | ||
| + | "loginid": 4, | ||
| + | "username": "AccountRep" | ||
| + | } | ||
| + | ], | ||
| + | "recip_continued": 0 | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 38: | Line 91: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'messageid' => '3', | |
); | ); | ||
| Line 81: | Line 134: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_message_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 --> | ||
Latest revision as of 15:59, 9 August 2019
GET /message/view
Description
- Get a message
Resource URL
- http://domain/api/message/view
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- messageid
- type: digit
- required
Example Request
Method: GET
URL: http://domain/api/message/view
Query String: messageid=3
Response:
{
"success": true,
"message": {
"messageid": "3",
"send_date": "1565382565",
"sent_by": "1",
"recip_id": "1",
"subject": "testSubject",
"body": "testBody",
"viewed": "0",
"deleted": "0",
"msg_grp": "1",
"body_nice": "testBody",
"added_by": "1",
"loginid": "1",
"added": "1565382565",
"send_datetime": "2019-08-09 16:29:25",
"notificationid": "3",
"added_by_nice": "productsupport",
"loginid_nice": "productsupport",
"recip_list": [
{
"loginid": 1,
"username": "productsupport"
},
{
"loginid": 2,
"username": "tmmvaffiliate"
},
{
"loginid": 3,
"username": "affiliateTest"
},
{
"loginid": 4,
"username": "AccountRep"
}
],
"recip_continued": 0
}
}
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(
'messageid' => '3',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/message/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);
?>
