Difference between revisions of "NATS4 REST API Expire Manual Member"

From TMM Wiki
Jump to navigationJump to search
Line 4: Line 4:
 
== '''PUT /member/expiremanual''' ==
 
== '''PUT /member/expiremanual''' ==
 
'''Description'''  
 
'''Description'''  
*The  /member/expiremanual endpoint allows you to expire manual members. This lets you mark your Manually created members as expired in [[NATS]] through an automated process by running code that calls the expire manual member API. This function will need to send all relevant data for a manual member so NATS can expire the manual member as you would through the NATS admin.
+
*The  /member/expiremanual action allows you to expire manual members. This lets you mark your Manually created members as expired in [[NATS]] through an automated process by running code that calls the expire manual member API. This function will need to send all relevant data for a manual member so NATS can expire the manual member as you would through the NATS admin.
  
 
'''Resource URL'''
 
'''Resource URL'''

Revision as of 01:48, 18 March 2015

NATS 4
Members Admin
The Members Admin
View Member Details
Add Member
MySQL Auth
Mod Authn DB
Multisite Access
Member Logging
Member Password Retrieval
OpenID Connect
Mod Auth OpenIDC
ID Numbers
SOAP API
API
API Best Practices
WSDL Cache
Add Affiliate
Add Member Note
Admin Get Adtools
Adtool Categories
Adtool Types
Affiliate Get Campaigns
Bulk Import Adtools
Caching
Decode Natscode
Expire Manual Member
Get Affiliate Campaigns
Get Affiliate Hit Data
Get Affiliate Loginids
Get Affiliate Nats Codes
Get Affiliate Payout
Get Affiliate Program Campaign List
Get_Affiliate_Program_Campaign_List
Get Member Details
Get Member Instant Upgrade String
Get Member Package Upgrade String
Get Member Token Rebuy String
Get Member Upsell String
Get Payment Data
Get Payvia Rule
Get Profit Loss Report
Ping
Record Member Login
Search Affiliate Info
Search Member Info
Send Email API Function
Set Affiliate Admin Settings
Set Affiliate Customs
Set Affiliate Defaults
Set Affiliate Information
Set Affiliate Settings
Set Member Details
Set Payment Status
Set Payvia Rule
REST API
API Overview
API Best Practices
REST API PATH UPDATES
Adtools
GET /adtools/admin
GET /adtools/categories
GET /adtools/types
POST /adtools/importdump
Affiliate
GET /affiliate/campaigns
GET /affiliate/hitdata
GET /affiliate/payout
GET /affiliate/searchinfo
POST /affiliate/addaffiliate
POST /affiliate/invoice
PATCH /affiliate/setadminsettings
PATCH /affiliate/setcustoms
PATCH /affiliate/setdefaults
PATCH /affiliate/setinformation
PATCH /affiliate/setpayviainfo
PATCH /affiliate/setsettings
PATCH /affiliate/status
Member
GET /member/authstring
GET /member/details
GET /member/searchinfo
GET /suggestedcanceloffers
PATCH /member/setdetails
PATCH /member/setexpiration
POST /member/addnote
POST /member/recordlogin
PUT /member/expiremanual
PATCH /member/forget
Option
GET /option/options
GET /option/rule
PATCH /option/rule
PATCH/option/text
POST /option/rule
Payments
GET /payments/getpayments
GET /payviarule
PATCH /payments/setstatus
PATCH /payviarule
Report
GET /profitlossreport
Get /transactionpayouts
GET /report/transaction
Service
GET /service/decodenatscode
GET /service/ping
POST /service/sendemail

PUT /member/expiremanual

Description

  • The /member/expiremanual action allows you to expire manual members. This lets you mark your Manually created members as expired in NATS through an automated process by running code that calls the expire manual member API. This function will need to send all relevant data for a manual member so NATS can expire the manual member as you would through the NATS admin.

Resource URL

  • http://domain/api/v1/member/expiremanual
  • Replace domain with the nats domain

Request Method

  • PUT

Response Format

  • JSON

Authentication

  • HTTP headers

Parameters

Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded. If a memberid is entered, the member with this id will expire. Otherwise a username/site id must be supplied

  • memberid: The Memberid to be expired
    • type: int
    • optional
  • username: The username of the member who should expire
    • type: string
    • optional
  • siteid: The site id the member belongs to
    • type: int
    • optional

Example Request

PUT

http://domain/api/v1/member/expiremanual

  • Response:
"Expired member: 162"

Example Code

PHP

<?php
$curl = curl_init();

$data = array(
    'memberid' => '162',
);

$url = 'http://domain/api/member/expiremanual';

$headers = array(
    'api_key: 44b5498dbcb481a0d00b404c0169af62',
    'api_username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$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);
?>

Python

  • This example requires pip and the request library which can be installed via pip by: 'pip install requests'
import requests
import json

url = 'http://domain/api/member/expiremanual'

payload = {
    'memberid': '162',
}

headers = {
        'api_key': '44b5498dbcb481a0d00b404c0169af62',
        'api_username': 'tmm1phrvezsbu'
        }

res = requests.put(url, data=payload, headers=headers)
print res.json()


node.js

  • This example requires npm and the request module which can be installed via npm by: 'npm install request'
var request = require('request');

data = {
    'memberid': '162',
}

var options = {
    url: 'http://domain/api/member/expiremanual',
    method: 'PUT',
    form: data,
    json: true,
    headers: {
        'api_key': '44b5498dbcb481a0d00b404c0169af62',
        'api_username': 'tmm1phrvezsbu'
    }
};

function callback(error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
    else{
        console.log(body);
    }

}

request(options, callback);

Curl

curl -X PUT 'http://domain/api/member/expiremanual' -H "api_key: 44b5498dbcb481a0d00b404c0169af62" -H "api_username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'memberid=162'