Difference between revisions of "NATS5 REST API Skin GET skins"
From TMM Wiki
Jump to navigationJump to search| Line 20: | Line 20: | ||
None | None | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/skin/skins</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "skins": { | ||
| + | "0": { | ||
| + | "skinid": "0", | ||
| + | "type": "3", | ||
| + | "parentid": "0", | ||
| + | "level": "0", | ||
| + | "name": "Standard Skin", | ||
| + | "description": "", | ||
| + | "allowed": [], | ||
| + | "defaultfor": [], | ||
| + | "use_css": "0", | ||
| + | "css_xml": "", | ||
| + | "skin_css_palette_id": "1", | ||
| + | "nice_name": "Standard Skin" | ||
| + | }, | ||
| + | "102": { | ||
| + | "skinid": "102", | ||
| + | "type": "2", | ||
| + | "parentid": "0", | ||
| + | "level": "1", | ||
| + | "name": "Default Affiliate", | ||
| + | "description": "The main skin for the affiliates.", | ||
| + | "allowed": [ | ||
| + | "affiliate", | ||
| + | "salesrep", | ||
| + | "admin" | ||
| + | ], | ||
| + | "defaultfor": [ | ||
| + | "affiliate" | ||
| + | ], | ||
| + | "use_css": "1", | ||
| + | "css_xml": "", | ||
| + | "skin_css_palette_id": "1", | ||
| + | "nice_name": "Default Affiliate", | ||
| + | "children": [ | ||
| + | { | ||
| + | "skinid": "1000", | ||
| + | "type": "2", | ||
| + | "parentid": "102", | ||
| + | "level": "2", | ||
| + | "name": "testSkin", | ||
| + | "description": "", | ||
| + | "allowed": [], | ||
| + | "defaultfor": [], | ||
| + | "use_css": "1", | ||
| + | "css_xml": "", | ||
| + | "skin_css_palette_id": "1", | ||
| + | "nice_name": "testSkin" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | }, | ||
| + | "skin_list": [ | ||
| + | { | ||
| + | "skinid": "0", | ||
| + | "name": "Standard Skin", | ||
| + | "use_css": "0", | ||
| + | "name_indent": "Standard Skin" | ||
| + | }, | ||
| + | { | ||
| + | "skinid": "102", | ||
| + | "name": "Default Affiliate", | ||
| + | "use_css": "1", | ||
| + | "name_indent": "Default Affiliate" | ||
| + | }, | ||
| + | { | ||
| + | "skinid": "1000", | ||
| + | "name": "testSkin", | ||
| + | "use_css": "1", | ||
| + | "name_indent": "- testSkin" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 33: | Line 118: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = array( | + | $data = array(); |
| − | |||
| − | ); | ||
$request = Array( | $request = Array( | ||
| Line 79: | Line 162: | ||
[[Category:NATS4_REST_skin_Collection]] | [[Category:NATS4_REST_skin_Collection]] | ||
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
| + | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Revision as of 13:30, 7 June 2019
GET /skin/skins
Description
- Get skins
Resource URL
- http://domain/api/skin/skins
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
None
Example Request
Method: GET
URL: http://domain/api/skin/skins
Response:
{
"success": true,
"skins": {
"0": {
"skinid": "0",
"type": "3",
"parentid": "0",
"level": "0",
"name": "Standard Skin",
"description": "",
"allowed": [],
"defaultfor": [],
"use_css": "0",
"css_xml": "",
"skin_css_palette_id": "1",
"nice_name": "Standard Skin"
},
"102": {
"skinid": "102",
"type": "2",
"parentid": "0",
"level": "1",
"name": "Default Affiliate",
"description": "The main skin for the affiliates.",
"allowed": [
"affiliate",
"salesrep",
"admin"
],
"defaultfor": [
"affiliate"
],
"use_css": "1",
"css_xml": "",
"skin_css_palette_id": "1",
"nice_name": "Default Affiliate",
"children": [
{
"skinid": "1000",
"type": "2",
"parentid": "102",
"level": "2",
"name": "testSkin",
"description": "",
"allowed": [],
"defaultfor": [],
"use_css": "1",
"css_xml": "",
"skin_css_palette_id": "1",
"nice_name": "testSkin"
}
]
}
},
"skin_list": [
{
"skinid": "0",
"name": "Standard Skin",
"use_css": "0",
"name_indent": "Standard Skin"
},
{
"skinid": "102",
"name": "Default Affiliate",
"use_css": "1",
"name_indent": "Default Affiliate"
},
{
"skinid": "1000",
"name": "testSkin",
"use_css": "1",
"name_indent": "- testSkin"
}
]
}
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();
$request = Array(
'method' => 'GET',
'path' => 'v1/skin/skins',
'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);
?>
