NATS5 REST API News GET news
From TMM Wiki
(Redirected from NATS4 REST API News GET news)
Jump to navigationJump to searchGET /news/news
Description
- Get news
Resource URL
- http://domain/api/news/news
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- news_section_id
- type: digit
- optional
- published
- type: trinary_digit (0, 1, or 2)
- optional
- headline
- type: string
- optional
- newsid
- type: digit
- optional
- order
- type: string
- optional (default value: published)
- order_direction
- type: trinary_digit (0, 1, or 2)
- optional
- start
- type: digit
- optional
- count
- type: digit
- optional
Example Request
Method: GET
URL: http://domain/api/news/news
Query String: news_section_id=1&published=1&headline=test+Headline
Response:
{ "success": true, "total_count": "1", "news": [ { "newsid": "1", "added": "1565382566", "loginid": "1", "news_section_id": "1", "news_section_name": "Announcements", "headline": "test Headline", "publish": "1559275200", "published": 1, "publish_date": "2019-05-31 00:00:00" } ] }
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( 'news_section_id' => 1, 'published' => 1, 'headline' => 'test Headline', ); $request = Array( 'method' => 'GET', 'path' => 'v1/news/news', '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); ?>