NATS5 REST API Site GET option

NATS 5 About NATS 5 NATS Requirements NATS5 Changelog NATS5 Cookie Settings Admin Overview Admin Overview Reporting Section NATS5 Reports Getting Started with Reporting Report Types Sites Section Site Management Adding a Site Site Overview Site Partners Site Templates Site Groups Site Coupons Site Coupon Overview Join Option Overview Tour Overview Adding a Tour Site Redirect Overview Programs Section Program Management Program Overview Program Payout Changes Billers Section Biller Management Biller Overview Cascades Cascade Overview Cascade Weight Taxes     Biller Instructions NATS Biller List 2000Charge 2000Charge Gateway 2KCHARGE A1Payments Aebill Aconti Allopass AltoBilling Argus Authorize.net Bill1st Gateway BillAPay Gateway Billing Revolution Billing United Bit-Pay BoaCompra Braintree Payments C2Bill CardFlex CCBill CCBill Flexform CCBill Web900 CashSend CashtoCode Centili Centrobill Clearcard Clearcard IDV Click and Buy CoinGate CoinPayments CommerceGate CurePay DHD DHDGateway DIMOCO EGatePay ElectraCash eMerchantPay Gateway eMPPay.com Epoch Escalion EuroBill EPGBill.com Ezic, Inc. Focal Payments FXBilling FXBilling Native Gateway tokens Gigadat Global Access GlobalCharge Global DPS GoCoin Greta 11 (G11Bill) GTBill GTBill GATEWAY GXBill ICN Ltd. Itelebill Jettis International Jettis International Gateway LocalBilling MobiusPay MerlinBill NETbilling NETbilling Native NetCash NetMobile Netpay International NoCreditCard OrbitalPay Password By Phone Pay4 Pay900 Payment Network Paygarden Paygea PayPal Paysite Cash Payspace Payspace Gateway Plug'n Pay Prime Orange Probiller PumaPay Rocketfuel RocketGate RocketGate Native RSBilling RSBilling Native SafeCharge SafeCharge Native Secure Billing Worldwide Secure Billing Worldwide Gateway Secure Trading SecurionPay SegPay SegPay Gateway SOFORTdauerauftrag Sonic Bill StandardBill TrustCharge Telecom UKash Vendo Services Vendo Verotel Pro Voxtel VXSBill WebBilling Wispay WTS WTSeu Zombaio Shopping Cart Sales Switching From Epoch to Epoch EU Payments Section Pay Via Methods Payments Search Pay Via Overview Payout Periods Payout Period Overview Dump Formats Payments Due/Stored Bulk Payments Affiliates Section Affiliate Management Affiliate Overview Affiliate Override Affiliate Groups Affiliate Account Types Affiliate Account Changes Adding a Manual Sale Members Section Members Management Adding a Member View Member Details Restricted Values OpenID Connect Mod Auth OpenIDC Ad Tools Section Ad Tool Management Manage Categories Ad Tool Groups Ad Tool Types Ad Tool Assets Adding an Ad Tool Cross/Up Sales Section Cross Sales Up Sales Cross/Up Sale Overview Adding a Cross/Up Sale Third Party Section Third Party Partner Management Adding a Third Party Third Party Partner Overview Rewards Section Rewards Management Points Communications Section News Items Mass Mailing Section Mailing Management Mailer Overview Remove Lists NATS Extras CAPTCHA Overview Join Page CAPTCHA Google reCAPTCHA REST API API Overview API Best Practices REST API PATH UPDATES     Adtool GET /adtool/admin GET /adtool/adtools GET /adtool/adtool GET /adtool/adtool-rules GET /adtool/adtool-rule GET /adtool/categories GET /adtool/field-options GET /adtool/field-types GET /adtool/groups GET /adtool/search GET /adtool/templates GET /adtool/types GET /adtool/type POST /adtool/adtool POST /adtool/adtool-rule POST /adtool/category POST /adtool/field POST /adtool/field-option POST /adtool/group POST /adtool/import POST /adtool/type PATCH /adtool/adtool PATCH /adtool/adtool-group PATCH /adtool/adtool-rule PATCH /adtool/category PATCH /adtool/field PATCH /adtool/field-option PATCH /adtool/group PATCH /adtool/move PATCH /adtool/restore-adtool PATCH /adtool/restore-category PATCH /adtool/restore-field PATCH /adtool/restore-field-option PATCH /adtool/restore-type PATCH /adtool/type DELETE /adtool/adtool DELETE /adtool/adtool-rule DELETE /adtool/category DELETE /adtool/field DELETE /adtool/field-option DELETE /adtool/group DELETE /adtool/type     Affiliate DELETE /affiliate/account-rep DELETE /affiliate/account-type DELETE /affiliate/affiliate DELETE /affiliate/doc DELETE /affiliate/group DELETE /affiliate/permissions GET /affiliate/account-changes GET /affiliate/account-types GET /affiliate/admin-settings GET /affiliate/campaigns GET /affiliate/current GET /affiliate/current-permissions GET /affiliate/docs GET /affiliate/doc GET /affiliate/groups GET /affiliate/group GET /affiliate/hits GET /affiliate/link-styles GET /affiliate/loginids GET /affiliate/loginlog GET /affiliate/manual-payout GET /affiliate/news-sections GET /affiliate/notes GET /affiliate/notices GET /affiliate/override GET /affiliate/payout GET /affiliate/payment-periods GET /affiliate/payvia-types GET /affiliate/payvia-type GET /affiliate/permissions GET /affiliate/programcampaigns GET /affiliate/referrer GET /affiliate/referring-urls GET /affiliate/reps GET /affiliate/rest-methods GET /affiliate/search GET /affiliate/search-limited GET /affiliate/settings GET /affiliate/skins GET /affiliate/soap-functions GET /affiliate/status PATCH /affiliate/adminsettings PATCH /affiliate/account-change PATCH /affiliate/account-type PATCH /affiliate/account-type-permissions PATCH /affiliate/admin-setting PATCH /affiliate/affiliate-account-type PATCH /affiliate/affiliate-group PATCH /affiliate/allsettings PATCH /affiliate/account-rep PATCH /affiliate/avatar PATCH /affiliate/customs PATCH /affiliate/defaults PATCH /affiliate/details PATCH /affiliate/override PATCH /affiliate/password PATCH /affiliate/payment-period PATCH /affiliate/payvia PATCH /affiliate/payvia-info PATCH /affiliate/permissions PATCH /affiliate/referrer PATCH /affiliate/reset-api PATCH /affiliate/reset-rss PATCH /affiliate/reset-tos PATCH /affiliate/rest-permissions PATCH /affiliate/restore PATCH /affiliate/restore-account-type PATCH /affiliate/settings PATCH /affiliate/soap-permissions PATCH /affiliate/status POST /affiliate/account-type POST /affiliate/add POST /affiliate/doc POST /affiliate/group POST /affiliate/invoice POST /affiliate/manual-sale POST /affiliate/note     Biller GET /biller/available GET /biller/partner-available GET /biller/billerdata GET /biller/cascades GET /biller/cascades-available GET /biller/cascade-count GET /biller/cascade-history GET /biller/cascade-rules GET /biller/cascade-rule GET /biller/cascade-step-count GET /biller/cascade-steps GET /biller/cascade-detail GET /biller/cascade-list GET /biller/count GET /biller/detail GET /biller/fees GET /biller/partner-fees GET /biller/last_poll GET /biller/partner-last-poll GET /biller/list GET /biller/partner-detail GET /biller/partner-list GET /biller/partner-shortnames GET /biller/process_types GET /biller/partner-process-types GET /biller/shortnames GET /biller/transaction_types GET /biller/partner-transaction-types GET /biller/taxes POST /biller/add POST /biller/cascade POST /biller/cascade-rule POST /biller/cascade-step POST /biller/partner PATCH /biller/cascade PATCH /biller/cascade-rule PATCH /biller/cascade-step PATCH /biller/cascade-steps-reorder PATCH /biller/fee PATCH /biller/partner-fee PATCH /biller/restore PATCH /biller/restore-cascade PATCH /biller/restore-partner PATCH /biller/setting PATCH /biller/partner-setting PATCH /biller/tax DELETE /biller/biller DELETE /biller/cascade DELETE /biller/cascade-rule DELETE /biller/cascade-step DELETE /biller/fee DELETE /biller/partner-fee DELETE /biller/partner DELETE /biller/tax     Codes GET /codes/affiliate-codes GET /codes/decode GET /codes/linkcodes GET /codes/strack     Config DELETE /config/setting GET /config/section GET /config/sections PATCH /config/affiliate_default PATCH /config/section     Include DELETE /include/include DELETE /include/step GET /include/include GET /include/includes GET /include/templates PATCH /include/include PATCH /include/restore PATCH /include/step POST /include/include POST /include/step     Mailing DELETE /mailing/mailing DELETE /mailing/mailing-rule DELETE /mailing/queue GET /mailing/mailing GET /mailing/mailings GET /mailing/mailing-rules GET /mailing/mailing-rule GET /mailing/queue GET /mailing/removelist PATCH /mailing/mailing PATCH /mailing/mailing-rule PATCH /mailing/removelist PATCH /mailing/removelist-queue PATCH /mailing/resend-queue PATCH /mailing/restore-queue PATCH /mailing/send-mailing PATCH /mailing/send-test-mailing POST /mailing/mailing POST /mailing/mailing-rule POST /mailing/removelist     Maintenance DELETE /maintenance/log DELETE /maintenance/cache GET /maintenance/admin-actions GET /maintenance/log GET /maintenance/logs GET /maintenance/nats GET /maintenance/report GET /maintenance/report-progress GET /maintenance/reports GET /maintenance/server GET /maintenance/table GET /maintenance/tables GET /maintenance/table-clean-count GET /maintenance/table-clean-progress PATCH /maintenance/log PATCH /maintenance/report PATCH /maintenance/table     Member GET /member/available_flags GET /member/encryptusername GET /member/authstring GET /member/details GET /member/flags GET /member/loginlog GET /member/matching GET /member/notes GET /member/notices GET /member/restricted-values GET /member/search GET /member/suggestedcanceloffers GET /member/surfer-actions PATCH /member/details PATCH /member/expiration PATCH /member/expiremanual PATCH /member/resend-transaction-email PATCH /member/resend-transaction-postback PATCH /member/restricted-value PATCH /member/forget PATCH /member/lock PATCH /member/unlock POST /member/flag POST /member/login POST /member/note POST /member/restricted-value DELETE /member/flag DELETE /member/restricted-value     Message DELETE /message/message DELETE /message/permanent GET /message/count GET /message/messages GET /message/view PATCH /message/read PATCH /message/unread PATCH /message/undelete POST /message/message     News DELETE /news/entry DELETE /news/section GET /news/entry GET /news/news GET /news/sections PATCH /news/entry POST /news/entry POST /news/section     Notification DELETE /notification/notification DELETE /notification/permanent GET /notification/count GET /notification/notifications GET /notification/view PATCH /notification/read PATCH /notification/unread PATCH /notification/undelete     Option GET /option/options GET /option/rule PATCH /option/rule PATCH /option/text POST /option/rule     Payment DELETE /payment/invoice DELETE /payment/payout-period DELETE /payment/payvia-field DELETE /payment/payvia-field-mc DELETE /payment/payvia-rule GET /payment/dump-format GET /payment/dump-formats GET /payment/invoices GET /payment/payments GET /payment/payment-dumps GET /payment/payment-dump GET /payment/payment-search GET /payment/payvia GET /payment/payvias GET /payment/payvia-fields GET /payment/payvia-field-mcs GET /payment/payout-period GET /payment/payout-periods GET /payment/payvia-rules GET /payment/payvia-rule GET /payment/payviarule PATCH /payment/copy-dump-format PATCH /payment/default-payout-period PATCH /payment/dump-format PATCH /payment/duplicate-payvia PATCH /payment/invoice PATCH /payment/payment PATCH /payment/payment-paid PATCH /payment/payment-store PATCH /payment/payment-unstore PATCH /payment/payments PATCH /payment/payments-unstore PATCH /payment/payout-period PATCH /payment/payout-period-affiliates PATCH /payment/payvia PATCH /payment/payvia-field PATCH /payment/payvia-fields-reorder PATCH /payment/payvia-field-mc PATCH /payment/payvia-field-mcs-reorder PATCH /payment/payvia-rule PATCH /payment/payviarule PATCH /payment/restore-payout-period PATCH /payment/restore-payvia-field PATCH /payment/restore-payvia-field-mc POST /payment/check-dump POST /payment/dump-format POST /payment/import-dump POST /payment/invoice POST /payment/payout-period POST /payment/payvia POST /payment/payvia-field POST /payment/payvia-field-mc POST /payment/payvia-rule     Program DELETE /program/program DELETE /program/payout-change DELETE /program/payout-change-tier GET /program/additional-payout-change-targets GET /program/affiliate-available GET /program/detail GET /program/list GET /program/options GET /program/payout-changes GET /program/redirect-available GET /program/sites GET /program/tours GET /program/types PATCH /program/default_payout PATCH /program/details PATCH /program/disable_affiliate PATCH /program/disable_tour PATCH /program/enable_affiliate PATCH /program/enable_site PATCH /program/enable_tour PATCH /program/move-payout-change PATCH /program/payout-change PATCH /program/payout-change-tier POST /program/new POST /program/payout-change POST /program/payout-change-tier     Report GET /report/affiliate-ratios GET /report/hits GET /report/hit-totals GET /report/profitloss GET /report/profit-loss GET /report/fields GET /report/focus GET /report/focuses GET /report/groups GET /report/perspective GET /report/perspectives GET /report/report GET /report/subscription GET /report/surfer GET /report/surferaction GET /report/transactionpayouts GET /report/transactions GET /report/transaction GET /report/report-widget GET /report/widgets GET /report/widget GET /report/widget-info GET /report/views POST /report/focus POST /report/group POST /report/perspective PATCH /report/focus PATCH /report/focus-enabled PATCH /report/focus-default PATCH /report/focuses-reorder PATCH /report/perspective PATCH /report/perspective-group PATCH /report/report-widget PATCH /report/widget DELETE /report/focus     Reward DELETE /reward/category DELETE /reward/purchase DELETE /reward/point DELETE /reward/reward GET /reward/categories GET /reward/points GET /reward/purchases GET /reward/rewards PATCH /reward/move-point PATCH /reward/point PATCH /reward/reward PATCH /reward/ship-purchase PATCH /reward/unship-purchase POST /reward/category POST /reward/point POST /reward/reward     Service GET /service/check-functions GET /service/condition GET /service/countries GET /service/country GET /service/datetime GET /service/languages GET /service/periods GET /service/ping GET /service/project GET /service/rule-condition-data GET /service/rule-info GET /service/stats-breakdowns GET /service/timezone GET /service/timestamp POST /service/sendemail     Site GET /site/base-templates GET /site/billers GET /site/cookies GET /site/coupon GET /site/coupons GET /site/coupon-revisions GET /site/email-settings GET /site/groups GET /site/option GET /site/options GET /site/options-available GET /site/option-fields GET /site/option-rules GET /site/option-rule GET /site/option-type GET /site/option-types GET /site/programs GET /site/redirect GET /site/redirects GET /site/redirect-rules GET /site/redirect-rule GET /site/site-list GET /site/site GET /site/site-notices GET /site/site-partner GET /site/site-partners GET /site/site-type GET /site/sites GET /site/template GET /site/templates GET /site/template-sections GET /site/template-sites GET /site/tour GET /site/tours GET /site/tour-emails GET /site/tour-notices POST /site/coupon POST /site/group POST /site/option POST /site/option-rule POST /site/redirect POST /site/redirect-rule POST /site/site-partner POST /site/site-tour POST /site/copy-template POST /site/tour PATCH /site/cookie PATCH /site/coupon PATCH /site/duplicate-option PATCH /site/email-settings PATCH /site/group PATCH /site/move PATCH /site/option PATCH /site/option-rule PATCH /site/redirect PATCH /site/redirect-rule PATCH /site/reset-coupon PATCH /site/restore-group PATCH /site/restore-option PATCH /site/restore-redirect PATCH /site/restore-site PATCH /site/restore-site-partner PATCH /site/restore-tour PATCH /site/site PATCH /site/site-partner PATCH /site/template PATCH /site/tour DELETE /site/cookie DELETE /site/group DELETE /site/option DELETE /site/option-rule DELETE /site/site DELETE /site/site-partner DELETE /site/redirect DELETE /site/redirect-rule DELETE /site/template DELETE /site/tour DELETE /site/tour-field     Skin DELETE /skin/skin DELETE /skin/template GET /skin/colors GET /skin/export GET /skin/skins GET /skin/sections GET /skin/templates GET /skin/template PATCH /skin/colors PATCH /skin/flush PATCH /skin/skin PATCH /skin/template POST /skin/copy-template POST /skin/import POST /skin/skin POST /skin/template

