Difference between revisions of "NATS5 REST API Mailing GET mailing-rule"
From TMM Wiki
Jump to navigationJump to search| Line 28: | Line 28: | ||
** required | ** required | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/mailing/mailing-rule</nowiki><br/> | ||
| + | Query String: <nowiki>mailid=1&ruleid=1559929894%3A0%3A1</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "affiliate_mailing_rule": { | ||
| + | "mailid": "1", | ||
| + | "rule_type": "1", | ||
| + | "identid": "1", | ||
| + | "mailok": "0", | ||
| + | "status_compare": ">=", | ||
| + | "signup": "0", | ||
| + | "amount": "0", | ||
| + | "traffic": "0", | ||
| + | "only_once": "0", | ||
| + | "trial": "0", | ||
| + | "start_time": "1559929894", | ||
| + | "end_time": "0", | ||
| + | "payment": "0", | ||
| + | "all_email": "0", | ||
| + | "start_nice": "2019-06-07 13:51:34", | ||
| + | "end_nice": "FOREVER", | ||
| + | "rule_status": 1, | ||
| + | "advanced": 1, | ||
| + | "signup_converted": 0, | ||
| + | "override_identifier_id": [ | ||
| + | "1" | ||
| + | ], | ||
| + | "ruleid": "1559929894:0:1", | ||
| + | "rule_type_nice": "SEND", | ||
| + | "login": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "name": "ALL" | ||
| + | } | ||
| + | ], | ||
| + | "program": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "name": "ALL" | ||
| + | } | ||
| + | ], | ||
| + | "status": [ | ||
| + | { | ||
| + | "id": "-1", | ||
| + | "name": "ANY" | ||
| + | } | ||
| + | ], | ||
| + | "signup_compare": [ | ||
| + | { | ||
| + | "id": "", | ||
| + | "name": "ANY" | ||
| + | } | ||
| + | ], | ||
| + | "signup_timeframe": [ | ||
| + | { | ||
| + | "id": 0, | ||
| + | "name": "Days" | ||
| + | } | ||
| + | ], | ||
| + | "amount_compare": [ | ||
| + | { | ||
| + | "id": "", | ||
| + | "name": "ANY" | ||
| + | } | ||
| + | ], | ||
| + | "amount_range": [ | ||
| + | { | ||
| + | "id": "0", | ||
| + | "name": "Current day" | ||
| + | } | ||
| + | ], | ||
| + | "traffic_compare": [ | ||
| + | { | ||
| + | "id": "", | ||
| + | "name": "ANY" | ||
| + | } | ||
| + | ], | ||
| + | "traffic_range": [ | ||
| + | { | ||
| + | "id": "0", | ||
| + | "name": "Current day" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 41: | Line 135: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'mailid' => 1, | |
| + | 'ruleid' => '1559929894:0:1', | ||
); | ); | ||
| Line 87: | Line 182: | ||
[[Category:NATS4_REST_mailing_Collection]] | [[Category:NATS4_REST_mailing_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:27, 7 June 2019
GET /mailing/mailing-rule
Description
- Get a mailing rule
Resource URL
- http://domain/api/mailing/mailing-rule
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- mailid
- type: digit
- required
- ruleid
- type: string
- required
Example Request
Method: GET
URL: http://domain/api/mailing/mailing-rule
Query String: mailid=1&ruleid=1559929894%3A0%3A1
Response:
{
"success": true,
"affiliate_mailing_rule": {
"mailid": "1",
"rule_type": "1",
"identid": "1",
"mailok": "0",
"status_compare": ">=",
"signup": "0",
"amount": "0",
"traffic": "0",
"only_once": "0",
"trial": "0",
"start_time": "1559929894",
"end_time": "0",
"payment": "0",
"all_email": "0",
"start_nice": "2019-06-07 13:51:34",
"end_nice": "FOREVER",
"rule_status": 1,
"advanced": 1,
"signup_converted": 0,
"override_identifier_id": [
"1"
],
"ruleid": "1559929894:0:1",
"rule_type_nice": "SEND",
"login": [
{
"id": 0,
"name": "ALL"
}
],
"program": [
{
"id": 0,
"name": "ALL"
}
],
"status": [
{
"id": "-1",
"name": "ANY"
}
],
"signup_compare": [
{
"id": "",
"name": "ANY"
}
],
"signup_timeframe": [
{
"id": 0,
"name": "Days"
}
],
"amount_compare": [
{
"id": "",
"name": "ANY"
}
],
"amount_range": [
{
"id": "0",
"name": "Current day"
}
],
"traffic_compare": [
{
"id": "",
"name": "ANY"
}
],
"traffic_range": [
{
"id": "0",
"name": "Current day"
}
]
}
}
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(
'mailid' => 1,
'ruleid' => '1559929894:0:1',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/mailing/mailing-rule',
'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);
?>
