Difference between revisions of "NATS5 REST API Site GET options"
From TMM Wiki
Jump to navigationJump to search| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_site_section = true |
}} | }} | ||
== '''GET /site/options''' == | == '''GET /site/options''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get join options | * Get join options | ||
| 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''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 25: | Line 26: | ||
** optional | ** optional | ||
* '''deleted''' | * '''deleted''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''special''' | * '''special''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''option_biller''' | * '''option_biller''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''option_biller_limited''' | * '''option_biller_limited''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''formatted''' | * '''formatted''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''show_tour_customized''' | * '''show_tour_customized''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''option_type_id''' | * '''option_type_id''' | ||
| Line 55: | Line 56: | ||
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/site/options</nowiki><br/> | ||
| + | Query String: <nowiki>siteid=2&deleted=1&special=0&formatted=0&show_tour_customized=1&option_type_id=0&start=0&count=100</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "options": [ | ||
| + | { | ||
| + | "optionid": "2", | ||
| + | "siteid": "2", | ||
| + | "networkid": "0", | ||
| + | "deleted": "0", | ||
| + | "enabled": "0", | ||
| + | "orderid": "1", | ||
| + | "option_type_id": "0", | ||
| + | "billerid": "0", | ||
| + | "programid": "0", | ||
| + | "legacy": "0", | ||
| + | "siteid_nice": "test site name", | ||
| + | "tour_customized": 0, | ||
| + | "details": { | ||
| + | "name": "Join Form", | ||
| + | "initial": "1", | ||
| + | "initial_days": "1", | ||
| + | "rebill": "30", | ||
| + | "rebill_days": "30", | ||
| + | "no_old_members": "0", | ||
| + | "initial_dec": "$1.00", | ||
| + | "rebill_dec": "$30.00", | ||
| + | "trial": 1, | ||
| + | "active_all": "0" | ||
| + | }, | ||
| + | "is_gateway": 0 | ||
| + | } | ||
| + | ], | ||
| + | "site": { | ||
| + | "siteid": "2", | ||
| + | "networkid": "0", | ||
| + | "site": "testSite", | ||
| + | "deleted": "0", | ||
| + | "name": "test site name", | ||
| + | "type": "0", | ||
| + | "hidden": "0", | ||
| + | "date_added": "1559932173", | ||
| + | "date_live": "0", | ||
| + | "network": "0", | ||
| + | "reuse_active": "0", | ||
| + | "no_personal_member_info": "0", | ||
| + | "mobile_tour": "0", | ||
| + | "site_group_id": "0", | ||
| + | "featured": "0", | ||
| + | "brand_id": "0", | ||
| + | "require_atvod_verification": "0", | ||
| + | "atvod_client_id": "", | ||
| + | "atvod_operator_id": "", | ||
| + | "atvod_password": "", | ||
| + | "atvod_authenticate_profile_id": "", | ||
| + | "atvod_passport_profile_id": "", | ||
| + | "atvod_driving_licence_profile_id": "", | ||
| + | "type_nice": "Membership", | ||
| + | "site_group_nice": "None" | ||
| + | }, | ||
| + | "order": "orderid", | ||
| + | "count": 100, | ||
| + | "total_count": "1", | ||
| + | "success": true | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 68: | Line 142: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'siteid' => '2', | |
| + | 'deleted' => 1, | ||
| + | 'special' => 0, | ||
| + | 'formatted' => 0, | ||
| + | 'show_tour_customized' => 1, | ||
| + | 'option_type_id' => 0, | ||
| + | 'start' => 0, | ||
| + | 'count' => 100, | ||
); | ); | ||
| Line 111: | Line 192: | ||
</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: | + | [[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 11:22, 18 November 2023
GET /site/options
Description
- Get join options
Resource URL
- http://domain/api/site/options
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- siteid
- type: digit
- optional
- deleted
- type: boolean_digit (0 or 1)
- optional
- special
- type: boolean_digit (0 or 1)
- optional
- option_biller
- type: boolean_digit (0 or 1)
- optional
- option_biller_limited
- type: boolean_digit (0 or 1)
- optional
- formatted
- type: boolean_digit (0 or 1)
- optional
- show_tour_customized
- type: boolean_digit (0 or 1)
- optional
- option_type_id
- type: digit
- optional
- order
- type: string
- optional
- start
- type: digit
- optional
- count
- type: digit
- optional
Example Request
Method: GET
URL: http://domain/api/site/options
Query String: siteid=2&deleted=1&special=0&formatted=0&show_tour_customized=1&option_type_id=0&start=0&count=100
Response:
{
"options": [
{
"optionid": "2",
"siteid": "2",
"networkid": "0",
"deleted": "0",
"enabled": "0",
"orderid": "1",
"option_type_id": "0",
"billerid": "0",
"programid": "0",
"legacy": "0",
"siteid_nice": "test site name",
"tour_customized": 0,
"details": {
"name": "Join Form",
"initial": "1",
"initial_days": "1",
"rebill": "30",
"rebill_days": "30",
"no_old_members": "0",
"initial_dec": "$1.00",
"rebill_dec": "$30.00",
"trial": 1,
"active_all": "0"
},
"is_gateway": 0
}
],
"site": {
"siteid": "2",
"networkid": "0",
"site": "testSite",
"deleted": "0",
"name": "test site name",
"type": "0",
"hidden": "0",
"date_added": "1559932173",
"date_live": "0",
"network": "0",
"reuse_active": "0",
"no_personal_member_info": "0",
"mobile_tour": "0",
"site_group_id": "0",
"featured": "0",
"brand_id": "0",
"require_atvod_verification": "0",
"atvod_client_id": "",
"atvod_operator_id": "",
"atvod_password": "",
"atvod_authenticate_profile_id": "",
"atvod_passport_profile_id": "",
"atvod_driving_licence_profile_id": "",
"type_nice": "Membership",
"site_group_nice": "None"
},
"order": "orderid",
"count": 100,
"total_count": "1",
"success": true
}
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',
'deleted' => 1,
'special' => 0,
'formatted' => 0,
'show_tour_customized' => 1,
'option_type_id' => 0,
'start' => 0,
'count' => 100,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/site/options',
'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);
?>
