Difference between revisions of "NATS5 REST API Reward GET rewards"
From TMM Wiki
Jump to navigationJump to search| Line 28: | Line 28: | ||
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/reward/rewards</nowiki><br/> | ||
| + | Query String: <nowiki>reward_category_id=1</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "rewards": [ | ||
| + | { | ||
| + | "rewardid": "1", | ||
| + | "reward_category_id": "1", | ||
| + | "cost": "20", | ||
| + | "name": "test reward", | ||
| + | "url": "", | ||
| + | "description": null, | ||
| + | "deleted": "0", | ||
| + | "thumb_ext": "" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 41: | Line 67: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'reward_category_id' => '1', | |
); | ); | ||
| Line 87: | Line 113: | ||
[[Category:NATS4_REST_reward_Collection]] | [[Category:NATS4_REST_reward_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 --> | ||
Revision as of 13:29, 7 June 2019
GET /reward/rewards
Description
- Get rewards
Resource URL
- http://domain/api/reward/rewards
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- reward_category_id
- type: digit
- required
- deleted
- type: trinary_digit (0, 1, or 2)
- optional
Example Request
Method: GET
URL: http://domain/api/reward/rewards
Query String: reward_category_id=1
Response:
{
"success": true,
"rewards": [
{
"rewardid": "1",
"reward_category_id": "1",
"cost": "20",
"name": "test reward",
"url": "",
"description": null,
"deleted": "0",
"thumb_ext": ""
}
]
}
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(
'reward_category_id' => '1',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/reward/rewards',
'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);
?>
