Difference between revisions of "NATS5 REST API Site PATCH site"
From TMM Wiki
Jump to navigationJump to search| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_site_section = true |
}} | }} | ||
== '''PATCH /site/site''' == | == '''PATCH /site/site''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Update site settings | * Update site settings | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*PATCH | *PATCH | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 40: | Line 41: | ||
** optional | ** optional | ||
* '''hidden''' | * '''hidden''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''featured''' | * '''featured''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''reuse_active''' | * '''reuse_active''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''no_personal_member_info''' | * '''no_personal_member_info''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''relaxed_upsell_dupe_check''' | * '''relaxed_upsell_dupe_check''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''require_atvod_verification''' | * '''require_atvod_verification''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''atvod_client_id''' | * '''atvod_client_id''' | ||
| Line 76: | Line 77: | ||
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''PATCH'''<br/> | ||
| + | URL: <nowiki>http://domain/api/site/site</nowiki><br/> | ||
| + | Form Data:<br/> | ||
| + | * siteid: 2 | ||
| + | * name: updated site name | ||
| + | * site_group_id: 0 | ||
| + | * date_added: Now | ||
| + | * hidden: 0 | ||
| + | * featured: 1 | ||
| + | * reuse_active: 1 | ||
| + | * no_personal_member_info: 0 | ||
| + | * relaxed_upsell_dupe_check: 0 | ||
| + | * require_atvod_verification: 0 | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "result": "site updated" | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 89: | Line 115: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'siteid' => '2', | |
| + | 'name' => 'updated site name', | ||
| + | 'site_group_id' => 0, | ||
| + | 'date_added' => 'Now', | ||
| + | 'hidden' => 0, | ||
| + | 'featured' => 1, | ||
| + | 'reuse_active' => 1, | ||
| + | 'no_personal_member_info' => 0, | ||
| + | 'relaxed_upsell_dupe_check' => 0, | ||
| + | 'require_atvod_verification' => 0, | ||
); | ); | ||
| Line 132: | Line 167: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_site_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 --> | ||
Latest revision as of 16:02, 9 August 2019
PATCH /site/site
Description
- Update site settings
Resource URL
- http://domain/api/site/site
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- siteid
- type: digit
- required
- name
- type: string
- optional
- site_group_id
- type: digit
- optional
- brand_id
- type: digit
- optional
- mobile_tour
- type: digit
- optional
- date_added
- type: datetime (A date string to be parsed by php strtotime, or a unix timestamp integer)
- optional
- hidden
- type: boolean_digit (0 or 1)
- optional
- featured
- type: boolean_digit (0 or 1)
- optional
- reuse_active
- type: boolean_digit (0 or 1)
- optional
- no_personal_member_info
- type: boolean_digit (0 or 1)
- optional
- relaxed_upsell_dupe_check
- type: boolean_digit (0 or 1)
- optional
- require_atvod_verification
- type: boolean_digit (0 or 1)
- optional
- atvod_client_id
- type: string
- optional
- atvod_operator_id
- type: string
- optional
- atvod_password
- type: string
- optional
- atvod_authenticate_profile_id
- type: string
- optional
- atvod_passport_profile_id
- type: string
- optional
- atvod_driving_licence_profile_id
- type: string
- optional
Example Request
Method: PATCH
URL: http://domain/api/site/site
Form Data:
- siteid: 2
- name: updated site name
- site_group_id: 0
- date_added: Now
- hidden: 0
- featured: 1
- reuse_active: 1
- no_personal_member_info: 0
- relaxed_upsell_dupe_check: 0
- require_atvod_verification: 0
Response:
{
"success": true,
"result": "site 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(
'siteid' => '2',
'name' => 'updated site name',
'site_group_id' => 0,
'date_added' => 'Now',
'hidden' => 0,
'featured' => 1,
'reuse_active' => 1,
'no_personal_member_info' => 0,
'relaxed_upsell_dupe_check' => 0,
'require_atvod_verification' => 0,
);
$request = Array(
'method' => 'PATCH',
'path' => 'v1/site/site',
'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);
?>
