NATS5 REST API Member PATCH age verification
From TMM Wiki
Jump to navigationJump to searchPATCH /member/member_age_verification
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/member_age_verification
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
You must send either: memberid or both username and siteid. In order to verify the age verification status of a member, the company field will also need to be populated by this API call.
- memberid
- optional
- username
- optional
- siteid
- optional
- verified
- optional
- countryid
- optional
- firstname
- optional
- username
- optional
- lastname
- optional
- address1
- optional
- address2
- optional
- city
- optional
- state
- optional
- country
- optional
- zip
- optional
- phone
- optional
- dob
- optional
- response
- optional
- date
- optional
- phone
- optional
- phone_verify
- optional
- company
- optional
- verify_method
- optional
- uuid
- optional
Example Request
Method: PATCH
URL: http://domain/api/member/member_age_verification
Form Data:
- memberid: 3
- username: testUsername
- siteid: 1
- verified: 1
- company: testAgeverificationcompany
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',
'username' => 'testFirstname',
'siteid' => '1',
'verified' => '1',
'company' => 'testAgeverificationcompany',
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/member/member_age_verification',
'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);
?>