GET /site/option

Description

• Get option details

Resource URL

• http://domain/api/site/option
• Replace domain with the nats domain

Request Method

• GET

Response Format

• JSON

Authentication

• HTTP headers

Parameters

Parameters can be sent as url encoded params

• optionid
  • type: digit
  • required
• formatted
  • type: boolean_digit (0 or 1)
  • optional
• option_biller
  • type: boolean_digit (0 or 1)
  • optional

Example Request

Method: GET
URL: http://domain/api/site/option
Query String: optionid=2&formatted=1&option_biller=1

Response:

{
    "success": true,
    "option": {
        "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",
        "biller_details": [
            {
                "billerid": "2",
                "biller": "CCBILL",
                "fields": [
                    {
                        "display": "CC Payment ID",
                        "required": "1",
                        "size": "6",
                        "type": "",
                        "name": "biller_optioninfo_subscriptionTypeId_cc",
                        "value": "",
                        "required_type": "cc",
                        "display_value": ""
                    },
                    {
                        "display": "Check Payment ID",
                        "required": "1",
                        "size": "6",
                        "type": "",
                        "name": "biller_optioninfo_subscriptionTypeId_check",
                        "value": "",
                        "required_type": "check",
                        "display_value": ""
                    },
                    {
                        "display": "Web900 Payment ID",
                        "required": "1",
                        "size": "6",
                        "type": "",
                        "name": "biller_optioninfo_subscriptionTypeId_900",
                        "value": "",
                        "required_type": "900",
                        "display_value": ""
                    },
                    {
                        "display": "Debit Payment ID",
                        "required": "1",
                        "size": "6",
                        "type": "",
                        "name": "biller_optioninfo_subscriptionTypeId_elv",
                        "value": "",
                        "required_type": "elv",
                        "display_value": ""
                    },
                    {
                        "display": "Direct Pay Payment ID",
                        "required": "1",
                        "size": "6",
                        "type": "",
                        "name": "biller_optioninfo_subscriptionTypeId_dp",
                        "value": "",
                        "required_type": "dp",
                        "display_value": ""
                    },
                    {
                        "display": "Alter-Sub",
                        "required": "0",
                        "size": "6",
                        "type": "",
                        "name": "biller_optioninfo_clientSubacc",
                        "value": "",
                        "display_value": ""
                    },
                    {
                        "display": "Alter-Upgrade",
                        "required": "0",
                        "size": "6",
                        "type": "",
                        "name": "biller_optioninfo_upgradesub",
                        "value": "",
                        "display_value": ""
                    },
                    {
                        "display": "Alter CC Form",
                        "required": "0",
                        "size": "6",
                        "type": "",
                        "name": "biller_optioninfo_formName_cc",
                        "value": "",
                        "display_value": ""
                    },
                    {
                        "display": "Alter Check Form",
                        "required": "0",
                        "size": "6",
                        "type": "",
                        "name": "biller_optioninfo_formName_check",
                        "value": "",
                        "display_value": ""
                    },
                    {
                        "display": "Alter Web900 Form",
                        "required": "0",
                        "size": "6",
                        "type": "",
                        "name": "biller_optioninfo_formName_900",
                        "value": "",
                        "display_value": ""
                    },
                    {
                        "display": "Alter Debit Form",
                        "required": "0",
                        "size": "6",
                        "type": "",
                        "name": "biller_optioninfo_formName_elv",
                        "value": "",
                        "required_type": "elv",
                        "display_value": ""
                    },
                    {
                        "display": "Alter Direct Pay Form",
                        "required": "0",
                        "size": "6",
                        "type": "",
                        "name": "biller_optioninfo_formName_dp",
                        "value": "",
                        "required_type": "dp",
                        "display_value": ""
                    }
                ]
            },
            {
                "billerid": "1",
                "biller": "NETBILLING",
                "fields": [
                    {
                        "display": "Auth Amount ($0 initial only)",
                        "required": "0",
                        "size": "",
                        "type": "",
                        "name": "biller_optioninfo_auth_amount",
                        "value": "",
                        "display_value": ""
                    },
                    {
                        "display": "Discount Upgrade Price",
                        "required": "0",
                        "size": "",
                        "type": "",
                        "name": "biller_optioninfo_upgradeprice",
                        "value": "",
                        "display_value": ""
                    },
                    {
                        "display": "Disable Initial AVS",
                        "required": "0",
                        "size": "1",
                        "type": "checkbox",
                        "name": "biller_optioninfo_disable_avs",
                        "value": "",
                        "display_value": "No"
                    },
                    {
                        "display": "Disable Initial Fraud Checking",
                        "required": "0",
                        "size": "1",
                        "type": "checkbox",
                        "name": "biller_optioninfo_disable_fraud_checking",
                        "value": "",
                        "display_value": "No"
                    },
                    {
                        "display": "Enable Oneclick AVS",
                        "required": "0",
                        "size": "1",
                        "type": "checkbox",
                        "name": "biller_optioninfo_enable_oneclick_avs",
                        "value": "",
                        "display_value": "No"
                    },
                    {
                        "display": "Enable Oneclick Fraud Checking",
                        "required": "0",
                        "size": "1",
                        "type": "checkbox",
                        "name": "biller_optioninfo_enable_oneclick_fraud_checking",
                        "value": "",
                        "display_value": "No"
                    },
                    {
                        "display": "Packageplus Prorate",
                        "required": "0",
                        "size": "1",
                        "type": "checkbox",
                        "name": "biller_optioninfo_prorate",
                        "value": "",
                        "display_value": "No"
                    },
                    {
                        "display": "Free Trial No Auth",
                        "required": "0",
                        "size": "1",
                        "type": "checkbox",
                        "name": "biller_optioninfo_free_trial_no_auth",
                        "value": "",
                        "display_value": "No"
                    }
                ]
            }
        ],
        "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,
        "details_formatted": [
            {
                "name": "name",
                "display": "Join Form Text",
                "required": true,
                "section": "main",
                "special_design": true,
                "value": "Join Form",
                "display_value": "Join Form"
            },
            {
                "name": "initial",
                "display": "Initial Cost",
                "check": "alnum_number_check",
                "section": "main",
                "special_design": true,
                "value": "1",
                "display_value": "1"
            },
            {
                "name": "initial_days",
                "display": "Initial Days",
                "check": "alnum_number_check",
                "section": "main",
                "special_design": true,
                "value": "1",
                "display_value": "1"
            },
            {
                "name": "rebill",
                "display": "Recurring Cost",
                "check": "alnum_number_check",
                "section": "main",
                "special_design": true,
                "value": "30",
                "display_value": "30"
            },
            {
                "name": "rebill_days",
                "display": "Recurring Days",
                "check": "alnum_number_check",
                "section": "main",
                "special_design": true,
                "value": "30",
                "display_value": "30"
            },
            {
                "name": "package_upgrade_allowed",
                "display": "Package Upgrade Allowed",
                "type": "checkbox",
                "section": "package",
                "special_design": true,
                "value": "",
                "display_value": "No"
            },
            {
                "name": "enable_global_package_upgrade",
                "display": "Package Upgrade Globally",
                "type": "checkbox",
                "section": "package",
                "special_design": true,
                "value": "",
                "display_value": "No"
            },
            {
                "name": "package_use_initial",
                "display": "Package Use Initial",
                "type": "checkbox",
                "section": "package",
                "special_design": true,
                "value": "",
                "display_value": "No"
            },
            {
                "name": "packageid",
                "display": "Package ID",
                "check": "alnum_number_check",
                "section": "package",
                "special_design": true,
                "value": "",
                "display_value": ""
            },
            {
                "name": "no_old_members",
                "display": "Disallow for Old Members",
                "type": "checkbox",
                "section": "misc",
                "special_design": false,
                "value": "0",
                "display_value": "No"
            },
            {
                "name": "hidden",
                "display": "Hide on Join Form",
                "type": "checkbox",
                "section": "misc",
                "special_design": false,
                "value": "",
                "display_value": "No"
            },
            {
                "name": "active_all",
                "display": "Active by Default",
                "type": "checkbox",
                "section": "misc",
                "special_design": false,
                "value": "0",
                "display_value": "No"
            }
        ],
        "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",
        "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"
        }
    },
    "option_type": {
        "key": 0,
        "name": "normal",
        "mapping": "optioninfo",
        "special": 0,
        "nosite": 0,
        "extra_offers": 1,
        "incoming_sale": 0,
        "rule_type": "option"
    }
}

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(
	'optionid' => 2,
	'formatted' => 1,
	'option_biller' => 1,
);

$request = Array(
	'method' => 'GET',
	'path' => 'v1/site/option',
	'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);
?>