Difference between revisions of "NATS5 REST API Mailing GET mailing-rule"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Mailing GET mailing-rule to NATS5 REST API Mailing GET mailing-rule: Renaming NATS5 API pages) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_mailing_section = true |
}} | }} | ||
== '''GET /mailing/mailing-rule''' == | == '''GET /mailing/mailing-rule''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get a mailing rule | * Get a mailing rule | ||
| 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 31: | Line 32: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/mailing/mailing-rule</nowiki><br/> | URL: <nowiki>http://domain/api/mailing/mailing-rule</nowiki><br/> | ||
| − | Query String: <nowiki>mailid=1&ruleid= | + | Query String: <nowiki>mailid=1&ruleid=1565382548%3A0%3A1</nowiki><br/> |
Response: | Response: | ||
| Line 40: | Line 41: | ||
"mailid": "1", | "mailid": "1", | ||
"rule_type": "1", | "rule_type": "1", | ||
| − | "identid": " | + | "identid": "7", |
| − | "mailok": " | + | "mailok": "1", |
"status_compare": ">=", | "status_compare": ">=", | ||
| − | "signup": | + | "signup": 5, |
| − | "amount": " | + | "amount": "5", |
| − | "traffic": " | + | "traffic": "100", |
"only_once": "0", | "only_once": "0", | ||
"trial": "0", | "trial": "0", | ||
| − | "start_time": " | + | "start_time": "1565382548", |
"end_time": "0", | "end_time": "0", | ||
"payment": "0", | "payment": "0", | ||
"all_email": "0", | "all_email": "0", | ||
| − | "start_nice": "2019- | + | "start_nice": "2019-08-09 16:29:08", |
"end_nice": "FOREVER", | "end_nice": "FOREVER", | ||
"rule_status": 1, | "rule_status": 1, | ||
"advanced": 1, | "advanced": 1, | ||
| − | "signup_converted": | + | "signup_converted": 5, |
"override_identifier_id": [ | "override_identifier_id": [ | ||
| − | " | + | "7" |
], | ], | ||
| − | "ruleid": " | + | "ruleid": "1565382548:0:1", |
| + | "affiliate": { | ||
| + | "productsupport": "productsupport" | ||
| + | }, | ||
"rule_type_nice": "SEND", | "rule_type_nice": "SEND", | ||
"login": [ | "login": [ | ||
{ | { | ||
| − | "id": | + | "id": "1", |
| − | "name": " | + | "name": "productsupport" |
} | } | ||
], | ], | ||
"program": [ | "program": [ | ||
{ | { | ||
| − | "id": | + | "id": "1", |
| − | "name": " | + | "name": "50% Revshare" |
} | } | ||
], | ], | ||
| Line 100: | Line 104: | ||
"amount_range": [ | "amount_range": [ | ||
{ | { | ||
| − | "id": " | + | "id": "1", |
| − | "name": " | + | "name": "This period" |
} | } | ||
], | ], | ||
| Line 115: | Line 119: | ||
"name": "Current day" | "name": "Current day" | ||
} | } | ||
| − | ] | + | ], |
| + | "signup_nice": "ANY 5 Days", | ||
| + | "traffic_nice": "ANY 100 Hits Current day", | ||
| + | "amount_nice": "ANY $5 for This period" | ||
} | } | ||
} | } | ||
| Line 137: | Line 144: | ||
$data = Array( | $data = Array( | ||
'mailid' => 1, | 'mailid' => 1, | ||
| − | 'ruleid' => ' | + | 'ruleid' => '1565382548:0:1', |
); | ); | ||
| Line 179: | Line 186: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_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 --> | [[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 /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=1565382548%3A0%3A1
Response:
{
"success": true,
"affiliate_mailing_rule": {
"mailid": "1",
"rule_type": "1",
"identid": "7",
"mailok": "1",
"status_compare": ">=",
"signup": 5,
"amount": "5",
"traffic": "100",
"only_once": "0",
"trial": "0",
"start_time": "1565382548",
"end_time": "0",
"payment": "0",
"all_email": "0",
"start_nice": "2019-08-09 16:29:08",
"end_nice": "FOREVER",
"rule_status": 1,
"advanced": 1,
"signup_converted": 5,
"override_identifier_id": [
"7"
],
"ruleid": "1565382548:0:1",
"affiliate": {
"productsupport": "productsupport"
},
"rule_type_nice": "SEND",
"login": [
{
"id": "1",
"name": "productsupport"
}
],
"program": [
{
"id": "1",
"name": "50% Revshare"
}
],
"status": [
{
"id": "-1",
"name": "ANY"
}
],
"signup_compare": [
{
"id": "",
"name": "ANY"
}
],
"signup_timeframe": [
{
"id": 0,
"name": "Days"
}
],
"amount_compare": [
{
"id": "",
"name": "ANY"
}
],
"amount_range": [
{
"id": "1",
"name": "This period"
}
],
"traffic_compare": [
{
"id": "",
"name": "ANY"
}
],
"traffic_range": [
{
"id": "0",
"name": "Current day"
}
],
"signup_nice": "ANY 5 Days",
"traffic_nice": "ANY 100 Hits Current day",
"amount_nice": "ANY $5 for This period"
}
}
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' => '1565382548: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);
?>
