NATS5 REST API Skin PATCH skin
From TMM Wiki
Revision as of 15:22, 9 August 2019 by TMMJoe (talk | contribs) (TMMJoe moved page NATS4 REST API Skin PATCH skin to NATS5 REST API Skin PATCH skin: Renaming NATS5 API pages)
PATCH /skin/skin
Description
- Edit skin
Resource URL
- http://domain/api/skin/skin
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- skinid
- type: digit
- required
- name
- type: string
- optional
- description
- type: string
- optional
- allowed
- type: string_list (Either a comma-separated string of strings, or a JSON array of strings)
- optional
- defaultfor
- type: string_list (Either a comma-separated string of strings, or a JSON array of strings)
- optional
Example Request
Method: PATCH
URL: http://domain/api/skin/skin
Form Data:
- skinid: 1000
- name: affiliate_updatedSkinName
- description: updated skin description
- allowed: admins
- defaultfor: admins
Response:
{
"success": true,
"result": "skin updated"
}
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(
'skinid' => '1000',
'name' => 'affiliate_updatedSkinName',
'description' => 'updated skin description',
'allowed' => 'admins',
'defaultfor' => 'admins',
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/skin/skin',
'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);
?>
