Difference between revisions of "NATS5 REST API Service GET periods"
From TMM Wiki
Jump to navigationJump to search| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_service_section = true |
}} | }} | ||
== '''GET /service/periods''' == | == '''GET /service/periods''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get a list of NATS date period types | * Get a list of NATS date period types | ||
| 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 | ||
== '''Parameters''' == | == '''Parameters''' == | ||
| − | + | '''''Parameters can be sent as url encoded params | |
| + | |||
| + | * '''report''' | ||
| + | ** type: string | ||
| + | ** optional | ||
| + | |||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/service/periods</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "periods": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "name": "This Period" | ||
| + | }, | ||
| + | { | ||
| + | "id": 1, | ||
| + | "name": "Last Period" | ||
| + | }, | ||
| + | { | ||
| + | "id": 2, | ||
| + | "name": "Today" | ||
| + | }, | ||
| + | { | ||
| + | "id": 3, | ||
| + | "name": "Yesterday" | ||
| + | }, | ||
| + | { | ||
| + | "id": 4, | ||
| + | "name": "This Week" | ||
| + | }, | ||
| + | { | ||
| + | "id": 15, | ||
| + | "name": "Past 7 Days" | ||
| + | }, | ||
| + | { | ||
| + | "id": 10, | ||
| + | "name": "Last Week" | ||
| + | }, | ||
| + | { | ||
| + | "id": 5, | ||
| + | "name": "This Month" | ||
| + | }, | ||
| + | { | ||
| + | "id": 28, | ||
| + | "name": "Past 15 Days" | ||
| + | }, | ||
| + | { | ||
| + | "id": 17, | ||
| + | "name": "Past 30 Days" | ||
| + | }, | ||
| + | { | ||
| + | "id": 11, | ||
| + | "name": "Last Month" | ||
| + | }, | ||
| + | { | ||
| + | "id": 12, | ||
| + | "name": "Past 60 Days" | ||
| + | }, | ||
| + | { | ||
| + | "id": 13, | ||
| + | "name": "Past 90 Days" | ||
| + | }, | ||
| + | { | ||
| + | "id": 16, | ||
| + | "name": "Past 180 Days" | ||
| + | }, | ||
| + | { | ||
| + | "id": 6, | ||
| + | "name": "This Year" | ||
| + | }, | ||
| + | { | ||
| + | "id": 14, | ||
| + | "name": "Last Year" | ||
| + | }, | ||
| + | { | ||
| + | "id": 7, | ||
| + | "name": "All Time" | ||
| + | }, | ||
| + | { | ||
| + | "id": 8, | ||
| + | "name": "Freeform" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 76: | Line 169: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_service_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 16:01, 9 August 2019
GET /service/periods
Description
- Get a list of NATS date period types
Resource URL
- http://domain/api/service/periods
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- report
- type: string
- optional
Example Request
Method: GET
URL: http://domain/api/service/periods
Response:
{
"success": true,
"periods": [
{
"id": 0,
"name": "This Period"
},
{
"id": 1,
"name": "Last Period"
},
{
"id": 2,
"name": "Today"
},
{
"id": 3,
"name": "Yesterday"
},
{
"id": 4,
"name": "This Week"
},
{
"id": 15,
"name": "Past 7 Days"
},
{
"id": 10,
"name": "Last Week"
},
{
"id": 5,
"name": "This Month"
},
{
"id": 28,
"name": "Past 15 Days"
},
{
"id": 17,
"name": "Past 30 Days"
},
{
"id": 11,
"name": "Last Month"
},
{
"id": 12,
"name": "Past 60 Days"
},
{
"id": 13,
"name": "Past 90 Days"
},
{
"id": 16,
"name": "Past 180 Days"
},
{
"id": 6,
"name": "This Year"
},
{
"id": 14,
"name": "Last Year"
},
{
"id": 7,
"name": "All Time"
},
{
"id": 8,
"name": "Freeform"
}
]
}
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(
// Add API parameters here
);
$request = Array(
'method' => 'GET',
'path' => 'v1/service/periods',
'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);
?>
