Difference between revisions of "NATS5 REST API Site GET tour-emails"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Site GET tour-emails to NATS5 REST API Site GET tour-emails: 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 |
}} | }} | ||
== '''GET /site/tour-emails''' == | == '''GET /site/tour-emails''' == | ||
+ | |||
'''Description''' | '''Description''' | ||
* Get emails for a tour | * Get emails for a tour | ||
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 1,136: | Line 1,137: | ||
</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
GET /site/tour-emails
Description
- Get emails for a tour
Resource URL
- http://domain/api/site/tour-emails
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- tourid
- type: digit
- required
Example Request
Method: GET
URL: http://domain/api/site/tour-emails
Query String: tourid=2
Response:
{ "success": true, "emails": { "member": [ { "name": "mail_member_joined", "display": "Member Join", "subject_field": { "name": "mail_member_joined", "display": "Member Join Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "enabled_field": { "name": "mail_member_joined_enabled", "display": "Enable Member Join", "page": "emails", "section": "member_emails", "type": "checkbox", "readonly": 0, "can_inherit": 1, "value": "0", "display_value": "No" }, "templates": [] }, { "name": "mail_member_nocostjoined", "display": "Member No Cost Join", "subject_field": { "name": "mail_member_nocostjoined", "display": "Member No Cost Join Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_cancelled", "display": "Member Cancel", "subject_field": { "name": "mail_member_cancelled", "display": "Member Cancel Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_rebilled", "display": "Member Rebill", "subject_field": { "name": "mail_member_rebilled", "display": "Member Rebill Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_credited", "display": "Member Credit", "subject_field": { "name": "mail_member_credited", "display": "Member Credit Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_chargedback", "display": "Member Chargeback", "subject_field": { "name": "mail_member_chargedback", "display": "Member Chargeback Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_insufficient", "display": "Member Insufficient Funds", "subject_field": { "name": "mail_member_insufficient", "display": "Member Insufficient Funds Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_voided", "display": "Member Void", "subject_field": { "name": "mail_member_voided", "display": "Member Void Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_change", "display": "Member Details Change", "subject_field": { "name": "mail_member_change", "display": "Member Details Change Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_password", "display": "Member Password Retrieval", "subject_field": { "name": "mail_member_password", "display": "Member Password Retrieval Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "Password Retrieval", "display_value": "Password Retrieval" }, "templates": [] }, { "name": "mail_member_insufficient_reversal", "display": "Member Insufficient Funds Reversal", "subject_field": { "name": "mail_member_insufficient_reversal", "display": "Member Insufficient Funds Reversal Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_void_reversal", "display": "Member Void Reversal", "subject_field": { "name": "mail_member_void_reversal", "display": "Member Void Reversal Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_credit_reversal", "display": "Member Credit Reversal", "subject_field": { "name": "mail_member_credit_reversal", "display": "Member Credit Reversal Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_chargeback_reversal", "display": "Member Chargeback Reversal", "subject_field": { "name": "mail_member_chargeback_reversal", "display": "Member Chargeback Reversal Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_pre_joined", "display": "Member Pre Join", "subject_field": { "name": "mail_member_pre_joined", "display": "Member Pre Join Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_pre_rebilled", "display": "Member Pre Rebill", "subject_field": { "name": "mail_member_pre_rebilled", "display": "Member Pre Rebill Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_pending_joined", "display": "Member Pending Join", "subject_field": { "name": "mail_member_pending_joined", "display": "Member Pending Join Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_pending_rebilled", "display": "Member Pending Rebill", "subject_field": { "name": "mail_member_pending_rebilled", "display": "Member Pending Rebill Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "templates": [] }, { "name": "mail_member_pending_ncr", "display": "Member Pending No Cost Registration", "subject_field": { "name": "mail_member_pending_ncr", "display": "Member Pending No Cost Registration Subject", "page": "emails", "section": "member_emails", "type": "string", "readonly": 0, "can_inherit": 1, "value": "Verify Your Free Registration", "display_value": "Verify Your Free Registration" }, "templates": [] } ], "admin": [ { "name": "admin_signup_email", "display": "Signup E-Mail", "email_field": { "name": "admin_signup_email", "display": "Signup E-Mail", "page": "emails", "section": "admin_emails", "type": "string", "check": "verify_email_list", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "events": [ { "event": "joined", "subject": "", "templates": [ { "name": "mail_owner_joined", "description": "Email - Owner - Member joins", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_joined_html", "description": "Email - Owner - Member joins (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] }, { "event": "nocostjoined", "subject": "", "templates": [ { "name": "mail_owner_nocostjoined", "description": "", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_nocostjoined_html", "description": "", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] }, { "event": "pre_joined", "subject": "", "templates": [ { "name": "mail_owner_pre_joined", "description": "Email - Owner - Member pre (note) joins", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_pre_joined_html", "description": "Email - Owner - Member pre (note) joins (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] }, { "event": "pending_joined", "subject": "", "templates": [ { "name": "mail_owner_pending_joined", "description": "Email - Owner - Member pending joins", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_pending_joined_html", "description": "Email - Owner - Member pending joins (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] }, { "event": "manualadd", "subject": "", "templates": [ { "name": "mail_owner_manualadd", "description": "Email - Owner - Manually added member", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_manualadd_html", "description": "Email - Owner - Manually added member (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] } ] }, { "name": "admin_rebill_email", "display": "Rebill E-Mail", "email_field": { "name": "admin_rebill_email", "display": "Rebill E-Mail", "page": "emails", "section": "admin_emails", "type": "string", "check": "verify_email_list", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "events": [ { "event": "rebilled", "subject": "", "templates": [ { "name": "mail_owner_rebilled", "description": "Email - Owner - Member rebills", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_rebilled_html", "description": "Email - Owner - Member rebills (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] }, { "event": "pre_rebilled", "subject": "", "templates": [ { "name": "mail_owner_pre_rebilled", "description": "Email - Owner - Member pre (note) rebills", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_pre_rebilled_html", "description": "Email - Owner - Member pre (note) rebills (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] }, { "event": "pending_rebilled", "subject": "", "templates": [ { "name": "mail_owner_pending_rebilled", "description": "Email - Owner - Member pending rebills", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_pending_rebilled_html", "description": "Email - Owner - Member pending rebills (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] } ] }, { "name": "admin_cancelled_email", "display": "Cancelled E-Mail", "email_field": { "name": "admin_cancelled_email", "display": "Cancelled E-Mail", "page": "emails", "section": "admin_emails", "type": "string", "check": "verify_email_list", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "events": [ { "event": "cancelled", "subject": "", "templates": [ { "name": "mail_owner_cancelled", "description": "Email - Owner - Member cancels", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_cancelled_html", "description": "Email - Owner - Member cancels (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] } ] }, { "name": "admin_credited_email", "display": "Credited E-Mail", "email_field": { "name": "admin_credited_email", "display": "Credited E-Mail", "page": "emails", "section": "admin_emails", "type": "string", "check": "verify_email_list", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "events": [ { "event": "credited", "subject": "", "templates": [ { "name": "mail_owner_credited", "description": "Email - Owner - Members transaction is credited", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_credited_html", "description": "Email - Owner - Members transaction is credited (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] } ] }, { "name": "admin_chargeback_email", "display": "Chargeback E-Mail", "email_field": { "name": "admin_chargeback_email", "display": "Chargeback E-Mail", "page": "emails", "section": "admin_emails", "type": "string", "check": "verify_email_list", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "events": [ { "event": "chargedback", "subject": "", "templates": [ { "name": "mail_owner_chargedback", "description": "Email - Owner - Members transaction is chargeback", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_chargedback_html", "description": "Email - Owner - Members transaction is chargeback (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] } ] }, { "name": "admin_voided_email", "display": "Voided E-Mail", "email_field": { "name": "admin_voided_email", "display": "Voided E-Mail", "page": "emails", "section": "admin_emails", "type": "string", "check": "verify_email_list", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "events": [ { "event": "voided", "subject": "", "templates": [ { "name": "mail_owner_voided", "description": "Email - Owner - Members transaction is voided", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_voided_html", "description": "Email - Owner - Members transaction is voided (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] } ] }, { "name": "admin_insufficient_email", "display": "Insufficient E-Mail", "email_field": { "name": "admin_insufficient_email", "display": "Insufficient E-Mail", "page": "emails", "section": "admin_emails", "type": "string", "check": "verify_email_list", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "events": [ { "event": "insufficient", "subject": "", "templates": [ { "name": "mail_owner_insufficient", "description": "Email - Owner - Member Insufficient Funds", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_insufficient_html", "description": "Email - Owner - Member Insufficient Funds (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] } ] }, { "name": "admin_void_reversal_email", "display": "Void Reversal E-Mail", "email_field": { "name": "admin_void_reversal_email", "display": "Void Reversal E-Mail", "page": "emails", "section": "admin_emails", "type": "string", "check": "verify_email_list", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "events": [ { "event": "void_reversal", "subject": "", "templates": [ { "name": "mail_owner_void_reversal", "description": "Email - Owner - Member void reversal", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_void_reversal_html", "description": "Email - Owner - Member void reversal (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] } ] }, { "name": "admin_credit_reversal_email", "display": "Credit Reversal E-Mail", "email_field": { "name": "admin_credit_reversal_email", "display": "Credit Reversal E-Mail", "page": "emails", "section": "admin_emails", "type": "string", "check": "verify_email_list", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "events": [ { "event": "credit_reversal", "subject": "", "templates": [ { "name": "mail_owner_credit_reversal", "description": "Email - Owner - Member credit reversal", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_credit_reversal_html", "description": "Email - Owner - Member credit reversal (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] } ] }, { "name": "admin_chargeback_reversal_email", "display": "Chargeback Reversal E-Mail", "email_field": { "name": "admin_chargeback_reversal_email", "display": "Chargeback Reversal E-Mail", "page": "emails", "section": "admin_emails", "type": "string", "check": "verify_email_list", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "events": [ { "event": "chargeback_reversal", "subject": "", "templates": [ { "name": "mail_owner_chargeback_reversal", "description": "Email - Owner - Member chargeback reversal", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_chargeback_reversal_html", "description": "Email - Owner - Member chargeback reversal (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] } ] }, { "name": "admin_insufficient_reversal_email", "display": "Insufficient Reversal E-Mail", "email_field": { "name": "admin_insufficient_reversal_email", "display": "Insufficient Reversal E-Mail", "page": "emails", "section": "admin_emails", "type": "string", "check": "verify_email_list", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "events": [ { "event": "insufficient_reversal", "subject": "", "templates": [ { "name": "mail_owner_insufficient_reversal", "description": "Email - Owner - Member insufficent funds reversal", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_insufficient_reversal_html", "description": "Email - Owner - Member insufficent funds reversal (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true } ] } ] }, { "name": "admin_change_email", "display": "Change E-Mail", "email_field": { "name": "admin_change_email", "display": "Change E-Mail", "page": "emails", "section": "admin_emails", "type": "string", "check": "verify_email_list", "readonly": 0, "can_inherit": 1, "value": "", "display_value": "" }, "events": [ { "event": "change", "subject": "", "templates": [ { "name": "mail_owner_change", "description": "Email - Owner - Member Info Changed", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": true }, { "name": "mail_owner_change_html", "description": "Email - Owner - Member Info Changed (HTML)", "header": "", "footer": "", "readonly": 0, "skinid": "0", "origin": "Standard NATS", "customized": 0, "nats_base": 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( 'tourid' => 2, ); $request = Array( 'method' => 'GET', 'path' => 'v1/site/tour-emails', '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); ?>