View source for NATS4 REST API Get Member Instant Upgrade String

{{NATS4 Manual
| show_api_admin_section = true
}}
=For NATS 4.1.14.1+=
<span style="color:red;font-size:200%">If you are on any version of NATS 4.1.14.1 and up, Please refer to the new API call: [[NATS4 REST API Get Member Auth String|GET /member/authstring]]</span>

=Legacy Changes=

Use the following documentation changes if you are using the REST API with NATS versions below 4.1.13.5:

== '''GET /member/instantupgradestring''' ==
'''Description''' 
*The member/instantupgradestring API resource is a feature in [[NATS4]] that allows you to perform an instant upgrade for your [[Ct#Member|members]] using an API call.

'''Resource URL'''
*<nowiki>http://domain/api/member/instantupgradestring</nowiki>
*Replace domain with the nats domain

'''[[NATS4_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*GET

'''Response Format'''
*JSON

'''[[NATS4_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''Paremeters can be sent as url encoded params.'''

These are parameters used to specify which member you're looking for. This function will only return one member; use these filters to choose which one.


In order to get a return from this function, you must use a combination of these filters when requesting information. The possible combinations here are:

* memberid and session
* username and siteid
* username and siteids


*Note: This API function will only look up active members. Looking up an inactive or expired member will cause a blank return. 

* memberid: ''The member ID for the member.''
**'''''type: integer'''''
**'''''optional'''
* session: ''The session ID for the member.''
**'''''type: string'''''
**'''''optional'''
* siteid: ''The site id you want.''
**'''''type: integer'''''
**'''''optional'''
* siteids: ''Comma separated site ids. ex: ('1,2,3,4')''
**'''''type: string'''''
**'''''optional'''
* username: ''The username for the member.''
**'''''type: string'''''
**'''''optional'''

== '''Example Request''' ==

'''GET'''

<nowiki>http://domain/api/member/instantupgradestring</nowiki>

*Response: 
<pre>
{
    "instant_upgrade_string": "035a4935e9cfc646c7b0737edc6ad009"
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
    'username' => 'testakovsky2',
    'siteid' => 1
);

$data_string = http_build_query($data);
$url = 'http://domain/api/member/instantupgradestring?'.$data_string;

$headers = array(
    'api-key: 44b5498dbcb481a0d00b404c0169af62',
    'api-username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
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);
?>

</pre>

'''Python'''
*This example requires pip and the request library which can be installed via pip by: 'pip install requests'
<pre>
import requests

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

params = {
        'username': 'testakovsky2',
        'siteid': '1'
}

headers = {
     'api-key': '44b5498dbcb481a0d00b404c0169af62',
     'api-username': 'tmm1phrvezsbu'
}


res = requests.get(url, params=params, headers=headers)

print res.json()

</pre>

'''node.js'''
*This example requires npm and the request module which can be installed via npm by: 'npm install request'
<pre>
var request = require('request');

var options = {
    url: 'http://domain/api/member/instantupgradestring',
    method: 'GET',
    qs: {
        'username': 'testakovsky2',
        'siteid': '1'
    },
    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);

</pre>

'''Curl'''
<pre>
curl -X GET 'http://domain/api/member/instantupgradestring?username=testakovsky2&siteid=1' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"
</pre>


[[Category:NATS4 API Articles]]