Difference between revisions of "NATS5 REST API Site POST site-partner"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Site POST site-partner to NATS5 REST API Site POST site-partner: 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 |
}} | }} | ||
== '''POST /site/site-partner''' == | == '''POST /site/site-partner''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Add new site partner | * Add new site partner | ||
| 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''']] |
*POST | *POST | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 34: | Line 35: | ||
** optional | ** optional | ||
* '''sp_on_income''' | * '''sp_on_income''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''sp_flat_adjustment''' | * '''sp_flat_adjustment''' | ||
| Line 137: | Line 138: | ||
</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 --> | [[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:01, 9 August 2019
POST /site/site-partner
Description
- Add new site partner
Resource URL
- http://domain/api/site/site-partner
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- siteid
- type: digit
- required
- loginid
- type: digit
- required
- sp_misc_expenses
- type: digit
- optional
- sp_percentage
- type: digit
- optional
- sp_on_income
- type: boolean_digit (0 or 1)
- optional
- sp_flat_adjustment
- type: numeric
- optional
- sp_flat_percentage
- type: digit
- optional
- start_time
- type: datetime (A date string to be parsed by php strtotime, or a unix timestamp integer)
- optional
- end_time
- type: datetime (A date string to be parsed by php strtotime, or a unix timestamp integer)
- optional
Example Request
Method: POST
URL: http://domain/api/site/site-partner
Form Data:
- siteid: 2
- loginid: 1
- sp_misc_expenses: 5
- sp_percentage: 3
- sp_on_income: 0
- sp_flat_adjustment: 20
- sp_flat_percentage: 15
- start_time: NOW
- end_time: 13 June 2030
Response:
{
"success": true,
"result": "Site partner added"
}
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',
'loginid' => 1,
'sp_misc_expenses' => 5,
'sp_percentage' => 3,
'sp_on_income' => 0,
'sp_flat_adjustment' => 20,
'sp_flat_percentage' => 15,
'start_time' => 'NOW',
'end_time' => '13 June 2030',
);
$request = Array(
'method' => 'POST',
'path' => 'v1/site/site-partner',
'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);
?>
