Difference between revisions of "NATS5 REST API Site PATCH redirect"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Site PATCH redirect to NATS5 REST API Site PATCH redirect: Renaming NATS5 API pages) |
|||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{NATS5 Manual |
− | | | + | | show_api_admin_site_section = true |
}} | }} | ||
== '''PATCH /site/redirect''' == | == '''PATCH /site/redirect''' == | ||
+ | |||
'''Description''' | '''Description''' | ||
* Edit site redirect | * Edit site redirect | ||
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 | ||
* '''no_url''' | * '''no_url''' | ||
− | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''track''' | * '''track''' | ||
− | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''disable_original_hit''' | * '''disable_original_hit''' | ||
− | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''maintain_query_string''' | * '''maintain_query_string''' | ||
− | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''enabled''' | * '''enabled''' | ||
− | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
Line 111: | Line 112: | ||
</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:Missing_Autogenerated_Rest_Sample]]<!-- This article is missing a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Missing_Autogenerated_Rest_Sample]]<!-- This article is missing a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> |
Latest revision as of 17:01, 9 August 2019
PATCH /site/redirect
Description
- Edit site redirect
Resource URL
- http://domain/api/site/redirect
- 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
- site_redirect_id
- type: digit
- required
- new_programid
- type: digit
- optional
- new_tourid
- type: digit
- optional
- new_url
- type: string
- optional
- percent
- type: digit
- optional
- no_url
- type: boolean_digit (0 or 1)
- optional
- track
- type: boolean_digit (0 or 1)
- optional
- disable_original_hit
- type: boolean_digit (0 or 1)
- optional
- maintain_query_string
- type: boolean_digit (0 or 1)
- optional
- enabled
- type: boolean_digit (0 or 1)
- optional
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( // Add API parameters here ); $request = Array( 'method' => 'PATCH', 'path' => 'v1/site/redirect', '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); ?>