NATS5 REST API Member GET member age verification
From TMM Wiki
Jump to navigationJump to search
PATCH /member/details
Note: This is an autogenerated wiki page for the NATS5 API. There may be additional descriptions or examples available on the NATS 4 API wiki for this API.
Description
- Update member information
Resource URL
- http://domain/api/member/details
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
You must send at least 1 required parameter: subscriptionid, memberidx, and/or memberid
- memberid
- optional
- memberidx
- optional
- subscriptionid
- optional
- trial
- type: digit
- optional
- firstname
- optional
- lastname
- optional
- email
- optional
- address1
- optional
- address2
- optional
- city
- optional
- state
- optional
- country
- optional
- zip
- optional
- flagged
- type: boolean_digit (0 or 1)
- optional
- mailok
- type: boolean_digit (0 or 1)
- optional
- password
- optional
- custom1
- optional
- custom2
- optional
- custom3
- optional
- custom4
- optional
- custom5
- optional
- custom6
- optional
- custom7
- optional
- custom8
- optional
- custom9
- optional
- custom10
- optional
- no_member_note
- type: boolean_digit (0 or 1)
- optional
- username
- optional
- expire
- optional
Example Request
Method: PATCH
URL: http://domain/api/member/details
Form Data:
- memberid: 3
- firstname: testFirstname
- lastname: testLastname
- memberidx: NATS:3
- expire: 2020-06-10
- email: test@email.com
- address1: 123 address street
- city: testCity
- state: NJ
- country: USA
- zip: 12345
Response:
{ "result": "SUCCESS", "return": [ "NATS:3 (3) was updated." ], "success": true }
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( 'memberid' => '3', 'firstname' => 'testFirstname', 'lastname' => 'testLastname', 'memberidx' => 'NATS:3', 'expire' => '2020-06-10', 'email' => 'test@email.com', 'address1' => '123 address street', 'city' => 'testCity', 'state' => 'NJ', 'country' => 'USA', 'zip' => '12345', ); $request = Array( 'method' => 'PATCH', 'path' => 'v1/member/details', '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); ?>