Directory Maximizer
Click here for Live Help

API Document

All API calls are to be made at http://www.directorymaximizer.com/api/api.php

You can choose from 3 output formats: XML, JSON and PHP [set “outputformat” to either “xml”, “json” or “php”]

Every function you call, needs to have the following 3 parameters passed compulsorily apart from the function variables:
uname  - Define the username of the account you want to access
upass – Provide the password for the account
apikey – Provide your API key [your API key can be found under the 'Edit User Details' link in the 'My Account' page]

You would call a function by running http://www.directorymaximizer.com/api.php?do={function name}&uname={username of the account to be accessed}&upass={password}&apikey={your api key}&{mention all other parameters of the function with their respective values}

The list of functions is given below. Click on the "details" link to get information on how to use the function.

All input parameters highlighted in grey are optional fields. If there is any error in the input parameters passed, then the API shows an "inputerror" and under this will be displayed the field name for which there is an error and the value entered along with the error message, separated by a ":|:", e.g. <inputerror><contact_email>as@a:|:Invalid e-mail address</contact_email></inputerror> - this output will be shown if "as@a" is sent as an emal address parameter, which is invalid.

Click here to view a sample PHP class which can be used to connect to the API.

List of all API Functions

Function Name Function DescriptionDetails
1.1 create_userCreate a new user account.Details
1.2 add_siteAdd a new site to the account.Details
1.3 edit_siteEdit the site details.Details
1.4 submit_sitesFirst step of placing an order for a site, where you select the number of directories to be submitted to and choose any other ordering options.Details
1.5 order_siteFinal step of placing an order, where you mention the transactionid of the order to be completed.Details
1.6 get_directories_infoGet information on the number of directories on our list and the PR distribution.Details
1.7 get_site_listA summary of all the sites in the account with their siteid and status (Active/Inactive).Details
1.8 add_title_descriptionAdd titles and descriptions to a site.Details
1.9 get_site_infoGet all entered details for a site.Details
1.10 create_custom_listThis is the function where you create and add a custom list of directories / urls that you would like us to submit to or perform certain actions using our custom submission service. Important: This function will only fully work when, after looping through this function to compile all the urls in the list, the process_custom_list api function is called finally to generate the list in the account.Details
1.11 submit_custom_sitesFirst step of placing a custom order for a site, where you select the site and the list to which it needs to be submitted.Details
1.12 submission_summaryShows a summary of the number of submissions made, pending submissions and directories left for submission for a particular site.Details
1.13 submission_reportGet report of submissions done for a site.Details
1.14 email_reportGet the email handling report for a particular site.Details
1.15 custom_submission_reportGet the custom submission report for a particular site.Details
1.16 get_group_listGets the list of profiles/groups available in the account.Details
1.17 edit_site_groupEdit the group for a particular siteDetails
1.18 invoice_detailsGet a list of all the invoices for the account.Details
1.19 create_groupCreate a new group/profile under which you can categorize your sites.Details
1.20 invoice_specificGet complete invoice details of a particular transaction.Details
1.21 delete_title_descriptionDelete a particular title and description for a site.Details
1.22 custom_submission_summaryGet a summary of the number of custom submissions made for a site and how many are pending on outstanding orders.Details
1.23 get_subscription_listGets details of all the subscriptions that exist and have existed previously in the account.Details
1.24 get_custom_listsGet details of all the custom lists in the account.Details
1.25 upload_submissionsIf there are any submissions that have been previously made for this site, then the details can be uploaded to the account so as to prevent duplicate submissions.Details
1.26 edit_group_nameEdit the name of a group/profile.Details
1.27 edit_site_for_customDetails
1.28 order_site_for_customFinal step of placing a custom order, where you mention the transactionid of the order to be completed.Details
1.29 add_site_for_customIf you want to submit a site to a custom list, you must first enter additional details for the site, which can be done by calling this function and passing the extra information needed.Details
1.30 get_custom_site_infoGets details of all information stored for a site where custom details have been added.Details
1.31 transaction_statusReturns the completion status of an order, returning hte $MX credited, submissions ordered and submissions complete for each site in the transaction.Details
1.32 cancel_orderTo delete an entire order, if the submissions have not started as yet. An $MX credit, equivalent of the amount paid for the order, will be given on the successful call of this function.Details
1.33 cancel_remaining_submissionsCancel the remaining submissions of an order, will result in the account being credited with $MX for the submissions that are cancelled.Details
1.34 reset_title_descriptionTo apply changes made to titles/descriptions to all current orders pending. By default, any changes made to titles/descriptions will take effect only on subsequent orders. Calling this function will ensure the changes take immediate effect on all remaining submissions.Details
1.35 get_mx_balanceRetrieve the current $MX balance in the account.Details
1.36 get_current_pricingWill return current pricing data for Directory Maximizer's submission service.Details
1.37 process_custom_listThis function is to be executed after all the urls in the list are compiled using the create_custom_list api function.Details
1.38 custom_paid_submission_reportGet the report details of custom paid submissions made.Details
1.39 view_inner_linksFor custom paid submissions: to view the inner links for a site.Details
1.40 delete_inner_linkFor custom paid submissions: to delete a particular inner link.Details
1.41 add_inner_linkFor custom paid submissions: to add an inner link for a particular site.Details
1.42 delay_submissionsThis will delay the submissions of an order by the number of minutes you specify. Only use if necessary, else it can cause a problem with the starting of orders.Details
1.43 sm_add_siteSocial Maximizer: Add a new site to the account.Details
1.44 sm_edit_siteSocial Maximizer: Edit the site details.Details
1.45 sm_submit_sitesSocial Maximizer: First step of placing an order for a site, where you select the number of directories to be submitted to.Details
1.46 sm_order_siteSocial Maximizer: Final step of placing an order, where you mention the transactionid of the order to be completed.Details
1.47 sm_get_directories_infoSocial Maximizer: Get information on the number of directories on our list and the PR distribution.Details
1.48 sm_get_site_listSocial Maximizer: A summary of all the sites in the account with their siteid and status (Active/Inactive).Details
1.49 sm_add_title_descriptionSocial Maximizer: Add titles and descriptions to a site.Details
1.50 sm_get_site_infoSocial Maximizer: Get all entered details for a site.Details
1.51 sm_submission_summarySocial Maximizer: Shows a summary of the number of submissions made, pending submissions and directories left for submission for a particular site.Details
1.52 sm_submission_reportSocial Maximizer: Get report of submissions done for a site.Details
1.53 sm_invoice_detailsSocial Maximizer: Get a list of all the invoices for the account.Details
1.54 sm_invoice_specificSocial Maximizer: Get complete invoice details of a particular transaction.Details
1.55 sm_delete_title_descriptionSocial Maximizer: Delete a particular title and description for a site.Details
1.56 sm_transaction_statusSocial Maximizer: Returns the completion status of an order, returning hte $MX credited, submissions ordered and submissions complete for each site in the transaction.Details
1.57 sm_cancel_orderSocial Maximizer: To delete an entire order, if the submissions have not started as yet. An $MX credit, equivalent of the amount paid for the order, will be given on the successful call of this function.Details
1.58 sm_cancel_remaining_submissionsSocial Maximizer: Cancel the remaining submissions of an order, will result in the account being credited with $MX for the submissions that are cancelled.Details
1.59 sm_reset_title_descriptionSocial Maximizer: To apply changes made to titles/descriptions to all current orders pending. By default, any changes made to titles/descriptions will take effect only on subsequent orders. Calling this function will ensure the changes take immediate effect on all remaining submissions.Details
1.60 sm_delay_submissionsSocial Maximizer: This will delay the submissions of an order by the number of minutes you specify. Only use if necessary, else it can cause a problem with the starting of orders.Details
1.61 sm_get_current_pricingSocial Maximizer: Will return current pricing data for the submission service.Details

1.1 create_user Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
contact_emailThe contact e-mail address for this account.
doEnter the name of the function "create_user" out here
firstnameEnter first name of the client.
lastnameEnter the last name of the client.
outputformatChoose either xml,json or php as the preferred output format
passwordPassword should be between 4 to 16 characters.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.
usernameThe username for this new account, cannot contain any special characters or spaces. Only a combination of letters and numbers.

1.1 create_user Output Variables:
Field Name Field Description
errornoerror no
outputmessageThis field will provide a detailed success/failure message.
statusSuccess/Fail
useridProvides the userid for this newly created user.

1.1 create_user - Possible Error Values:
Error Title Error Description
Invalid Email AddressThe email address selected is already in use, please choose another email address

1.1 create_user Sample Php Code:
function create_user($contact_email, $firstname, $lastname, $password, $username,
$outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=create_user&outputformat=$outputformat&contact_email=$contact_email&firstname=$firstname&lastname=$lastname&password=$password&username=$username";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.1 create_user Sample Url:

1.1 create_user Sample XML Output:
 



api_key_username

api_key_password

re34eerr45dsdsddd677

sample@email.com

password

username

create_user

lastname

paul

xml/json/php



user account was successfully created.

success/fail

error no

{userid}



1.1 create_user Sample Json Output:
{"input":{"uname":"api_key_username","upass":"api_key_password","apikey":"re34ee
rr45dsdsddd677","contact_email":"sample@email.com","password":"password","userna
me":"username","do":"create_user","lastname":"lastname","firstname":"paul","outp
utformat":"xml\/json\/php"},"output":{"outputmessage":"user account was
successfully created.","status":"success\/fail","errorno":"error
no","userid":"{userid}"}}

1.1 create_user Sample Php Output:
a:2:{s:5:"input";a:10:{s:5:"uname";s:16:"api_key_username";s:5:"upass";s:16:"api
_key_password";s:6:"apikey";s:20:"re34eerr45dsdsddd677";s:13:"contact_email";s:1
6:"sample@email.com";s:8:"password";s:8:"password";s:8:"username";s:8:"username"
;s:2:"do";s:11:"create_user";s:8:"lastname";s:8:"lastname";s:9:"firstname";s:4:"
paul";s:12:"outputformat";s:12:"xml/json/php";}s:6:"output";a:4:{s:13:"outputmes
sage";s:38:"user account was successfully
created.";s:6:"status";s:12:"success/fail";s:7:"errorno";s:8:"error
no";s:6:"userid";s:8:"{userid}";}}

1.2 add_site Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
category_preferencesEnter examples of categories that you would like this site listed under.
contact_emailLeave blank if you'd to like to enable the email handling option for this site, where we create a new email account and manage the emails for all the submissions made. Alternatively, enter the e-mail address to which you'd like to receive the directory ac
contact_nameEnter the contact person's name for this site.
countryEnter the name of the Country which this site targets. If left blank or an invalid country name given, United States will be selected by default.
descriptionEnter a description to be used for the submissions. Min. 100 characters, Max. 255 characters.
doEnter the function name "add_site" out here
keywordsEnter a list of keywords/key phrases for the site, separated by commas. Min. 20 characters, Max. 100 characters.
outputformatChoose either xml,json or php as the preferred output format
siteEnter the url for the site.
titleEnter a title to be used for the submissions. Min. 4 characters, Max. 45 characters.
unameEnter the username of the account to which you want to add this site.
upassEnter the password of the account to which you want to add this site.

1.2 add_site Output Variables:
Field Name Field Description
errornoerror no
outputmessageThis field will provide a detailed success/failure message.
siteidProvides the siteid for the newly added site, this siteid variable is needed to be used for the ordering function.
statusSuccess/Fail

1.2 add_site - Possible Error Values:
Error Title Error Description

1.2 add_site Sample Php Code:
function add_site($category_preferences, $contact_email, $contact_name, $country,
$description, $keywords, $site, $title, $outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=add_site&outputformat=$outputformat&category_preferences=$category_preferences&contact_email=$contact_email&contact_name=$contact_name&country=$country&description=$description&keywords=$keywords&site=$site&title=$title";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.2 add_site Sample Url:

1.2 add_site Sample XML Output:
 



add_site

adsfdsfdsfasdfdsafas

api_key_username

api_key_password

http://www.sample-url.com

roger s

united kingdom

sample@email.com

real estate, homes for sale, properties, home rentals

real estate, properties

real estate listings

find listings of houses for sale and rent in the united states from this website. plenty of useful articles and real estate resources also available on the site.

xml/json/php



error no

success/fail

output message

{siteid}



1.2 add_site Sample Json Output:
{"input":{"do":"add_site","apikey":"adsfdsfdsfasdfdsafas","uname":"api_key_usern
ame","upass":"api_key_password","site":"http:\/\/www.sample-url.com","contact_na
me":"roger s","country":"united
kingdom","contact_email":"sample@email.com","keywords":"real estate, homes for
sale, properties, home rentals","category_preferences":"real estate,
properties","title":"real estate listings","description":"find listings of
houses for sale and rent in the united states from this website. plenty of
useful articles and real estate resources also available on the
site.","outputformat":"xml\/json\/php"},"output":{"errorno":"error
no","status":"success\/fail","outputmessage":"output
message","siteid":"{siteid}"}}

1.2 add_site Sample Php Output:
a:2:{s:5:"input";a:13:{s:2:"do";s:8:"add_site";s:6:"apikey";s:20:"adsfdsfdsfasdf
dsafas";s:5:"uname";s:16:"api_key_username";s:5:"upass";s:16:"api_key_password";
s:4:"site";s:25:"http://www.sample-url.com";s:12:"contact_name";s:7:"roger
s";s:7:"country";s:14:"united
kingdom";s:13:"contact_email";s:16:"sample@email.com";s:8:"keywords";s:53:"real
estate, homes for sale, properties, home
rentals";s:20:"category_preferences";s:23:"real estate,
properties";s:5:"title";s:20:"real estate
listings";s:11:"description";s:161:"find listings of houses for sale and rent in
the united states from this website. plenty of useful articles and real estate
resources also available on the
site.";s:12:"outputformat";s:12:"xml/json/php";}s:6:"output";a:4:{s:7:"errorno";
s:8:"error
no";s:6:"status";s:12:"success/fail";s:13:"outputmessage";s:14:"output
message";s:6:"siteid";s:8:"{siteid}";}}

1.3 edit_site Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
category_preferencesEnter the category preferences for the site. Do not pass the parameter if no editing is required for this field.
contact_emailLeave blank to enable email handling for the site, else enter the email address where submission confirmation mails should come. Do not pass the parameter if no editing is required for this field.
contact_nameThe contact name to be used for the submissions of this site. Do not pass the parameter if no editing is required for this field.
countryCountry that the site targets. Do not pass the parameter if no editing is required for this field.
doEnter the function name "edit_site" out here
keywordsList of keywords separated by comma. Min. 20 characters, Max. 100 characters. Do not pass the parameter if no editing is required for this field.
outputformatChoose either xml,json or php as the preferred output format
profile_nameEnter another profile/group name for the site, if you'd like to change it. Leaving it blank, will have it remain in the same group that it was.
siteEnter the siteid or the site url
unameEnter the username of the account which you want to access.
upassEnter the password of the account to be accessed.

1.3 edit_site Output Variables:
Field Name Field Description
errornoError No
outputmessageDetailed success/fail message
siteidA confirmation of the siteid that was edited.
statusSuccess/Fail

1.3 edit_site - Possible Error Values:
Error Title Error Description

1.3 edit_site Sample Php Code:
function edit_site($category_preferences, $contact_email, $contact_name, $country, $keywords,
$profile_name, $site, $outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=edit_site&outputformat=$outputformat&category_preferences=$category_preferences&contact_email=$contact_email&contact_name=$contact_name&country=$country&keywords=$keywords&profile_name=$profile_name&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.3 edit_site Sample Url:

1.3 edit_site Sample XML Output:
 



{site}

paul

united states of america

{contact_email}

xml/json/php

adsfdsfdsfasdfdsafas

username_to_access

password_of_account

{profile_name}

real estate, homes for sale, properties, home rentals

{category_preferences}

edit_site



{siteid}

{errorno}

{outputmessage}

{status}



1.3 edit_site Sample Json Output:
{"input":{"site":"{site}","contact_name":"paul","country":"united states of
america","contact_email":"{contact_email}","outputformat":"xml\/json\/php","apik
ey":"adsfdsfdsfasdfdsafas","uname":"username_to_access","upass":"password_of_acc
ount","profile_name":"{profile_name}","keywords":"real estate, homes for sale,
properties, home
rentals","category_preferences":"{category_preferences}","do":"edit_site"},"outp
ut":{"siteid":"{siteid}","errorno":"{errorno}","outputmessage":"{outputmessage}"
,"status":"{status}"}}

1.3 edit_site Sample Php Output:
a:2:{s:5:"input";a:12:{s:4:"site";s:6:"{site}";s:12:"contact_name";s:4:"paul";s:
7:"country";s:24:"united states of
america";s:13:"contact_email";s:15:"{contact_email}";s:12:"outputformat";s:12:"x
ml/json/php";s:6:"apikey";s:20:"adsfdsfdsfasdfdsafas";s:5:"uname";s:18:"username
_to_access";s:5:"upass";s:19:"password_of_account";s:12:"profile_name";s:14:"{pr
ofile_name}";s:8:"keywords";s:53:"real estate, homes for sale, properties, home
rentals";s:20:"category_preferences";s:22:"{category_preferences}";s:2:"do";s:9:
"edit_site";}s:6:"output";a:4:{s:6:"siteid";s:8:"{siteid}";s:7:"errorno";s:9:"{e
rrorno}";s:13:"outputmessage";s:15:"{outputmessage}";s:6:"status";s:8:"{status}"
;}}

1.4 submit_sites Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "submit_sites" out here
no_of_directoriesEnter the no of directories you want to submit to. Enter "all" to submit to all remaining directories.
outputformatChoose either xml,json or php as the preferred output format
prLeave blank to submit to all directories, sorted by higher PR first. It can be set to a number between 0-3. Example: Setting it to '2' would have the order submitted to all directories of a PR 2 and higher.
siteEnter the siteid or the site url which needs to be submitted.
speedEnter the number of weeks over which you'd like the submissions distributed. Can choose between 2-5. Leaving blank or setting it at 1 will have the submissions complete in the quickest time frame possible.
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.4 submit_sites Output Variables:
Field Name Field Description
availablemxShows the amount of $MX available in the user's account.
email_handlingWill show "Y" if email handling is enabled for this site and this order else will show "N"
errornoError No
no_of_directories_submitted_toDisplays the total number of directories the site will be submitted to.
outputmessageDetailed success/fail message
siteidA confirmation of the siteid for which the order has been placed, this siteid will need to be passed to the next function 'ordersite' to complete the order.
statusSuccess/Fail
total_costThe total price payable on the order.
transactionidThe transactionid generated for this order. You will need to use this transactionid variable in the ordersite function to complete the order.

1.4 submit_sites - Possible Error Values:
Error Title Error Description

1.4 submit_sites Sample Php Code:
function submit_sites($no_of_directories, $pr, $site, $speed, $outputformat='json',
$print_query=false) 
{ 
  $this->query =
"do=submit_sites&outputformat=$outputformat&no_of_directories=$no_of_directories&pr=$pr&site=$site&speed=$speed";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.4 submit_sites Sample Url:

1.4 submit_sites Sample XML Output:
 



{site}

{no_of_directories}

{pr}

{speed}

xml/json/php

{apikey}

{uname}

{upass}

submit_sites



{errorno}

{status}

{outputmessage}

{siteid}

{email_handling}

{transactionid}

{no_of_directories_submitted_to}

{total_cost}

{availablemx}



1.4 submit_sites Sample Json Output:
{"input":{"site":"{site}","no_of_directories":"{no_of_directories}","pr":"{pr}",
"speed":"{speed}","outputformat":"xml\/json\/php","apikey":"{apikey}","uname":"{
uname}","upass":"{upass}","do":"submit_sites"},"output":{"errorno":"{errorno}","
status":"{status}","outputmessage":"{outputmessage}","siteid":"{siteid}","email_
handling":"{email_handling}","transactionid":"{transactionid}","no_of_directorie
s_submitted_to":"{no_of_directories_submitted_to}","total_cost":"{total_cost}","
availablemx":"{availablemx}"}}

1.4 submit_sites Sample Php Output:
a:2:{s:5:"input";a:9:{s:4:"site";s:6:"{site}";s:17:"no_of_directories";s:19:"{no
_of_directories}";s:2:"pr";s:4:"{pr}";s:5:"speed";s:7:"{speed}";s:12:"outputform
at";s:12:"xml/json/php";s:6:"apikey";s:8:"{apikey}";s:5:"uname";s:7:"{uname}";s:
5:"upass";s:7:"{upass}";s:2:"do";s:12:"submit_sites";}s:6:"output";a:9:{s:7:"err
orno";s:9:"{errorno}";s:6:"status";s:8:"{status}";s:13:"outputmessage";s:15:"{ou
tputmessage}";s:6:"siteid";s:8:"{siteid}";s:14:"email_handling";s:16:"{email_han
dling}";s:13:"transactionid";s:15:"{transactionid}";s:30:"no_of_directories_subm
itted_to";s:32:"{no_of_directories_submitted_to}";s:10:"total_cost";s:12:"{total
_cost}";s:11:"availablemx";s:13:"{availablemx}";}}

1.5 order_site Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "order_site" out here
outputformatChoose either xml,json or php as the preferred output format
transactionidPass the transactionid for which the order is being completed.
unameEnter the username of the account for which this order will be placed.
upassEnter the password

1.5 order_site Output Variables:
Field Name Field Description
availablemxShow $MX balance after the order.
errornoError No
mxusedA confirmation of the $MX credits used for this order.
outputmessageDetailed success/fail message
statusSuccess/Fail
transactionidA confirmation of the transactionid for this order.

1.5 order_site - Possible Error Values:
Error Title Error Description

1.5 order_site Sample Php Code:
function order_site($transactionid, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=order_site&outputformat=$outputformat&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.5 order_site Sample Url:

1.5 order_site Sample XML Output:
 



{uname}

{transactionid}

xml/json/php

{apikey}

{upass}

order_site



{transactionid}

{mxused}

{availablemx}

{errorno}

{status}

{outputmessage}



1.5 order_site Sample Json Output:
{"input":{"uname":"{uname}","transactionid":"{transactionid}","outputformat":"xm
l\/json\/php","apikey":"{apikey}","upass":"{upass}","do":"order_site"},"output":
{"transactionid":"{transactionid}","mxused":"{mxused}","availablemx":"{available
mx}","errorno":"{errorno}","status":"{status}","outputmessage":"{outputmessage}"
}}

1.5 order_site Sample Php Output:
a:2:{s:5:"input";a:6:{s:5:"uname";s:7:"{uname}";s:13:"transactionid";s:15:"{tran
sactionid}";s:12:"outputformat";s:12:"xml/json/php";s:6:"apikey";s:8:"{apikey}";
s:5:"upass";s:7:"{upass}";s:2:"do";s:10:"order_site";}s:6:"output";a:6:{s:13:"tr
ansactionid";s:15:"{transactionid}";s:6:"mxused";s:8:"{mxused}";s:11:"availablem
x";s:13:"{availablemx}";s:7:"errorno";s:9:"{errorno}";s:6:"status";s:8:"{status}
";s:13:"outputmessage";s:15:"{outputmessage}";}}

1.6 get_directories_info Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "get_directories_info" out here
outputformatChoose either xml,json or php as the preferred output format
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.6 get_directories_info Output Variables:
Field Name Field Description
directoryinfoA break-up of the number of directories in the format given in the example.
errornoError No
outputmessageDetailed success/fail message
pr0Shows the number of PR0 directories. Similarly the fields pr1 to pr10 show the number of directories under the respective PR. If there are 0 directories under a particular PR, then the field will not be displayed.
statusSuccess/Fail
totalShows the total number of directories in our list.

1.6 get_directories_info - Possible Error Values:
Error Title Error Description

1.6 get_directories_info Sample Php Code:
function get_directories_info( $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=get_directories_info&outputformat=$outputformat";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.6 get_directories_info Sample Url:

1.6 get_directories_info Sample XML Output:
 



{apikey}

{uname}

{upass}

xml/json/php

get_directories_info



{pr0}

{total}

total|1216|pr0|911|pr1|85|pr2|86|pr3|83|pr4|26|pr5|20|pr6|5|pr7|0|pr8|0|pr9|0|pr10|0

{errorno}

{status}

{outputmessage}



1.6 get_directories_info Sample Json Output:
{"input":{"apikey":"{apikey}","uname":"{uname}","upass":"{upass}","outputformat"
:"xml\/json\/php","do":"get_directories_info"},"output":{"pr0":"{pr0}","total":"
{total}","directoryinfo":"total|1216|pr0|911|pr1|85|pr2|86|pr3|83|pr4|26|pr5|20|
pr6|5|pr7|0|pr8|0|pr9|0|pr10|0","errorno":"{errorno}","status":"{status}","outpu
tmessage":"{outputmessage}"}}

1.6 get_directories_info Sample Php Output:
a:2:{s:5:"input";a:5:{s:6:"apikey";s:8:"{apikey}";s:5:"uname";s:7:"{uname}";s:5:
"upass";s:7:"{upass}";s:12:"outputformat";s:12:"xml/json/php";s:2:"do";s:20:"get
_directories_info";}s:6:"output";a:6:{s:3:"pr0";s:5:"{pr0}";s:5:"total";s:7:"{to
tal}";s:13:"directoryinfo";s:84:"total|1216|pr0|911|pr1|85|pr2|86|pr3|83|pr4|26|
pr5|20|pr6|5|pr7|0|pr8|0|pr9|0|pr10|0";s:7:"errorno";s:9:"{errorno}";s:6:"status
";s:8:"{status}";s:13:"outputmessage";s:15:"{outputmessage}";}}

1.7 get_site_list Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "get_site_list" out here
get_site_listget_site_list
outputformatChoose either xml,json or php as the preferred output format
upassEnter the password of the account you want to access.

1.7 get_site_list Output Variables:
Field Name Field Description
detailsA list of all the sites in the account in the following format: siteid,site url,site status(active/inactive); The 3 values for each site are separated by commas and each site is separated from the other with a semi-colon.
errornoError No
no_of_sites_availableShows the number of active/inactive sites in the account.
outputmessageDetailed success/fail message
statusSuccess/Fail
useridA confirmation of the userid for which the output is being shown.

1.7 get_site_list - Possible Error Values:
Error Title Error Description

1.7 get_site_list Sample Php Code:
function get_site_list($get_site_list, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=get_site_list&outputformat=$outputformat&get_site_list=$get_site_list";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.7 get_site_list Sample Url:

1.7 get_site_list Sample XML Output:
 



{apikey}

{upass}

get_site_list

xml/json/php

get_site_list



{userid}

{no_of_sites_available}
24,site-1.com,active;98,site-2.com,inactive;
{errorno} {status} {outputmessage}

1.7 get_site_list Sample Json Output:
{"input":{"apikey":"{apikey}","upass":"{upass}","do":"get_site_list","outputform
at":"xml\/json\/php","get_site_list":"get_site_list"},"output":{"userid":"{useri
d}","no_of_sites_available":"{no_of_sites_available}","details":"24,site-1.com,a
ctive;98,site-2.com,inactive;","errorno":"{errorno}","status":"{status}","output
message":"{outputmessage}"}}

1.7 get_site_list Sample Php Output:
a:2:{s:5:"input";a:5:{s:6:"apikey";s:8:"{apikey}";s:5:"upass";s:7:"{upass}";s:2:
"do";s:13:"get_site_list";s:12:"outputformat";s:12:"xml/json/php";s:13:"get_site
_list";s:13:"get_site_list";}s:6:"output";a:6:{s:6:"userid";s:8:"{userid}";s:21:
"no_of_sites_available";s:23:"{no_of_sites_available}";s:7:"details";s:44:"24,si
te-1.com,active;98,site-2.com,inactive;";s:7:"errorno";s:9:"{errorno}";s:6:"stat
us";s:8:"{status}";s:13:"outputmessage";s:15:"{outputmessage}";}}

1.8 add_title_description Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
descriptionEnter a description for the site. Min. 100 characters, Max. 255 characters.
distribution_ratioIf you would like this title used more or less often than the other titles, then use this figure. By default, it remains at 10. If there's another title set to 5, this title will then be submitted twice as many times as the other title.
doEnter the function name "add_title_description" out here
outputformatChoose either xml,json or php as the preferred output format
siteEnter the siteid or the site url
titleEnter the title for the site. Min. 4 characters, Max.45 characters.
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.8 add_title_description Output Variables:
Field Name Field Description
errornoError No
outputmessageDetailed success/fail message
statusSuccess/Fail
tdidProvides the unique id associated with this title and description.
title_description_countShows number of titles and descriptions available in the site.

1.8 add_title_description - Possible Error Values:
Error Title Error Description

1.8 add_title_description Sample Php Code:
function add_title_description($description, $distribution_ratio, $site, $title,
$outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=add_title_description&outputformat=$outputformat&description=$description&distribution_ratio=$distribution_ratio&site=$site&title=$title";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.8 add_title_description Sample Url:

1.8 add_title_description Sample XML Output:
 



add_title_description

{apikey}

{uname}

{upass}

{site}

{title}

{description}

xml/json/php

10



{tdid}

{title_description_count}

{errorno}

{outputmessage}

{status}



1.8 add_title_description Sample Json Output:
{"input":{"do":"add_title_description","apikey":"{apikey}","uname":"{uname}","up
ass":"{upass}","site":"{site}","title":"{title}","description":"{description}","
outputformat":"xml\/json\/php","distribution_ratio":"10"},"output":{"tdid":"{tdi
d}","title_description_count":"{title_description_count}","errorno":"{errorno}",
"outputmessage":"{outputmessage}","status":"{status}"}}

1.8 add_title_description Sample Php Output:
a:2:{s:5:"input";a:9:{s:2:"do";s:21:"add_title_description";s:6:"apikey";s:8:"{a
pikey}";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:4:"site";s:6:"{sit
e}";s:5:"title";s:7:"{title}";s:11:"description";s:13:"{description}";s:12:"outp
utformat";s:12:"xml/json/php";s:18:"distribution_ratio";s:2:"10";}s:6:"output";a
:5:{s:4:"tdid";s:6:"{tdid}";s:23:"title_description_count";s:25:"{title_descript
ion_count}";s:7:"errorno";s:9:"{errorno}";s:13:"outputmessage";s:15:"{outputmess
age}";s:6:"status";s:8:"{status}";}}

1.9 get_site_info Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "get_site_info" out here
outputformatChoose either xml,json or php as the preferred output format
siteEnter the siteid or the site url for which you want to get the information
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.9 get_site_info Output Variables:
Field Name Field Description
category_preferencesShows the category preferences mentioned for this site.
contact_emailDisplays the email used for submissions. If the field doesn't exist or is blank, it is likely that the e-mail handling service has been enabled. That can be confirmed by checking the "email_handling_service_enabled" field.
contact_nameDisplays the name used for submissions being made for the site.
countryName of the primary country which this site targets.
description_$cntdescription_1, description_2 ... the count goes up to the number of descriptions available for the site and each field displays the respective description.
distribution_ratio_$cntdistribution_ratio_1, distribution_ratio_2 ... the count goes up to the number of titles available for the site and each field displays the respective distribution ratio for each title/description combination.
email_handling_service_enabledShows "Yes" or "No" depending on whether or not the email handling service has been enabled or not.
errornoError No
group_nameProvides the name of the group under which site this site has been classified.
inactive_reasonIf a site is inactive, it will show the reason for it being inactive.
keywordsShows the keywords mentioned for this site.
outputmessageDetailed success/fail message
pr1plus_directories_leftShows the total number of PR1+ directories left for this site to be submitted to.
pr2plus_directories_leftShows the total number of PR2+ directories left for this site to be submitted to.
pr3plus_directories_leftShows the total number of PR3+ directories left for this site to be submitted to.
siteidThe unique id "siteid" associated with this site.
site_added_dateThe date on which the site was added.
site_urlDisplays the website url
statusSuccess/Fail
title_$cnttitle_1, title_2 ... the count goes up to the number of titles available for the site and each field displays the respective title.
title_description_countShows the number of titles and descriptions available for this site.
total_directories_leftShows the total number of directories left for this site to be submitted to.
website_statusShows whether a site is Active or Inactive. Inactive sites cannot be ordered for and if there are submissions pending, they will be on hold till it's active again.

1.9 get_site_info - Possible Error Values:
Error Title Error Description

1.9 get_site_info Sample Php Code:
function get_site_info($site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=get_site_info&outputformat=$outputformat&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.9 get_site_info Sample Url:

1.9 get_site_info Sample XML Output:
 



get_site_info

{apikey}

{uname}

{upass}

{site}

xml/json/php



{group_name}

{contact_name}

{contact_email}

{country}

{siteid}

{site_url}

{category_preferences}

{keywords}

{site_added_date}

{status}

{inactive_reason}

{errorno}

{outputmessage}

{website_status}

{total_directories_left}

{pr1plus_directories_left}

{pr2plus_directories_left}

{pr3plus_directories_left}

{title_description_count}

{title_$cnt}

{description_$cnt}

{distribution_ratio_$cnt}

{email_handling_service_enabled}



1.9 get_site_info Sample Json Output:
{"input":{"do":"get_site_info","apikey":"{apikey}","uname":"{uname}","upass":"{u
pass}","site":"{site}","outputformat":"xml\/json\/php"},"output":{"group_name":"
{group_name}","contact_name":"{contact_name}","contact_email":"{contact_email}",
"country":"{country}","siteid":"{siteid}","site_url":"{site_url}","category_pref
erences":"{category_preferences}","keywords":"{keywords}","site_added_date":"{si
te_added_date}","status":"{status}","inactive_reason":"{inactive_reason}","error
no":"{errorno}","outputmessage":"{outputmessage}","website_status":"{website_sta
tus}","total_directories_left":"{total_directories_left}","pr1plus_directories_l
eft":"{pr1plus_directories_left}","pr2plus_directories_left":"{pr2plus_directori
es_left}","pr3plus_directories_left":"{pr3plus_directories_left}","title_descrip
tion_count":"{title_description_count}","title_$cnt":"{title_$cnt}","description
_$cnt":"{description_$cnt}","distribution_ratio_$cnt":"{distribution_ratio_$cnt}
","email_handling_service_enabled":"{email_handling_service_enabled}"}}

1.9 get_site_info Sample Php Output:
a:2:{s:5:"input";a:6:{s:2:"do";s:13:"get_site_info";s:6:"apikey";s:8:"{apikey}";
s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:4:"site";s:6:"{site}";s:12
:"outputformat";s:12:"xml/json/php";}s:6:"output";a:23:{s:10:"group_name";s:12:"
{group_name}";s:12:"contact_name";s:14:"{contact_name}";s:13:"contact_email";s:1
5:"{contact_email}";s:7:"country";s:9:"{country}";s:6:"siteid";s:8:"{siteid}";s:
8:"site_url";s:10:"{site_url}";s:20:"category_preferences";s:22:"{category_prefe
rences}";s:8:"keywords";s:10:"{keywords}";s:15:"site_added_date";s:17:"{site_add
ed_date}";s:6:"status";s:8:"{status}";s:15:"inactive_reason";s:17:"{inactive_rea
son}";s:7:"errorno";s:9:"{errorno}";s:13:"outputmessage";s:15:"{outputmessage}";
s:14:"website_status";s:16:"{website_status}";s:22:"total_directories_left";s:24
:"{total_directories_left}";s:24:"pr1plus_directories_left";s:26:"{pr1plus_direc
tories_left}";s:24:"pr2plus_directories_left";s:26:"{pr2plus_directories_left}";
s:24:"pr3plus_directories_left";s:26:"{pr3plus_directories_left}";s:23:"title_de
scription_count";s:25:"{title_description_count}";s:10:"title_$cnt";s:12:"{title
_$cnt}";s:16:"description_$cnt";s:18:"{description_$cnt}";s:23:"distribution_rat
io_$cnt";s:25:"{distribution_ratio_$cnt}";s:30:"email_handling_service_enabled";
s:32:"{email_handling_service_enabled}";}}

1.10 create_custom_list Input Parameters:
Field Name Field Description
A1The name given to the respective alternate url.
A2The name given to the respective alternate url.
A3The name given to the respective alternate url.
A4The name given to the respective alternate url.
apikeyEnter the API key of your Account
CityOptional to enter the city this site targets, in case city specific address information is needed to be used for any form filling.
CountryOptional to enter the country this site targets, in case country specific address information is needed to be used for any form filling.
doEnter the function name "create_custom_list" out here
instructionAny instructions you'd like to mention for the url.
list_descriptionOptionally mention a description for the list.
list_nameMention an existing list name/id OR a new list name for this set of urls.
outputformatChoose either xml,json or php as the preferred output format
paid_listState wheter this is a paid list of directories or not. State "Yes" if a paid list, else state "No", which is the default
replacelistIf you would like to replace an existing list with a new set of urls, mention "Y" for the first call that you make with this new list. On mentioning "Y", all previous urls in the list are deleted. By default, it is set to "N" and nothing needs to be menti
StateOptional to enter the State this site targets, in case state specific address information is needed to be used for any form filling.
submiturlEnter the url of the page which should be opened directly for attempting a submission or taking desired action.
titleEnter a title or short description for this page
U1An alernate url from the same site where a submission can be made.
U2An alernate url from the same site where a submission can be made.
U3An alernate url from the same site where a submission can be made.
U4An alernate url from the same site where a submission can be made.
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.
urlEnter the homepage url of the site that is going to be added to this list.

1.10 create_custom_list Output Variables:
Field Name Field Description
errornoError No
listidReturns the list id for the list.
listnameReconfirms the list name
outputmessageDetailed success/fail message
replacedlistWill show if list was replaced or not. Will show "Y" if replaced.
statusSuccess/Fail
useridReturns userid for the account to which this list has been added.

1.10 create_custom_list - Possible Error Values:
Error Title Error Description

1.10 create_custom_list Sample Php Code:
function create_custom_list($A1, $A2, $A3, $A4, $City, $Country, $instruction, $list_description,
$list_name, $paid_list, $replacelist, $State, $submiturl, $title, $U1, $U2,
$U3, $U4, $url, $outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=create_custom_list&outputformat=$outputformat&A1=$A1&A2=$A2&A3=$A3&A4=$A4&City=$City&Country=$Country&instruction=$instruction&list_description=$list_description&list_name=$list_name&paid_list=$paid_list&replacelist=$replacelist&State=$State&submiturl=$submiturl&title=$title&U1=$U1&U2=$U2&U3=$U3&U4=$U4&url=$url";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.10 create_custom_list Sample Url:

1.10 create_custom_list Sample XML Output:
 



create_custom_list

{apikey}

{uname}

{upass}

http://www.url.com

{title}

{submiturl}

{country}

{state}

{city}

{u1}

{a1}

{u2}

{a2}

{u3}

{a3}

{a4}

{u4}

{instruction}

{list_name}

{list_description}

n

xml/json/php

no/yes



{listid}

{userid}

{listname}

{replacedlist}

{status}

{errorno}

{outputmessage}



1.10 create_custom_list Sample Json Output:
{"input":{"do":"create_custom_list","apikey":"{apikey}","uname":"{uname}","upass
":"{upass}","url":"http:\/\/www.url.com","title":"{title}","submiturl":"{submitu
rl}","country":"{country}","state":"{state}","city":"{city}","u1":"{u1}","a1":"{
a1}","u2":"{u2}","a2":"{a2}","u3":"{u3}","a3":"{a3}","a4":"{a4}","u4":"{u4}","in
struction":"{instruction}","list_name":"{list_name}","list_description":"{list_d
escription}","replacelist":"n","outputformat":"xml\/json\/php","paid_list":"no\/
yes"},"output":{"listid":"{listid}","userid":"{userid}","listname":"{listname}",
"replacedlist":"{replacedlist}","status":"{status}","errorno":"{errorno}","outpu
tmessage":"{outputmessage}"}}

1.10 create_custom_list Sample Php Output:
a:2:{s:5:"input";a:24:{s:2:"do";s:18:"create_custom_list";s:6:"apikey";s:8:"{api
key}";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:3:"url";s:18:"http:/
/www.url.com";s:5:"title";s:7:"{title}";s:9:"submiturl";s:11:"{submiturl}";s:7:"
country";s:9:"{country}";s:5:"state";s:7:"{state}";s:4:"city";s:6:"{city}";s:2:"
u1";s:4:"{u1}";s:2:"a1";s:4:"{a1}";s:2:"u2";s:4:"{u2}";s:2:"a2";s:4:"{a2}";s:2:"
u3";s:4:"{u3}";s:2:"a3";s:4:"{a3}";s:2:"a4";s:4:"{a4}";s:2:"u4";s:4:"{u4}";s:11:
"instruction";s:13:"{instruction}";s:9:"list_name";s:11:"{list_name}";s:16:"list
_description";s:18:"{list_description}";s:11:"replacelist";s:1:"n";s:12:"outputf
ormat";s:12:"xml/json/php";s:9:"paid_list";s:6:"no/yes";}s:6:"output";a:7:{s:6:"
listid";s:8:"{listid}";s:6:"userid";s:8:"{userid}";s:8:"listname";s:10:"{listnam
e}";s:12:"replacedlist";s:14:"{replacedlist}";s:6:"status";s:8:"{status}";s:7:"e
rrorno";s:9:"{errorno}";s:13:"outputmessage";s:15:"{outputmessage}";}}

1.11 submit_custom_sites Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "submit_custom_sites" out here
listEnter the list id or list name to which you want to submit.
outputformatChoose either xml,json or php as the preferred output format
siteEnter either the site url or the site id that needs to be submitted.
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.11 submit_custom_sites Output Variables:
Field Name Field Description
availablemxShows the $MX available in the account.
errornoError No
no_of_directories_submitted_toDisplays the total number of directories the site will be submitted to.
priceShows the amount payable for the transaction. Ensure that there is sufficient $MX balance before proceeding to next step.
transactionidThe transactionid generated for this order. You will need to use this transactionid variable for the order_site_for_custom function to complete the order.

1.11 submit_custom_sites - Possible Error Values:
Error Title Error Description

1.11 submit_custom_sites Sample Php Code:
function submit_custom_sites($list, $site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=submit_custom_sites&outputformat=$outputformat&list=$list&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.11 submit_custom_sites Sample Url:

1.11 submit_custom_sites Sample XML Output:
 



{apikey}

submit_custom_sites

{uname}

{upass}

{list}

{site}

xml/json/php



{transactionid}

{availablemx}

{price}

{errorno}

{no_of_directories_submitted_to}



1.11 submit_custom_sites Sample Json Output:
{"input":{"apikey":"{apikey}","do":"submit_custom_sites","uname":"{uname}","upas
s":"{upass}","list":"{list}","site":"{site}","outputformat":"xml\/json\/php"},"o
utput":{"transactionid":"{transactionid}","availablemx":"{availablemx}","price":
"{price}","errorno":"{errorno}","no_of_directories_submitted_to":"{no_of_directo
ries_submitted_to}"}}

1.11 submit_custom_sites Sample Php Output:
a:2:{s:5:"input";a:7:{s:6:"apikey";s:8:"{apikey}";s:2:"do";s:19:"submit_custom_s
ites";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:4:"list";s:6:"{list}
";s:4:"site";s:6:"{site}";s:12:"outputformat";s:12:"xml/json/php";}s:6:"output";
a:5:{s:13:"transactionid";s:15:"{transactionid}";s:11:"availablemx";s:13:"{avail
ablemx}";s:5:"price";s:7:"{price}";s:7:"errorno";s:9:"{errorno}";s:30:"no_of_dir
ectories_submitted_to";s:32:"{no_of_directories_submitted_to}";}}

1.12 submission_summary Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "submission_summary" out here
outputformatChoose either xml,json or php as the preferred output format
pending_transaction_detailsOptional field to display the pending number of submissions for the site by transactionid.
siteEnter the siteid or site url for which you want a submission summary report.
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.12 submission_summary Output Variables:
Field Name Field Description
errornoError No
outputmessageDetailed success/fail message
pending_directoriesShows the number of directories that this site can still be submitted to.
pending_submissions_by_transactionIf the pending_transaction_details parameter was passed, this will return the transaction id along with the number of pending and completed submissions in the following format: "103422|200|21;103423|150|0;" (the first value denotes the transactionid, the second the number of pending submissions and the third the number of submissions completed)
siteidA confirmation of the siteid for which the report has been generated.
statusSuccess/Fail
submissions_madeShows the number of submissions that have been made till date for this site.
submissions_pendingShows the number of submissions pending on outstanding orders for this site.
urlA confirmation of the url for which the report is being shown.

1.12 submission_summary - Possible Error Values:
Error Title Error Description

1.12 submission_summary Sample Php Code:
function submission_summary($pending_transaction_details, $site, $outputformat='json',
$print_query=false) 
{ 
  $this->query =
"do=submission_summary&outputformat=$outputformat&pending_transaction_details=$pending_transaction_details&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.12 submission_summary Sample Url:

1.12 submission_summary Sample XML Output:
 



{site}

{apikey}

{upass}

{uname}

xml/json/php

submission_summary

no/yes



{submissions_made}

{siteid}

{url}

{errorno}

{status}

{outputmessage}

{submissions_pending}

{pending_directories}

103422|200|21;103423|150|0;



1.12 submission_summary Sample Json Output:
{"input":{"site":"{site}","apikey":"{apikey}","upass":"{upass}","uname":"{uname}
","outputformat":"xml\/json\/php","do":"submission_summary","pending_transaction
_details":"no\/yes"},"output":{"submissions_made":"{submissions_made}","siteid":
"{siteid}","url":"{url}","errorno":"{errorno}","status":"{status}","outputmessag
e":"{outputmessage}","submissions_pending":"{submissions_pending}","pending_dire
ctories":"{pending_directories}","pending_submissions_by_transaction":"103422|20
0|21;103423|150|0;"}}

1.12 submission_summary Sample Php Output:
a:2:{s:5:"input";a:7:{s:4:"site";s:6:"{site}";s:6:"apikey";s:8:"{apikey}";s:5:"u
pass";s:7:"{upass}";s:5:"uname";s:7:"{uname}";s:12:"outputformat";s:12:"xml/json
/php";s:2:"do";s:18:"submission_summary";s:27:"pending_transaction_details";s:6:
"no/yes";}s:6:"output";a:9:{s:16:"submissions_made";s:18:"{submissions_made}";s:
6:"siteid";s:8:"{siteid}";s:3:"url";s:5:"{url}";s:7:"errorno";s:9:"{errorno}";s:
6:"status";s:8:"{status}";s:13:"outputmessage";s:15:"{outputmessage}";s:19:"subm
issions_pending";s:21:"{submissions_pending}";s:19:"pending_directories";s:21:"{
pending_directories}";s:34:"pending_submissions_by_transaction";s:27:"103422|200
|21;103423|150|0;";}}

1.13 submission_report Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "submission_report" out here
from_dateEnter date in "yyyy-mm-dd" format. Passing this parameter will retrieve all records after this date.
outputformatChoose either xml,json or php as the preferred output format
siteEnter the siteid or site url for which you want the report.
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.13 submission_report Output Variables:
Field Name Field Description
description_$cntThe description used for this particular submission. The number at the end will increment by 1 for each record, you will need to loop through the list to get all records.
directory_url_$cntThe url of the directory. The number at the end will increment by 1 for each record, you will need to loop through the list to get all records.
errornoError No
no_of_records_availableShows the number of records available in the report. Provides the number of loops you'll need to go through to retrieve each record of the report.
outputmessageDetailed success/fail message
siteidA confirmation of the siteid for which the report is shown.
statusSuccess/Fail
submission_date_$cntThe date on which the submission was made. The number at the end will increment by 1 for each record, you will need to loop through the list to get all records.
title_$cntThe title used for this particular submission. The number at the end will increment by 1 for each record, you will need to loop through the list to get all records.
urlA confirmation of the url for which the report is generated.

1.13 submission_report - Possible Error Values:
Error Title Error Description

1.13 submission_report Sample Php Code:
function submission_report($from_date, $site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=submission_report&outputformat=$outputformat&from_date=$from_date&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.13 submission_report Sample Url:

1.13 submission_report Sample XML Output:
 



{site}

submission_report

{apikey}

{upass}

{uname}

xml/json/php

2011-04-03



{siteid}

{url}

{no_of_records_available}

{directory_url_$cnt}

{title_$cnt}

{description_$cnt}

{submission_date_$cnt}

{errorno}

{status}

{outputmessage}



1.13 submission_report Sample Json Output:
{"input":{"site":"{site}","do":"submission_report","apikey":"{apikey}","upass":"
{upass}","uname":"{uname}","outputformat":"xml\/json\/php","from_date":"2011-04-
03"},"output":{"siteid":"{siteid}","url":"{url}","no_of_records_available":"{no_
of_records_available}","directory_url_$cnt":"{directory_url_$cnt}","title_$cnt":
"{title_$cnt}","description_$cnt":"{description_$cnt}","submission_date_$cnt":"{
submission_date_$cnt}","errorno":"{errorno}","status":"{status}","outputmessage"
:"{outputmessage}"}}

1.13 submission_report Sample Php Output:
a:2:{s:5:"input";a:7:{s:4:"site";s:6:"{site}";s:2:"do";s:17:"submission_report";
s:6:"apikey";s:8:"{apikey}";s:5:"upass";s:7:"{upass}";s:5:"uname";s:7:"{uname}";
s:12:"outputformat";s:12:"xml/json/php";s:9:"from_date";s:10:"2011-04-03";}s:6:"
output";a:10:{s:6:"siteid";s:8:"{siteid}";s:3:"url";s:5:"{url}";s:23:"no_of_reco
rds_available";s:25:"{no_of_records_available}";s:18:"directory_url_$cnt";s:20:"
{directory_url_$cnt}";s:10:"title_$cnt";s:12:"{title_$cnt}";s:16:"description_$c
nt";s:18:"{description_$cnt}";s:20:"submission_date_$cnt";s:22:"{submission_date
_$cnt}";s:7:"errorno";s:9:"{errorno}";s:6:"status";s:8:"{status}";s:13:"outputme
ssage";s:15:"{outputmessage}";}}

1.14 email_report Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "email_report" out here
from_dateEnter date in "yyyy-mm-dd" format. Passing this parameter will retrieve all records after this date.
outputformatChoose either xml,json or php as the preferred output format
siteEnter the siteid or the site url
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.14 email_report Output Variables:
Field Name Field Description
email_date_$cntThe date we reviewed the e-mail.
errornoError No
from_$cntShows the from email or directory url. The count goes up to the number of records available.
no_of_records_availableShows the number of records present in the email report for this site.
outputmessageDetailed success/fail message
statusSuccess/Fail
subject_$cntThe subject line of the email. The count goes up to the number of records available.
type_of_email_$cntThe type of e-mail received: Acknowledment e-mail, Confirmation e-mail where a link needed to be clicked for verification, Approval e-mail where they confirm that a link was approved.

1.14 email_report - Possible Error Values:
Error Title Error Description

1.14 email_report Sample Php Code:
function email_report($from_date, $site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=email_report&outputformat=$outputformat&from_date=$from_date&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.14 email_report Sample Url:

1.14 email_report Sample XML Output:
 



email_report

{site}

{apikey}

{uname}

{upass}

xml/json/php

2011-04-03



{no_of_records_available}

{from_$cnt}

{subject_$cnt}

{type_of_email_$cnt}

{email_date_$cnt}

{errorno}

{status}

{outputmessage}



1.14 email_report Sample Json Output:
{"input":{"do":"email_report","site":"{site}","apikey":"{apikey}","uname":"{unam
e}","upass":"{upass}","outputformat":"xml\/json\/php","from_date":"2011-04-03"},
"output":{"no_of_records_available":"{no_of_records_available}","from_$cnt":"{fr
om_$cnt}","subject_$cnt":"{subject_$cnt}","type_of_email_$cnt":"{type_of_email_$
cnt}","email_date_$cnt":"{email_date_$cnt}","errorno":"{errorno}","status":"{sta
tus}","outputmessage":"{outputmessage}"}}

1.14 email_report Sample Php Output:
a:2:{s:5:"input";a:7:{s:2:"do";s:12:"email_report";s:4:"site";s:6:"{site}";s:6:"
apikey";s:8:"{apikey}";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:12:
"outputformat";s:12:"xml/json/php";s:9:"from_date";s:10:"2011-04-03";}s:6:"outpu
t";a:8:{s:23:"no_of_records_available";s:25:"{no_of_records_available}";s:9:"fro
m_$cnt";s:11:"{from_$cnt}";s:12:"subject_$cnt";s:14:"{subject_$cnt}";s:18:"type_
of_email_$cnt";s:20:"{type_of_email_$cnt}";s:15:"email_date_$cnt";s:17:"{email_d
ate_$cnt}";s:7:"errorno";s:9:"{errorno}";s:6:"status";s:8:"{status}";s:13:"outpu
tmessage";s:15:"{outputmessage}";}}

1.15 custom_submission_report Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "custom_submission_report" out here
from_dateEnter date in "yyyy-mm-dd" format. Passing this parameter will retrieve all records after this date.
outputformatChoose either xml,json or php as the preferred output format
siteEnter the siteid or the site url
transactionidEnter a transactionid (optional) if you want to view the report only for a particular transactionid.
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.15 custom_submission_report Output Variables:
Field Name Field Description
action_$cntThe action that was taken. The count goes up to the number of records available.
action_date_$cntThe date this action was taken.
advertising_$cntWill show "Yes" if advertising options available on the site, else will show "No".
category_selected_$cntIf information available, it will be shown
cost_$cntThe cost applied for the action taken on this record.
description_$cntThe description used
errornoError No
featured_price_$cntIf the url was a paid directory, then this will display the price of making a featured submission to that directory.
note_$cntA note that was made for the particular record. This may be empty for some records.
no_of_records_availableShows the number of records available in the report.
outputmessageDetailed success/fail message
payment_frequency_$cntIf the url was a paid directory, then this will display the payment frequency of the regular submission option.
regular_price_$cntIf the url was a paid directory, then this will display the price of making a regular submission to that directory.
statusSuccess/Fail
submission_dateThe date of the submission in "yyyy-mm-dd" format
title_$cntThe title used
transactionid_$cntDisplays the transactionid for the particular record.
url_$cntThe url where action was taken. The count goes up to the number of records available, e.g. url_1, url_2, etc.

1.15 custom_submission_report - Possible Error Values:
Error Title Error Description

1.15 custom_submission_report Sample Php Code:
function custom_submission_report($from_date, $site, $transactionid, $outputformat='json',
$print_query=false) 
{ 
  $this->query =
"do=custom_submission_report&outputformat=$outputformat&from_date=$from_date&site=$site&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.15 custom_submission_report Sample Url:

1.15 custom_submission_report Sample XML Output:
 



custom_submission_report

{site}

{apikey}

{uname}

{upass}

xml/json/php

{transactionid}

2011-04-03



{no_of_records_available}

{url_$cnt}

{action_$cnt}

{advertising_$cnt}

{cost_$cnt}

{action_date_$cnt}

{errorno}

{status}

{outputmessage}

{note_$cnt}

{regular_price_$cnt}

{featured_price_$cnt}

{payment_frequency_$cnt}

{category_selected_$cnt}

{title_$cnt}

{description_$cnt}

{transactionid_$cnt}

2011-04-03



1.15 custom_submission_report Sample Json Output:
{"input":{"do":"custom_submission_report","site":"{site}","apikey":"{apikey}","u
name":"{uname}","upass":"{upass}","outputformat":"xml\/json\/php","transactionid
":"{transactionid}","from_date":"2011-04-03"},"output":{"no_of_records_available
":"{no_of_records_available}","url_$cnt":"{url_$cnt}","action_$cnt":"{action_$cn
t}","advertising_$cnt":"{advertising_$cnt}","cost_$cnt":"{cost_$cnt}","action_da
te_$cnt":"{action_date_$cnt}","errorno":"{errorno}","status":"{status}","outputm
essage":"{outputmessage}","note_$cnt":"{note_$cnt}","regular_price_$cnt":"{regul
ar_price_$cnt}","featured_price_$cnt":"{featured_price_$cnt}","payment_frequency
_$cnt":"{payment_frequency_$cnt}","category_selected_$cnt":"{category_selected_$
cnt}","title_$cnt":"{title_$cnt}","description_$cnt":"{description_$cnt}","trans
actionid_$cnt":"{transactionid_$cnt}","submission_date":"2011-04-03"}}

1.15 custom_submission_report Sample Php Output:
a:2:{s:5:"input";a:8:{s:2:"do";s:24:"custom_submission_report";s:4:"site";s:6:"{
site}";s:6:"apikey";s:8:"{apikey}";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{u
pass}";s:12:"outputformat";s:12:"xml/json/php";s:13:"transactionid";s:15:"{trans
actionid}";s:9:"from_date";s:10:"2011-04-03";}s:6:"output";a:18:{s:23:"no_of_rec
ords_available";s:25:"{no_of_records_available}";s:8:"url_$cnt";s:10:"{url_$cnt}
";s:11:"action_$cnt";s:13:"{action_$cnt}";s:16:"advertising_$cnt";s:18:"{adverti
sing_$cnt}";s:9:"cost_$cnt";s:11:"{cost_$cnt}";s:16:"action_date_$cnt";s:18:"{ac
tion_date_$cnt}";s:7:"errorno";s:9:"{errorno}";s:6:"status";s:8:"{status}";s:13:
"outputmessage";s:15:"{outputmessage}";s:9:"note_$cnt";s:11:"{note_$cnt}";s:18:"
regular_price_$cnt";s:20:"{regular_price_$cnt}";s:19:"featured_price_$cnt";s:21:
"{featured_price_$cnt}";s:22:"payment_frequency_$cnt";s:24:"{payment_frequency_$
cnt}";s:22:"category_selected_$cnt";s:24:"{category_selected_$cnt}";s:10:"title_
$cnt";s:12:"{title_$cnt}";s:16:"description_$cnt";s:18:"{description_$cnt}";s:18
:"transactionid_$cnt";s:20:"{transactionid_$cnt}";s:15:"submission_date";s:10:"2
011-04-03";}}

1.16 get_group_list Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "get_group_list" out here
outputformatChoose either xml,json or php as the preferred output format
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.16 get_group_list Output Variables:
Field Name Field Description
default_profile_idThe id of the default profile. This profile is selected by default and all sites are categorized under this group, unless another profile is specifically chosen.
default_profile_nameThe name of the default profile.
errornoError No
no_of_profilesShow the number of profiles/groups available in the account.
outputmessageDetailed success/fail message
profile_id_1The id of the particular profile. This field will repeat for as many profiles that exist in the account, with the number at the end incrementing by 1 for each profile, e.g. profile_id_5, profile_id_6, etc...
profile_name_1The name of the particular profile/group. This field will repeat for as many profiles that exist in the account, with the number at the end incrementing by 1 for each profile, e.g. profile_name_5, profile_name_6, etc...
statusSuccess/Fail

1.16 get_group_list - Possible Error Values:
Error Title Error Description

1.16 get_group_list Sample Php Code:
function get_group_list( $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=get_group_list&outputformat=$outputformat";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.16 get_group_list Sample Url:

1.16 get_group_list Sample XML Output:
 



get_group_list

{apikey}

{uname}

{upass}

xml/json/php



{no_of_profiles}

{profile_id_1}

{profile_name_1}

{errorno}

{status}

{outputmessage}

{default_profile_id}

{default_profile_name}



1.16 get_group_list Sample Json Output:
{"input":{"do":"get_group_list","apikey":"{apikey}","uname":"{uname}","upass":"{
upass}","outputformat":"xml\/json\/php"},"output":{"no_of_profiles":"{no_of_prof
iles}","profile_id_1":"{profile_id_1}","profile_name_1":"{profile_name_1}","erro
rno":"{errorno}","status":"{status}","outputmessage":"{outputmessage}","default_
profile_id":"{default_profile_id}","default_profile_name":"{default_profile_name
}"}}

1.16 get_group_list Sample Php Output:
a:2:{s:5:"input";a:5:{s:2:"do";s:14:"get_group_list";s:6:"apikey";s:8:"{apikey}"
;s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:12:"outputformat";s:12:"x
ml/json/php";}s:6:"output";a:8:{s:14:"no_of_profiles";s:16:"{no_of_profiles}";s:
12:"profile_id_1";s:14:"{profile_id_1}";s:14:"profile_name_1";s:16:"{profile_nam
e_1}";s:7:"errorno";s:9:"{errorno}";s:6:"status";s:8:"{status}";s:13:"outputmess
age";s:15:"{outputmessage}";s:18:"default_profile_id";s:20:"{default_profile_id}
";s:20:"default_profile_name";s:22:"{default_profile_name}";}}

1.17 edit_site_group Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "edit_site_group" out here
outputformatChoose either xml,json or php as the preferred output format
profileEnter either the profile name or the id under which you want to categorize the site.
siteEnter the siteid or the site url
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.17 edit_site_group Output Variables:
Field Name Field Description
errornoError No
new_profile_idThe new profile id
new_profile_nameThe new profile name.
old_profile_idThe old profile id
old_profile_nameThe old profile name.
outputmessageDetailed success/fail message
siteidA confirmation of the siteid that was edited.
statusSuccess/Fail

1.17 edit_site_group - Possible Error Values:
Error Title Error Description

1.17 edit_site_group Sample Php Code:
function edit_site_group($profile, $site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=edit_site_group&outputformat=$outputformat&profile=$profile&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.17 edit_site_group Sample Url:

1.17 edit_site_group Sample XML Output:
 



{site}

{profile}

edit_site_group

{apikey}

{uname}

{upass}

xml/json/php



{siteid}

{old_profile_id}

{errorno}

{status}

{outputmessage}

{new_profile_id}

{new_profile_name}

{old_profile_name}



1.17 edit_site_group Sample Json Output:
{"input":{"site":"{site}","profile":"{profile}","do":"edit_site_group","apikey":
"{apikey}","uname":"{uname}","upass":"{upass}","outputformat":"xml\/json\/php"},
"output":{"siteid":"{siteid}","old_profile_id":"{old_profile_id}","errorno":"{er
rorno}","status":"{status}","outputmessage":"{outputmessage}","new_profile_id":"
{new_profile_id}","new_profile_name":"{new_profile_name}","old_profile_name":"{o
ld_profile_name}"}}

1.17 edit_site_group Sample Php Output:
a:2:{s:5:"input";a:7:{s:4:"site";s:6:"{site}";s:7:"profile";s:9:"{profile}";s:2:
"do";s:15:"edit_site_group";s:6:"apikey";s:8:"{apikey}";s:5:"uname";s:7:"{uname}
";s:5:"upass";s:7:"{upass}";s:12:"outputformat";s:12:"xml/json/php";}s:6:"output
";a:8:{s:6:"siteid";s:8:"{siteid}";s:14:"old_profile_id";s:16:"{old_profile_id}"
;s:7:"errorno";s:9:"{errorno}";s:6:"status";s:8:"{status}";s:13:"outputmessage";
s:15:"{outputmessage}";s:14:"new_profile_id";s:16:"{new_profile_id}";s:16:"new_p
rofile_name";s:18:"{new_profile_name}";s:16:"old_profile_name";s:18:"{old_profil
e_name}";}}

1.18 invoice_details Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "invoice_details" out here
outputformatChoose either xml,json or php as the preferred output format
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.18 invoice_details Output Variables:
Field Name Field Description
amount_$cntThe total amount paid towards the transaction.
datecreation_$cntThe date the subscription was created.
errornoError No
is_subscription_$cntIf it is a transaction that is part of a recurring subscription, it will show "Yes", else "No"
no_of_subscriptionsShows the number of subscriptions in the account, both active and inactive/completed suscriptions. You will need to use this number to loop through the subscription list.
outputmessageDetailed success/fail message
particular_subscrid_$cntIf an invoice is relating to a particular subscription, it will show the subscription id.
statusSuccess/Fail
subscrid_$cntThe unique subscription id.
total_no_of_transactionsShows the number of invoices available, you will need to use this number to loop through the invoice list.
transactionid_$cntShows the transactionid
transactiontime_$cntShows the transaction date.

1.18 invoice_details - Possible Error Values:
Error Title Error Description

1.18 invoice_details Sample Php Code:
function invoice_details( $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=invoice_details&outputformat=$outputformat";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.18 invoice_details Sample Url:

1.18 invoice_details Sample XML Output:
 



invoice_details

{apikey}

{uname}

{upass}

xml/json/php



{total_no_of_transactions}

{transactionid_$cnt}

{transactiontime_$cnt}

{errorno}

{status}

{outputmessage}

{no_of_subscriptions}

{subscrid_$cnt}

{datecreation_$cnt}

{particular_subscrid_$cnt}

{is_subscription_$cnt}

{amount_$cnt}



1.18 invoice_details Sample Json Output:
{"input":{"do":"invoice_details","apikey":"{apikey}","uname":"{uname}","upass":"
{upass}","outputformat":"xml\/json\/php"},"output":{"total_no_of_transactions":"
{total_no_of_transactions}","transactionid_$cnt":"{transactionid_$cnt}","transac
tiontime_$cnt":"{transactiontime_$cnt}","errorno":"{errorno}","status":"{status}
","outputmessage":"{outputmessage}","no_of_subscriptions":"{no_of_subscriptions}
","subscrid_$cnt":"{subscrid_$cnt}","datecreation_$cnt":"{datecreation_$cnt}","p
articular_subscrid_$cnt":"{particular_subscrid_$cnt}","is_subscription_$cnt":"{i
s_subscription_$cnt}","amount_$cnt":"{amount_$cnt}"}}

1.18 invoice_details Sample Php Output:
a:2:{s:5:"input";a:5:{s:2:"do";s:15:"invoice_details";s:6:"apikey";s:8:"{apikey}
";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:12:"outputformat";s:12:"
xml/json/php";}s:6:"output";a:12:{s:24:"total_no_of_transactions";s:26:"{total_n
o_of_transactions}";s:18:"transactionid_$cnt";s:20:"{transactionid_$cnt}";s:20:"
transactiontime_$cnt";s:22:"{transactiontime_$cnt}";s:7:"errorno";s:9:"{errorno}
";s:6:"status";s:8:"{status}";s:13:"outputmessage";s:15:"{outputmessage}";s:19:"
no_of_subscriptions";s:21:"{no_of_subscriptions}";s:13:"subscrid_$cnt";s:15:"{su
bscrid_$cnt}";s:17:"datecreation_$cnt";s:19:"{datecreation_$cnt}";s:24:"particul
ar_subscrid_$cnt";s:26:"{particular_subscrid_$cnt}";s:20:"is_subscription_$cnt";
s:22:"{is_subscription_$cnt}";s:11:"amount_$cnt";s:13:"{amount_$cnt}";}}

1.19 create_group Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
default_valueIf you would like to set this newly created group to be your default group for all sites added in the future, then set this to "Yes".
doEnter the function name "create_group" out here
outputformatChoose either xml,json or php as the preferred output format
profile_nameSet a profile / group name, ensuring it is not the same as any other profile name you have in the account.
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.19 create_group Output Variables:
Field Name Field Description
errornoError No
outputmessageDetailed success/fail message
profile_idA confirmation of the newly created profile_id, which can be used later to identify this particular profile.
statusSuccess/Fail

1.19 create_group - Possible Error Values:
Error Title Error Description

1.19 create_group Sample Php Code:
function create_group($default_value, $profile_name, $outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=create_group&outputformat=$outputformat&default_value=$default_value&profile_name=$profile_name";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.19 create_group Sample Url:

1.19 create_group Sample XML Output:
 



create_group

{uname}

{upass}

{apikey}

{profile_name}

xml/json/php

{default_value}



{profile_id}

{errorno}

{status}

{outputmessage}



1.19 create_group Sample Json Output:
{"input":{"do":"create_group","uname":"{uname}","upass":"{upass}","apikey":"{api
key}","profile_name":"{profile_name}","outputformat":"xml\/json\/php","default_v
alue":"{default_value}"},"output":{"profile_id":"{profile_id}","errorno":"{error
no}","status":"{status}","outputmessage":"{outputmessage}"}}

1.19 create_group Sample Php Output:
a:2:{s:5:"input";a:7:{s:2:"do";s:12:"create_group";s:5:"uname";s:7:"{uname}";s:5
:"upass";s:7:"{upass}";s:6:"apikey";s:8:"{apikey}";s:12:"profile_name";s:14:"{pr
ofile_name}";s:12:"outputformat";s:12:"xml/json/php";s:13:"default_value";s:15:"
{default_value}";}s:6:"output";a:4:{s:10:"profile_id";s:12:"{profile_id}";s:7:"e
rrorno";s:9:"{errorno}";s:6:"status";s:8:"{status}";s:13:"outputmessage";s:15:"{
outputmessage}";}}

1.20 invoice_specific Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "invoice_specific" out here
outputformatChoose either xml,json or php as the preferred output format
transactionidEnter the transactionid for which you want to retrieve the invoice details.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.20 invoice_specific Output Variables:
Field Name Field Description
display_name_$cntIf this is an invoice for a paid directory order, then it will show the name of the directory.
display_url_$cntIf this is an invoice for a paid directory order, then it will show the url of the directory.
first_nameUser/client account's first name
last_nameUser/client account's last name
mx_creditedShows the amount of $MX credited at the end of this order, if any.
mx_usedShows the amount of $MX used for this order, if any.
no_of_submissionsShows the number of submissions for this order. If this is an order for paid directories, then this number can be used to loop through the details of the paid directory urls submitted to and the respective price paid for each.
order_dateThe date on which the order was placed.
order_idThe order number generated by Paypal/2CO, if paid using any of those methods.
payment_methodShows whether the payment for this transaction was made by "Paypal", "2CO" or "MXonly"
price_paid_$cntThe price paid for the directory.
refund_amountShows if any amount has been refunded towards this transaction.
refund_statusShows whether there was a "Partial Refund", "Full Refund" or a "Payment reversed" on this order.
special_notesShows any notes made on this order.
special_offer_detailsIf there have been any special offer discounts that have been used with this transction, they will be shown.
speed_in_weeksShows the number of weeks over which this order was chosen to be spread out. If blank, then so such option was chosen in the ordering process.
statusSuccess/Fail
submission_typeWill show whether this transaction was for "Normal Directory Submissions", "Paid Directories" or "Custom Submissions"
totalPrice paid, after deducting any $MX that may have been used.
transactionidA confirmation of the transactionid for which the invoice is being shown.
transaction_timeThe time of the transaction.
type_of_orderShows details about the type of order that was selected, whether it was to "All Directories", a set of "PR3+ Directories", a particular custom list, etc.
unit_priceThe price per submission.
useridA confirmation of the userid for which this invoice is being shown.
websites_submittedA list of all the websites submitted under this transaction, separated by a comma.

1.20 invoice_specific - Possible Error Values:
Error Title Error Description

1.20 invoice_specific Sample Php Code:
function invoice_specific($transactionid, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=invoice_specific&outputformat=$outputformat&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.20 invoice_specific Sample Url:

1.20 invoice_specific Sample XML Output:
 



{transactionid}

{apikey}

{uname}

{upass}

xml/json/php

invoice_specific



{first_name}

{last_name}

{order_date}

{order_id}

{transactionid}

http://www.site-1.com,http://www.site-2.com

{special_offer_details}

{userid}

{transaction_time}

{status}

{refund_amount}

{no_of_submissions}

{submission_type}

{type_of_order}

{payment_method}

{speed_in_weeks}

{refund_status}

{special_notes}

{mx_used}

{mx_credited}

{unit_price}

{total}

{display_name_$cnt}

{display_url_$cnt}

{price_paid_$cnt}



1.20 invoice_specific Sample Json Output:
{"input":{"transactionid":"{transactionid}","apikey":"{apikey}","uname":"{uname}
","upass":"{upass}","outputformat":"xml\/json\/php","do":"invoice_specific"},"ou
tput":{"first_name":"{first_name}","last_name":"{last_name}","order_date":"{orde
r_date}","order_id":"{order_id}","transactionid":"{transactionid}","websites_sub
mitted":"http:\/\/www.site-1.com,http:\/\/www.site-2.com","special_offer_details
":"{special_offer_details}","userid":"{userid}","transaction_time":"{transaction
_time}","status":"{status}","refund_amount":"{refund_amount}","no_of_submissions
":"{no_of_submissions}","submission_type":"{submission_type}","type_of_order":"{
type_of_order}","payment_method":"{payment_method}","speed_in_weeks":"{speed_in_
weeks}","refund_status":"{refund_status}","special_notes":"{special_notes}","mx_
used":"{mx_used}","mx_credited":"{mx_credited}","unit_price":"{unit_price}","tot
al":"{total}","display_name_$cnt":"{display_name_$cnt}","display_url_$cnt":"{dis
play_url_$cnt}","price_paid_$cnt":"{price_paid_$cnt}"}}

1.20 invoice_specific Sample Php Output:
a:2:{s:5:"input";a:6:{s:13:"transactionid";s:15:"{transactionid}";s:6:"apikey";s
:8:"{apikey}";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:12:"outputfo
rmat";s:12:"xml/json/php";s:2:"do";s:16:"invoice_specific";}s:6:"output";a:25:{s
:10:"first_name";s:12:"{first_name}";s:9:"last_name";s:11:"{last_name}";s:10:"or
der_date";s:12:"{order_date}";s:8:"order_id";s:10:"{order_id}";s:13:"transaction
id";s:15:"{transactionid}";s:18:"websites_submitted";s:43:"http://www.site-1.com
,http://www.site-2.com";s:21:"special_offer_details";s:23:"{special_offer_detail
s}";s:6:"userid";s:8:"{userid}";s:16:"transaction_time";s:18:"{transaction_time}
";s:6:"status";s:8:"{status}";s:13:"refund_amount";s:15:"{refund_amount}";s:17:"
no_of_submissions";s:19:"{no_of_submissions}";s:15:"submission_type";s:17:"{subm
ission_type}";s:13:"type_of_order";s:15:"{type_of_order}";s:14:"payment_method";
s:16:"{payment_method}";s:14:"speed_in_weeks";s:16:"{speed_in_weeks}";s:13:"refu
nd_status";s:15:"{refund_status}";s:13:"special_notes";s:15:"{special_notes}";s:
7:"mx_used";s:9:"{mx_used}";s:11:"mx_credited";s:13:"{mx_credited}";s:10:"unit_p
rice";s:12:"{unit_price}";s:5:"total";s:7:"{total}";s:17:"display_name_$cnt";s:1
9:"{display_name_$cnt}";s:16:"display_url_$cnt";s:18:"{display_url_$cnt}";s:15:"
price_paid_$cnt";s:17:"{price_paid_$cnt}";}}

1.21 delete_title_description Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "delete_title_description" out here
siteEnter the site id or url from which you want to delete a title.
tdidEnter the tdid of the title/description that needs to be deleted.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.21 delete_title_description Output Variables:
Field Name Field Description
outputmessageThis field will provide a detailed success/failure message.
siteidA confirmation of the siteid from which the title was deleted.
statusSuccess/Fail
tdidA confirmation of the tdid which was deleted.
title_description_countThe number of titles and descriptions remaining for the site.

1.21 delete_title_description - Possible Error Values:
Error Title Error Description
error_fields

1.21 delete_title_description Sample Php Code:
function delete_title_description($site, $tdid, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=delete_title_description&outputformat=$outputformat&site=$site&tdid=$tdid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.21 delete_title_description Sample Url:

1.21 delete_title_description Sample XML Output:
 



{site}

{tdid}

delete_title_description

{apikey}

{uname}

{upass}



{siteid}

{tdid}

{title_description_count}

{outputmessage}

{status}



1.21 delete_title_description Sample Json Output:
{"input":{"site":"{site}","tdid":"{tdid}","do":"delete_title_description","apike
y":"{apikey}","uname":"{uname}","upass":"{upass}"},"output":{"siteid":"{siteid}"
,"tdid":"{tdid}","title_description_count":"{title_description_count}","outputme
ssage":"{outputmessage}","status":"{status}"}}

1.21 delete_title_description Sample Php Output:
a:2:{s:5:"input";a:6:{s:4:"site";s:6:"{site}";s:4:"tdid";s:6:"{tdid}";s:2:"do";s
:24:"delete_title_description";s:6:"apikey";s:8:"{apikey}";s:5:"uname";s:7:"{una
me}";s:5:"upass";s:7:"{upass}";}s:6:"output";a:5:{s:6:"siteid";s:8:"{siteid}";s:
4:"tdid";s:6:"{tdid}";s:23:"title_description_count";s:25:"{title_description_co
unt}";s:13:"outputmessage";s:15:"{outputmessage}";s:6:"status";s:8:"{status}";}}

1.22 custom_submission_summary Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "custom_submission_summary" out here
siteEnter the site id or the site url for which the submission summary is needed.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.22 custom_submission_summary Output Variables:
Field Name Field Description
customsubmissionreportShows 2 values separated by a "|" (pipe symbol). The first part of the value shows the number of submissions made so far and the second part shows the number of submissions pending on outstanding orders.
outputmessageThis field will provide a detailed success/failure message.
siteidA confirmation of the site id for which the submission summary has been retrieved.
statusSuccess/Fail
urlA confirmation of the site url for which the submission summary has been retrieved.

1.22 custom_submission_summary - Possible Error Values:
Error Title Error Description
error_fields

1.22 custom_submission_summary Sample Php Code:
function custom_submission_summary($site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=custom_submission_summary&outputformat=$outputformat&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.22 custom_submission_summary Sample Url:

1.22 custom_submission_summary Sample XML Output:
 



{site}

{apikey}

{upass}

{uname}

custom_submission_summary



320|43

{siteid}

{url}

{outputmessage}

{status}



1.22 custom_submission_summary Sample Json Output:
{"input":{"site":"{site}","apikey":"{apikey}","upass":"{upass}","uname":"{uname}
","do":"custom_submission_summary"},"output":{"customsubmissionreport":"320|43",
"siteid":"{siteid}","url":"{url}","outputmessage":"{outputmessage}","status":"{s
tatus}"}}

1.22 custom_submission_summary Sample Php Output:
a:2:{s:5:"input";a:5:{s:4:"site";s:6:"{site}";s:6:"apikey";s:8:"{apikey}";s:5:"u
pass";s:7:"{upass}";s:5:"uname";s:7:"{uname}";s:2:"do";s:25:"custom_submission_s
ummary";}s:6:"output";a:5:{s:22:"customsubmissionreport";s:6:"320|43";s:6:"sitei
d";s:8:"{siteid}";s:3:"url";s:5:"{url}";s:13:"outputmessage";s:15:"{outputmessag
e}";s:6:"status";s:8:"{status}";}}

1.23 get_subscription_list Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "get_subscription_list" out here
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.23 get_subscription_list Output Variables:
Field Name Field Description
end_date_$cntThe end date for the subscription.
error_fields
no_of_subscriptionsShows the number of subscriptions in the account, you'll need to use this number to loop through the number of records.
outputmessageThis field will provide a detailed success/failure message.
start_date_$cntThe start date for the subscription.
statusSuccess/Fail
status_$cntThe status of the subscription, whether it is "Active", "Complete" or "Cancelled"
subscr_id_$cntThe subscription id generated by Paypal.

1.23 get_subscription_list - Possible Error Values:
Error Title Error Description

1.23 get_subscription_list Sample Php Code:
function get_subscription_list( $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=get_subscription_list&outputformat=$outputformat";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.23 get_subscription_list Sample Url:

1.23 get_subscription_list Sample XML Output:
 



{apikey}

{uname}

{upass}

get_subscription_list



{subscr_id_$cnt}

{start_date_$cnt}

{end_date_$cnt}

{status_$cnt}

{no_of_subscriptions}

{status}

{outputmessage}

{error_fields}



1.23 get_subscription_list Sample Json Output:
{"input":{"apikey":"{apikey}","uname":"{uname}","upass":"{upass}","do":"get_subs
cription_list"},"output":{"subscr_id_$cnt":"{subscr_id_$cnt}","start_date_$cnt":
"{start_date_$cnt}","end_date_$cnt":"{end_date_$cnt}","status_$cnt":"{status_$cn
t}","no_of_subscriptions":"{no_of_subscriptions}","status":"{status}","outputmes
sage":"{outputmessage}","error_fields":"{error_fields}"}}

1.23 get_subscription_list Sample Php Output:
a:2:{s:5:"input";a:4:{s:6:"apikey";s:8:"{apikey}";s:5:"uname";s:7:"{uname}";s:5:
"upass";s:7:"{upass}";s:2:"do";s:21:"get_subscription_list";}s:6:"output";a:8:{s
:14:"subscr_id_$cnt";s:16:"{subscr_id_$cnt}";s:15:"start_date_$cnt";s:17:"{start
_date_$cnt}";s:13:"end_date_$cnt";s:15:"{end_date_$cnt}";s:11:"status_$cnt";s:13
:"{status_$cnt}";s:19:"no_of_subscriptions";s:21:"{no_of_subscriptions}";s:6:"st
atus";s:8:"{status}";s:13:"outputmessage";s:15:"{outputmessage}";s:12:"error_fie
lds";s:14:"{error_fields}";}}

1.24 get_custom_lists Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "get_custom_lists" out here
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.24 get_custom_lists Output Variables:
Field Name Field Description
listid_$cntThe listid.
list_description_$cntThe description of the list.
list_name_$cntThe name of the list.
list_size_$cntThe number of urls in the list.
list_update_timeThe time the list was last updated.
list_update_time_$cntShows the last time the list was updated.
no_of_listsShows the number of lists in the account. You will need to use this number to loop through the number of records.
outputmessageThis field will provide a detailed success/failure message.
paid_list_$cntWill return a "Yes" if it's a paid list, else will be "No"
statusSuccess/Fail

1.24 get_custom_lists - Possible Error Values:
Error Title Error Description
error_fields

1.24 get_custom_lists Sample Php Code:
function get_custom_lists( $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=get_custom_lists&outputformat=$outputformat";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.24 get_custom_lists Sample Url:

1.24 get_custom_lists Sample XML Output:
 



{uname}

{upass}

{apikey}

get_custom_lists



{listid_$cnt}

{list_name_$cnt}

{list_description_$cnt}

{list_size_$cnt}

{outputmessage}

{status}

{no_of_lists}

{list_update_time_$cnt}

{list_update_time}

no/yes



1.24 get_custom_lists Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"get_cust
om_lists"},"output":{"listid_$cnt":"{listid_$cnt}","list_name_$cnt":"{list_name_
$cnt}","list_description_$cnt":"{list_description_$cnt}","list_size_$cnt":"{list
_size_$cnt}","outputmessage":"{outputmessage}","status":"{status}","no_of_lists"
:"{no_of_lists}","list_update_time_$cnt":"{list_update_time_$cnt}","list_update_
time":"{list_update_time}","paid_list_$cnt":"no\/yes"}}

1.24 get_custom_lists Sample Php Output:
a:2:{s:5:"input";a:4:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:16:"get_custom_lists";}s:6:"output";a:10:{s:11:
"listid_$cnt";s:13:"{listid_$cnt}";s:14:"list_name_$cnt";s:16:"{list_name_$cnt}"
;s:21:"list_description_$cnt";s:23:"{list_description_$cnt}";s:14:"list_size_$cn
t";s:16:"{list_size_$cnt}";s:13:"outputmessage";s:15:"{outputmessage}";s:6:"stat
us";s:8:"{status}";s:11:"no_of_lists";s:13:"{no_of_lists}";s:21:"list_update_tim
e_$cnt";s:23:"{list_update_time_$cnt}";s:16:"list_update_time";s:18:"{list_updat
e_time}";s:14:"paid_list_$cnt";s:6:"no/yes";}}

1.25 upload_submissions Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
directoryEnter the directory url that this site was submitted to.
doEnter the function name "upload_submissions" out here
siteEnter the siteid or site url. This site needs to be present in the account, if not, then first add the site and then try uploading previously made submissions.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.25 upload_submissions Output Variables:
Field Name Field Description
didA confirmation of the did (directory's id)
directoryA confirmation of the directory url uploaded.
outputmessageThis field will provide a detailed success/failure message.
siteidA confirmation of the siteid.
statusSuccess/Fail
useridA confirmation of the userid of the account.

1.25 upload_submissions - Possible Error Values:
Error Title Error Description
error_fields

1.25 upload_submissions Sample Php Code:
function upload_submissions($directory, $site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=upload_submissions&outputformat=$outputformat&directory=$directory&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.25 upload_submissions Sample Url:

1.25 upload_submissions Sample XML Output:
 



{site}

{directory}

{apikey}

{uname}

{upass}

upload_submissions



{userid}

{directory}

{siteid}

{did}

{status}

{outputmessage}



1.25 upload_submissions Sample Json Output:
{"input":{"site":"{site}","directory":"{directory}","apikey":"{apikey}","uname":
"{uname}","upass":"{upass}","do":"upload_submissions"},"output":{"userid":"{user
id}","directory":"{directory}","siteid":"{siteid}","did":"{did}","status":"{stat
us}","outputmessage":"{outputmessage}"}}

1.25 upload_submissions Sample Php Output:
a:2:{s:5:"input";a:6:{s:4:"site";s:6:"{site}";s:9:"directory";s:11:"{directory}"
;s:6:"apikey";s:8:"{apikey}";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}"
;s:2:"do";s:18:"upload_submissions";}s:6:"output";a:6:{s:6:"userid";s:8:"{userid
}";s:9:"directory";s:11:"{directory}";s:6:"siteid";s:8:"{siteid}";s:3:"did";s:5:
"{did}";s:6:"status";s:8:"{status}";s:13:"outputmessage";s:15:"{outputmessage}";
}}

1.26 edit_group_name Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
default_valueSpecify "Yes" if you want to make this the default group, else by default it is set to "No". The field can be left blank.
doEnter the function name "edit_group_name" out here
profileThe old/original profile id or name that needs to be edited.
profile_nameThe new profile name for this group.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.26 edit_group_name Output Variables:
Field Name Field Description
errorno
new_profile_nameThe new profile name.
old_default_valueThe old default value.
old_profile_nameThe old profile name.
outputmessageThis field will provide a detailed success/failure message.
profile_idThe profile id that was edited.
statusSuccess/Fail

1.26 edit_group_name - Possible Error Values:
Error Title Error Description
error_fields

1.26 edit_group_name Sample Php Code:
function edit_group_name($default_value, $profile, $profile_name, $outputformat='json',
$print_query=false) 
{ 
  $this->query =
"do=edit_group_name&outputformat=$outputformat&default_value=$default_value&profile=$profile&profile_name=$profile_name";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.26 edit_group_name Sample Url:

1.26 edit_group_name Sample XML Output:
 



{profile_name}

{profile}

{default_value}

{apikey}

{uname}

{upass}

edit_group_name



{profile_id}

{old_profile_name}

{new_profile_name}

{old_default_value}

{errorno}

{status}

{outputmessage}



1.26 edit_group_name Sample Json Output:
{"input":{"profile_name":"{profile_name}","profile":"{profile}","default_value":
"{default_value}","apikey":"{apikey}","uname":"{uname}","upass":"{upass}","do":"
edit_group_name"},"output":{"profile_id":"{profile_id}","old_profile_name":"{old
_profile_name}","new_profile_name":"{new_profile_name}","old_default_value":"{ol
d_default_value}","errorno":"{errorno}","status":"{status}","outputmessage":"{ou
tputmessage}"}}

1.26 edit_group_name Sample Php Output:
a:2:{s:5:"input";a:7:{s:12:"profile_name";s:14:"{profile_name}";s:7:"profile";s:
9:"{profile}";s:13:"default_value";s:15:"{default_value}";s:6:"apikey";s:8:"{api
key}";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:2:"do";s:15:"edit_gr
oup_name";}s:6:"output";a:7:{s:10:"profile_id";s:12:"{profile_id}";s:16:"old_pro
file_name";s:18:"{old_profile_name}";s:16:"new_profile_name";s:18:"{new_profile_
name}";s:17:"old_default_value";s:19:"{old_default_value}";s:7:"errorno";s:9:"{e
rrorno}";s:6:"status";s:8:"{status}";s:13:"outputmessage";s:15:"{outputmessage}"
;}}

1.27 edit_site_for_custom Input Parameters:
Field Name Field Description
address_line1Address Line 1
address_line2Address Line 2
apikeyEnter the API key of your Account
cityCity name
company_nameEnter the Business/Company Name or Official Website Name
countryCountry Name. Leave blank to retain the same country already selected for the site in the "Add Site" section.
doEnter the function name "edit_site_for_custom" out here
employeesNumber of employees
faxFax Number
phonePhone Number
sales_emailContact email of person in charge of sales, if any
sales_nameContact Name of person in charge of sales, if any.
siteEnter the siteid or the site url
stateState/Region
toll_freeToll free number, if available
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.
year_establishedYear company/website was established.
zipcodeZipcode for the address given

1.27 edit_site_for_custom Output Variables:
Field Name Field Description
outputmessageThis field will provide a detailed success/failure message.
siteid
statusSuccess/Fail
userid

1.27 edit_site_for_custom - Possible Error Values:
Error Title Error Description
error_fields

1.27 edit_site_for_custom Sample Php Code:
function edit_site_for_custom($address_line1, $address_line2, $city, $company_name, $country,
$employees,
$fax, $phone, $sales_email, $sales_name, $site, $state, $toll_free,
$year_established, $zipcode, $outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=edit_site_for_custom&outputformat=$outputformat&address_line1=$address_line1&address_line2=$address_line2&city=$city&company_name=$company_name&country=$country&employees=$employees&fax=$fax&phone=$phone&sales_email=$sales_email&sales_name=$sales_name&site=$site&state=$state&toll_free=$toll_free&year_established=$year_established&zipcode=$zipcode";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.27 edit_site_for_custom Sample Url:

1.27 edit_site_for_custom Sample XML Output:
 



{site}

{company_name}

{address_line1}

{address_line2}

{city}

{state}

{phone}

{fax}

{year_established}

{employees}

{toll_free}

{zipcode}

{sales_name}

{sales_email}

{apikey}

{uname}

{upass}

edit_site_for_custom

{country}



{outputmessage}

{status}

{siteid}

{userid}



1.27 edit_site_for_custom Sample Json Output:
{"input":{"site":"{site}","company_name":"{company_name}","address_line1":"{addr
ess_line1}","address_line2":"{address_line2}","city":"{city}","state":"{state}",
"phone":"{phone}","fax":"{fax}","year_established":"{year_established}","employe
es":"{employees}","toll_free":"{toll_free}","zipcode":"{zipcode}","sales_name":"
{sales_name}","sales_email":"{sales_email}","apikey":"{apikey}","uname":"{uname}
","upass":"{upass}","do":"edit_site_for_custom","country":"{country}"},"output":
{"outputmessage":"{outputmessage}","status":"{status}","siteid":"{siteid}","user
id":"{userid}"}}

1.27 edit_site_for_custom Sample Php Output:
a:2:{s:5:"input";a:19:{s:4:"site";s:6:"{site}";s:12:"company_name";s:14:"{compan
y_name}";s:13:"address_line1";s:15:"{address_line1}";s:13:"address_line2";s:15:"
{address_line2}";s:4:"city";s:6:"{city}";s:5:"state";s:7:"{state}";s:5:"phone";s
:7:"{phone}";s:3:"fax";s:5:"{fax}";s:16:"year_established";s:18:"{year_establish
ed}";s:9:"employees";s:11:"{employees}";s:9:"toll_free";s:11:"{toll_free}";s:7:"
zipcode";s:9:"{zipcode}";s:10:"sales_name";s:12:"{sales_name}";s:11:"sales_email
";s:13:"{sales_email}";s:6:"apikey";s:8:"{apikey}";s:5:"uname";s:7:"{uname}";s:5
:"upass";s:7:"{upass}";s:2:"do";s:20:"edit_site_for_custom";s:7:"country";s:9:"{
country}";}s:6:"output";a:4:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"st
atus";s:8:"{status}";s:6:"siteid";s:8:"{siteid}";s:6:"userid";s:8:"{userid}";}}

1.28 order_site_for_custom Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "order_site_for_custom" out here
transactionidEnter the transactionid to be completed.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.28 order_site_for_custom Output Variables:
Field Name Field Description
availablemx
mxused
outputmessageThis field will provide a detailed success/failure message.
statusSuccess/Fail
transactionid

1.28 order_site_for_custom - Possible Error Values:
Error Title Error Description
error_fields

1.28 order_site_for_custom Sample Php Code:
function order_site_for_custom($transactionid, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=order_site_for_custom&outputformat=$outputformat&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.28 order_site_for_custom Sample Url:

1.28 order_site_for_custom Sample XML Output:
 



order_site_for_custom

{apikey}

{uname}

{upass}

{transactionid}



{transactionid}

{outputmessage}

{availablemx}

{mxused}

{status}



1.28 order_site_for_custom Sample Json Output:
{"input":{"do":"order_site_for_custom","apikey":"{apikey}","uname":"{uname}","up
ass":"{upass}","transactionid":"{transactionid}"},"output":{"transactionid":"{tr
ansactionid}","outputmessage":"{outputmessage}","availablemx":"{availablemx}","m
xused":"{mxused}","status":"{status}"}}

1.28 order_site_for_custom Sample Php Output:
a:2:{s:5:"input";a:5:{s:2:"do";s:21:"order_site_for_custom";s:6:"apikey";s:8:"{a
pikey}";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:13:"transactionid"
;s:15:"{transactionid}";}s:6:"output";a:5:{s:13:"transactionid";s:15:"{transacti
onid}";s:13:"outputmessage";s:15:"{outputmessage}";s:11:"availablemx";s:13:"{ava
ilablemx}";s:6:"mxused";s:8:"{mxused}";s:6:"status";s:8:"{status}";}}

1.29 add_site_for_custom Input Parameters:
Field Name Field Description
address_line1Address Line 1
address_line2Address Line 2
apikeyEnter the API key of your Account
cityCity name
company_nameEnter the Business/Company Name or Official Website Name
countryCountry Name. Leave blank to retain the same country already selected for the site in the "Add Site" section.
doEnter the function name "add_site_for_custom" out here
employeesNumber of employees
faxFax Number
phonePhone Number
sales_emailContact email of person in charge of sales, if any
sales_nameContact Name of person in charge of sales, if any.
siteEnter the siteid or the site url
stateState
toll_freeToll free number, if available
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.
year_establishedYear company/website was established.
zipcodeZipcode for the address given

1.29 add_site_for_custom Output Variables:
Field Name Field Description
outputmessageThis field will provide a detailed success/failure message.
statusSuccess/Fail

1.29 add_site_for_custom - Possible Error Values:
Error Title Error Description
error_fields

1.29 add_site_for_custom Sample Php Code:
function add_site_for_custom($address_line1, $address_line2, $city, $company_name, $country,
$employees,
$fax, $phone, $sales_email, $sales_name, $site, $state, $toll_free,
$year_established, $zipcode, $outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=add_site_for_custom&outputformat=$outputformat&address_line1=$address_line1&address_line2=$address_line2&city=$city&company_name=$company_name&country=$country&employees=$employees&fax=$fax&phone=$phone&sales_email=$sales_email&sales_name=$sales_name&site=$site&state=$state&toll_free=$toll_free&year_established=$year_established&zipcode=$zipcode";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.29 add_site_for_custom Sample Url:

1.29 add_site_for_custom Sample XML Output:
 



add_site_for_custom

{apikey}

{uname}

{upass}

{site}

{company_name}

{address_line1}

{address_line2}

{city}

{state}

{phone}

{fax}

{year_established}

{employees}

{toll_free}

{zipcode}

{sales_name}

{sales_email}

{country}



{status}

{outputmessage}



1.29 add_site_for_custom Sample Json Output:
{"input":{"do":"add_site_for_custom","apikey":"{apikey}","uname":"{uname}","upas
s":"{upass}","site":"{site}","company_name":"{company_name}","address_line1":"{a
ddress_line1}","address_line2":"{address_line2}","city":"{city}","state":"{state
}","phone":"{phone}","fax":"{fax}","year_established":"{year_established}","empl
oyees":"{employees}","toll_free":"{toll_free}","zipcode":"{zipcode}","sales_name
":"{sales_name}","sales_email":"{sales_email}","country":"{country}"},"output":{
"status":"{status}","outputmessage":"{outputmessage}"}}

1.29 add_site_for_custom Sample Php Output:
a:2:{s:5:"input";a:19:{s:2:"do";s:19:"add_site_for_custom";s:6:"apikey";s:8:"{ap
ikey}";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:4:"site";s:6:"{site
}";s:12:"company_name";s:14:"{company_name}";s:13:"address_line1";s:15:"{address
_line1}";s:13:"address_line2";s:15:"{address_line2}";s:4:"city";s:6:"{city}";s:5
:"state";s:7:"{state}";s:5:"phone";s:7:"{phone}";s:3:"fax";s:5:"{fax}";s:16:"yea
r_established";s:18:"{year_established}";s:9:"employees";s:11:"{employees}";s:9:
"toll_free";s:11:"{toll_free}";s:7:"zipcode";s:9:"{zipcode}";s:10:"sales_name";s
:12:"{sales_name}";s:11:"sales_email";s:13:"{sales_email}";s:7:"country";s:9:"{c
ountry}";}s:6:"output";a:2:{s:6:"status";s:8:"{status}";s:13:"outputmessage";s:1
5:"{outputmessage}";}}

1.30 get_custom_site_info Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the name of the function.
siteEnter the siteid or site url.
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.30 get_custom_site_info Output Variables:
Field Name Field Description
address1Address Line 1
address2Address Line 2
category_preferencesShows the category preferences mentioned for this site.
cityCity
company_nameCompany Name of Website's official name
contact_emailDisplays the email used for submissions. If the field doesn't exist or is blank, it is likely that the e-mail handling service has been enabled. That can be confirmed by checking the "email_handling_service_enabled" field.
contact_nameThe name that will be used for submissions.
countryCountry
description_$cntdescription_1, description_2 ... the count goes up to the number of descriptions available for the site and each field displays the respective description.
distribution_ratio_$cntdistribution_ratio_1, distribution_ratio_2 ... the count goes up to the number of titles available for the site and each field displays the respective distribution ratio for each title/description combination.
email_handling_service_enabledShows "Yes" or "No" depending on whether or not the email handling service has been enabled or not.
faxFax
group_nameThe name of the group to which the site belongs.
inactive_reasonIf a site is inactive, it will show the reason for it being inactive.
keywordsShows the keywords mentioned for this site.
no_of_employeesNo. of employees
phonePhone
sales_emailThe e-mail contact of the Sales person
sales_nameContact Name for Sales
siteidThe unique id "siteid" associated with this site.
site_added_dateThe date on which the site was added.
site_urlDisplays the website url
stateState/Region
title_$cnttitle_1, title_2 ... the count goes up to the number of titles available for the site and each field displays the respective title.
title_description_countShows the number of titles and descriptions available for this site.
website_statusShows whether a site is Active or Inactive. Inactive sites cannot be ordered for and if there are submissions pending, they will be on hold till it's active again.
year_establishedYear established.
zipcodeZip / Postal Code

1.30 get_custom_site_info - Possible Error Values:
Error Title Error Description

1.30 get_custom_site_info Sample Php Code:
function get_custom_site_info($site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=get_custom_site_info&outputformat=$outputformat&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.30 get_custom_site_info Sample Url:

1.30 get_custom_site_info Sample XML Output:
 



{site}

{apikey}

{uname}

{upass}

get_custom_site_info



{group_name}

{contact_name}

{contact_email}

{email_handling_service_enabled}

{state}

{inactive_reason}

{site_url}

{category_preferences}

{keywords}

{site_added_date}

{website_status}

{company_name}

{address1}

{address2}

{city}

{zipcode}

{sales_name}

{sales_email}

{phone}

{fax}

{year_established}

{no_of_employees}

{country}

{siteid}

{title_$cnt}

{description_$cnt}

{distribution_ratio_$cnt}

{title_description_count}



1.30 get_custom_site_info Sample Json Output:
{"input":{"site":"{site}","apikey":"{apikey}","uname":"{uname}","upass":"{upass}
","do":"get_custom_site_info"},"output":{"group_name":"{group_name}","contact_na
me":"{contact_name}","contact_email":"{contact_email}","email_handling_service_e
nabled":"{email_handling_service_enabled}","state":"{state}","inactive_reason":"
{inactive_reason}","site_url":"{site_url}","category_preferences":"{category_pre
ferences}","keywords":"{keywords}","site_added_date":"{site_added_date}","websit
e_status":"{website_status}","company_name":"{company_name}","address1":"{addres
s1}","address2":"{address2}","city":"{city}","zipcode":"{zipcode}","sales_name":
"{sales_name}","sales_email":"{sales_email}","phone":"{phone}","fax":"{fax}","ye
ar_established":"{year_established}","no_of_employees":"{no_of_employees}","coun
try":"{country}","siteid":"{siteid}","title_$cnt":"{title_$cnt}","description_$c
nt":"{description_$cnt}","distribution_ratio_$cnt":"{distribution_ratio_$cnt}","
title_description_count":"{title_description_count}"}}

1.30 get_custom_site_info Sample Php Output:
a:2:{s:5:"input";a:5:{s:4:"site";s:6:"{site}";s:6:"apikey";s:8:"{apikey}";s:5:"u
name";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:2:"do";s:20:"get_custom_site_inf
o";}s:6:"output";a:28:{s:10:"group_name";s:12:"{group_name}";s:12:"contact_name"
;s:14:"{contact_name}";s:13:"contact_email";s:15:"{contact_email}";s:30:"email_h
andling_service_enabled";s:32:"{email_handling_service_enabled}";s:5:"state";s:7
:"{state}";s:15:"inactive_reason";s:17:"{inactive_reason}";s:8:"site_url";s:10:"
{site_url}";s:20:"category_preferences";s:22:"{category_preferences}";s:8:"keywo
rds";s:10:"{keywords}";s:15:"site_added_date";s:17:"{site_added_date}";s:14:"web
site_status";s:16:"{website_status}";s:12:"company_name";s:14:"{company_name}";s
:8:"address1";s:10:"{address1}";s:8:"address2";s:10:"{address2}";s:4:"city";s:6:
"{city}";s:7:"zipcode";s:9:"{zipcode}";s:10:"sales_name";s:12:"{sales_name}";s:1
1:"sales_email";s:13:"{sales_email}";s:5:"phone";s:7:"{phone}";s:3:"fax";s:5:"{f
ax}";s:16:"year_established";s:18:"{year_established}";s:15:"no_of_employees";s:
17:"{no_of_employees}";s:7:"country";s:9:"{country}";s:6:"siteid";s:8:"{siteid}"
;s:10:"title_$cnt";s:12:"{title_$cnt}";s:16:"description_$cnt";s:18:"{descriptio
n_$cnt}";s:23:"distribution_ratio_$cnt";s:25:"{distribution_ratio_$cnt}";s:23:"t
itle_description_count";s:25:"{title_description_count}";}}

1.31 transaction_status Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "transaction_status" out here
transactionidEnter the transactionid for which you want to fetch the status.
unameEnter the username of the account you want to access.
upassEnter the password of the account you want to access.

1.31 transaction_status Output Variables:
Field Name Field Description
email_handling_$cntWhether email handling was enabled for the site for this particular transaction. Output will either be "Yes" or "No"
errornoError No
incomplete_reasonTells whether payment was never completed or a refund was made on the order.
mail_sentWhether a submission completion mail was sent to the registered email address.
mx_creditedThe $MX credited to the account at the end of the order.
no_of_sites_orderedThe number of sites for which an order was placed under this transaction.
outputmessageDetailed success/fail message
siteid_$cntThe siteid for which the order was placed. A looping variable going on to cover all the sites ordered under the transaction.
statusSuccess/Fail
submissions_complete_$cntThe number of submissions finally made for the respective site. If the submissions for the site are not completely done as yet, the output will show as "Not yet complete"
submissions_ordered_$cntThe number of submissions ordered for the respective site.
transactionidThe transactionid fetched.
transaction_statusWill show either "Complete" for an order where all the submissions have been made, "Pending" for an order that is still underway, "Incomplete" for an order that was never completely paid for or was refunded.
type_of_orderShows the type of order, whether "Normal Directory Submissions", "Paid Directories" or "Custom" submissions.

1.31 transaction_status - Possible Error Values:
Error Title Error Description

1.31 transaction_status Sample Php Code:
function transaction_status($transactionid, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=transaction_status&outputformat=$outputformat&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.31 transaction_status Sample Url:

1.31 transaction_status Sample XML Output:
 



{apikey}

{uname}

{transactionid}

transaction_status

{upass}



{errorno}

{status}

{outputmessage}

{transactionid}

complete/pending/incomplete

normal directory submissions

{mail_sent}

{mx_credited}

{no_of_sites_ordered}

{siteid_$cnt}

{submissions_ordered_$cnt}

{submissions_complete_$cnt}

yes/no

incomplete payment



1.31 transaction_status Sample Json Output:
{"input":{"apikey":"{apikey}","uname":"{uname}","transactionid":"{transactionid}
","do":"transaction_status","upass":"{upass}"},"output":{"errorno":"{errorno}","
status":"{status}","outputmessage":"{outputmessage}","transactionid":"{transacti
onid}","transaction_status":"complete\/pending\/incomplete","type_of_order":"nor
mal directory
submissions","mail_sent":"{mail_sent}","mx_credited":"{mx_credited}","no_of_site
s_ordered":"{no_of_sites_ordered}","siteid_$cnt":"{siteid_$cnt}","submissions_or
dered_$cnt":"{submissions_ordered_$cnt}","submissions_complete_$cnt":"{submissio
ns_complete_$cnt}","email_handling_$cnt":"yes\/no","incomplete_reason":"incomple
te payment"}}

1.31 transaction_status Sample Php Output:
a:2:{s:5:"input";a:5:{s:6:"apikey";s:8:"{apikey}";s:5:"uname";s:7:"{uname}";s:13
:"transactionid";s:15:"{transactionid}";s:2:"do";s:18:"transaction_status";s:5:"
upass";s:7:"{upass}";}s:6:"output";a:14:{s:7:"errorno";s:9:"{errorno}";s:6:"stat
us";s:8:"{status}";s:13:"outputmessage";s:15:"{outputmessage}";s:13:"transaction
id";s:15:"{transactionid}";s:18:"transaction_status";s:27:"complete/pending/inco
mplete";s:13:"type_of_order";s:28:"normal directory
submissions";s:9:"mail_sent";s:11:"{mail_sent}";s:11:"mx_credited";s:13:"{mx_cre
dited}";s:19:"no_of_sites_ordered";s:21:"{no_of_sites_ordered}";s:11:"siteid_$cn
t";s:13:"{siteid_$cnt}";s:24:"submissions_ordered_$cnt";s:26:"{submissions_order
ed_$cnt}";s:25:"submissions_complete_$cnt";s:27:"{submissions_complete_$cnt}";s:
19:"email_handling_$cnt";s:6:"yes/no";s:17:"incomplete_reason";s:18:"incomplete
payment";}}

1.32 cancel_order Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "cancel_order" out here
transactionidPass the transactionid that needs to be deleted.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.32 cancel_order Output Variables:
Field Name Field Description
outputmessageThis field will provide a detailed success/failure message. On success, it will state that the order was successfully deleted and show the amount of $MX credited. It could fail if, 1) the order was already deleted previously, 2) it's not a valid transactionid, 3) the order is already underway in which case you'd need to call the cancel_remaining_submissions function or 4) the order was never completely paid for in the first place.
statusSuccess/Fail

1.32 cancel_order - Possible Error Values:
Error Title Error Description

1.32 cancel_order Sample Php Code:
function cancel_order($transactionid, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=cancel_order&outputformat=$outputformat&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.32 cancel_order Sample Url:

1.32 cancel_order Sample XML Output:
 



3323

{apikey}

{uname}

{upass}

cancel_order



{status}

{outputmessage}



1.32 cancel_order Sample Json Output:
{"input":{"transactionid":"3323","apikey":"{apikey}","uname":"{uname}","upass":"
{upass}","do":"cancel_order"},"output":{"status":"{status}","outputmessage":"{ou
tputmessage}"}}

1.32 cancel_order Sample Php Output:
a:2:{s:5:"input";a:5:{s:13:"transactionid";s:4:"3323";s:6:"apikey";s:8:"{apikey}
";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:2:"do";s:12:"cancel_orde
r";}s:6:"output";a:2:{s:6:"status";s:8:"{status}";s:13:"outputmessage";s:15:"{ou
tputmessage}";}}

1.33 cancel_remaining_submissions Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "cancel_remaining_submissions" out here
transactionidPass the transactionid for which the remaining submissions need to be cancelled.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.33 cancel_remaining_submissions Output Variables:
Field Name Field Description
outputmessageThis field will provide a detailed success/failure message. On success, it will state that the remaining submissions of the order were successfully deleted and it will fail if there are no remaining submissions to be cancelled.
statusSuccess/Fail
submissions_cancelledThis field will display the number of submissions actually cancelled.

1.33 cancel_remaining_submissions - Possible Error Values:
Error Title Error Description

1.33 cancel_remaining_submissions Sample Php Code:
function cancel_remaining_submissions($transactionid, $outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=cancel_remaining_submissions&outputformat=$outputformat&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.33 cancel_remaining_submissions Sample Url:

1.33 cancel_remaining_submissions Sample XML Output:
 



3323

{apikey}

{uname}

{upass}

cancel_remaining_submissions



{status}

500

{outputmessage}



1.33 cancel_remaining_submissions Sample Json Output:
{"input":{"transactionid":"3323","apikey":"{apikey}","uname":"{uname}","upass":"
{upass}","do":"cancel_remaining_submissions"},"output":{"status":"{status}","sub
missions_cancelled":"500","outputmessage":"{outputmessage}"}}

1.33 cancel_remaining_submissions Sample Php Output:
a:2:{s:5:"input";a:5:{s:13:"transactionid";s:4:"3323";s:6:"apikey";s:8:"{apikey}
";s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:2:"do";s:28:"cancel_rema
ining_submissions";}s:6:"output";a:3:{s:6:"status";s:8:"{status}";s:21:"submissi
ons_cancelled";s:3:"500";s:13:"outputmessage";s:15:"{outputmessage}";}}

1.34 reset_title_description Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the function name "reset_title_description" out here
sitePass the siteid of the site for which the titles/descriptions need to be reset.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.34 reset_title_description Output Variables:
Field Name Field Description
outputmessageThis field will provide a detailed success/failure message.
siteidThe siteid affected.
statusSuccess/Fail

1.34 reset_title_description - Possible Error Values:
Error Title Error Description

1.34 reset_title_description Sample Php Code:
function reset_title_description($site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=reset_title_description&outputformat=$outputformat&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.34 reset_title_description Sample Url:

1.34 reset_title_description Sample XML Output:
 



123

{uname}

{upass}

{do}

{apikey}



{siteid}

{status}

{outputmessage}



1.34 reset_title_description Sample Json Output:
{"input":{"site":"123","uname":"{uname}","upass":"{upass}","do":"{do}","apikey":
"{apikey}"},"output":{"siteid":"{siteid}","status":"{status}","outputmessage":"{
outputmessage}"}}

1.34 reset_title_description Sample Php Output:
a:2:{s:5:"input";a:5:{s:4:"site";s:3:"123";s:5:"uname";s:7:"{uname}";s:5:"upass"
;s:7:"{upass}";s:2:"do";s:4:"{do}";s:6:"apikey";s:8:"{apikey}";}s:6:"output";a:3
:{s:6:"siteid";s:8:"{siteid}";s:6:"status";s:8:"{status}";s:13:"outputmessage";s
:15:"{outputmessage}";}}

1.35 get_mx_balance Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "get_mx_balance" out here
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.35 get_mx_balance Output Variables:
Field Name Field Description
mx_balanceDisplays the current $MX balance available in the account.
outputmessageThis field will provide a detailed success/failure message.
statusSuccess/Fail

1.35 get_mx_balance - Possible Error Values:
Error Title Error Description

1.35 get_mx_balance Sample Php Code:
function get_mx_balance( $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=get_mx_balance&outputformat=$outputformat";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.35 get_mx_balance Sample Url:

1.35 get_mx_balance Sample XML Output:
 



{apikey}

{uname}

{upass}

{do}



3220.90

{status}

{outputmessage}



1.35 get_mx_balance Sample Json Output:
{"input":{"apikey":"{apikey}","uname":"{uname}","upass":"{upass}","do":"{do}"},"
output":{"mx_balance":"3220.90","status":"{status}","outputmessage":"{outputmess
age}"}}

1.35 get_mx_balance Sample Php Output:
a:2:{s:5:"input";a:4:{s:6:"apikey";s:8:"{apikey}";s:5:"uname";s:7:"{uname}";s:5:
"upass";s:7:"{upass}";s:2:"do";s:4:"{do}";}s:6:"output";a:3:{s:10:"mx_balance";s
:7:"3220.90";s:6:"status";s:8:"{status}";s:13:"outputmessage";s:15:"{outputmessa
ge}";}}

1.36 get_current_pricing Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "get_current_pricing" out here
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.36 get_current_pricing Output Variables:
Field Name Field Description
email_handling_costWill return the pricing for using the email handling service.
normal_submission_costWill return the pricing for normal directory submissions.
outputmessageThis field will provide a detailed success/failure message.
statusSuccess/Fail

1.36 get_current_pricing - Possible Error Values:
Error Title Error Description

1.36 get_current_pricing Sample Php Code:
function get_current_pricing( $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=get_current_pricing&outputformat=$outputformat";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.36 get_current_pricing Sample Url:

1.36 get_current_pricing Sample XML Output:
 



{apikey}

{uname}

{upass}

{do}



{status}

{outputmessage}

{normal_submission_cost}

{email_handling_cost}



1.36 get_current_pricing Sample Json Output:
{"input":{"apikey":"{apikey}","uname":"{uname}","upass":"{upass}","do":"{do}"},"
output":{"status":"{status}","outputmessage":"{outputmessage}","normal_submissio
n_cost":"{normal_submission_cost}","email_handling_cost":"{email_handling_cost}"
}}

1.36 get_current_pricing Sample Php Output:
a:2:{s:5:"input";a:4:{s:6:"apikey";s:8:"{apikey}";s:5:"uname";s:7:"{uname}";s:5:
"upass";s:7:"{upass}";s:2:"do";s:4:"{do}";}s:6:"output";a:4:{s:6:"status";s:8:"{
status}";s:13:"outputmessage";s:15:"{outputmessage}";s:22:"normal_submission_cos
t";s:24:"{normal_submission_cost}";s:19:"email_handling_cost";s:21:"{email_handl
ing_cost}";}}

1.37 process_custom_list Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "process_custom_list" out here
listidEnter the listid which needs to be processed.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.37 process_custom_list Output Variables:
Field Name Field Description
outputmessageThis field will provide a detailed success/failure message.
statusSuccess/Fail

1.37 process_custom_list - Possible Error Values:
Error Title Error Description

1.37 process_custom_list Sample Php Code:
function process_custom_list($listid, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=process_custom_list&outputformat=$outputformat&listid=$listid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.37 process_custom_list Sample Url:

1.37 process_custom_list Sample XML Output:
 



{listid}

{apikey}

{uname}

{upass}

{do}



{status}

{outputmessage}



1.37 process_custom_list Sample Json Output:
{"input":{"listid":"{listid}","apikey":"{apikey}","uname":"{uname}","upass":"{up
ass}","do":"{do}"},"output":{"status":"{status}","outputmessage":"{outputmessage
}"}}

1.37 process_custom_list Sample Php Output:
a:2:{s:5:"input";a:5:{s:6:"listid";s:8:"{listid}";s:6:"apikey";s:8:"{apikey}";s:
5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:2:"do";s:4:"{do}";}s:6:"outp
ut";a:2:{s:6:"status";s:8:"{status}";s:13:"outputmessage";s:15:"{outputmessage}"
;}}

1.38 custom_paid_submission_report Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account
doEnter the function name "custom_paid_submission_report" out here
from_dateEnter date in "yyyy-mm-dd" format. Passing this parameter will retrieve all records after this date.
siteEnter the site url or siteid for which the report is needed.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.38 custom_paid_submission_report Output Variables:
Field Name Field Description
action_date_$cntThe date of submission.
amount_paid_$cntThe cost of the directory.
description_$cntThe description used.
extra_links_used_$cntDetails of additional inner links used.
link_location_$cntLink location details if found.
note_$cntAny notes made for the submission.
outputmessageThis field will provide a detailed success/failure message.
percentage_fee_$cntThe percentage fee charged per submission.
statusSuccess/Fail
submission_fee_$cntThe fee charged per submission.
summaryA summary of submmissions done so far and submmissions outstanding on current orders in the format: ***|*** (where first number is submissions done so far and second number is submissions outstanding)
title_$cntThe title used.
url_$cntThe url of the directory submitted to.

1.38 custom_paid_submission_report - Possible Error Values:
Error Title Error Description

1.38 custom_paid_submission_report Sample Php Code:
function custom_paid_submission_report($from_date, $site, $outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=custom_paid_submission_report&outputformat=$outputformat&from_date=$from_date&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.38 custom_paid_submission_report Sample Url:

1.38 custom_paid_submission_report Sample XML Output:
 



{do}

{upass}

{uname}

{apikey}

{site}

2011-04-03



{outputmessage}

{status}

1034|200

{url_$cnt}

{title_$cnt}

{description_$cnt}

{link_location_$cnt}

{amount_paid_$cnt}

{submission_fee_$cnt}

{percentage_fee_$cnt}

{action_date_$cnt}

{note_$cnt}

{extra_links_used_$cnt}



1.38 custom_paid_submission_report Sample Json Output:
{"input":{"do":"{do}","upass":"{upass}","uname":"{uname}","apikey":"{apikey}","s
ite":"{site}","from_date":"2011-04-03"},"output":{"outputmessage":"{outputmessag
e}","status":"{status}","summary":"1034|200","url_$cnt":"{url_$cnt}","title_$cnt
":"{title_$cnt}","description_$cnt":"{description_$cnt}","link_location_$cnt":"{
link_location_$cnt}","amount_paid_$cnt":"{amount_paid_$cnt}","submission_fee_$cn
t":"{submission_fee_$cnt}","percentage_fee_$cnt":"{percentage_fee_$cnt}","action
_date_$cnt":"{action_date_$cnt}","note_$cnt":"{note_$cnt}","extra_links_used_$cn
t":"{extra_links_used_$cnt}"}}

1.38 custom_paid_submission_report Sample Php Output:
a:2:{s:5:"input";a:6:{s:2:"do";s:4:"{do}";s:5:"upass";s:7:"{upass}";s:5:"uname";
s:7:"{uname}";s:6:"apikey";s:8:"{apikey}";s:4:"site";s:6:"{site}";s:9:"from_date
";s:10:"2011-04-03";}s:6:"output";a:13:{s:13:"outputmessage";s:15:"{outputmessag
e}";s:6:"status";s:8:"{status}";s:7:"summary";s:8:"1034|200";s:8:"url_$cnt";s:10
:"{url_$cnt}";s:10:"title_$cnt";s:12:"{title_$cnt}";s:16:"description_$cnt";s:18
:"{description_$cnt}";s:18:"link_location_$cnt";s:20:"{link_location_$cnt}";s:16
:"amount_paid_$cnt";s:18:"{amount_paid_$cnt}";s:19:"submission_fee_$cnt";s:21:"{
submission_fee_$cnt}";s:19:"percentage_fee_$cnt";s:21:"{percentage_fee_$cnt}";s:
16:"action_date_$cnt";s:18:"{action_date_$cnt}";s:9:"note_$cnt";s:11:"{note_$cnt
}";s:21:"extra_links_used_$cnt";s:23:"{extra_links_used_$cnt}";}}

1.39 view_inner_links Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'view_inner_links' out here.
siteEnter the site url or site id for which the inner links needs to be viewed.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.39 view_inner_links Output Variables:
Field Name Field Description
errornoError No.
inner_link_id_$cntShows the inner_link_id of the particular link.
inner_title_$cntShows the title/anchor text of the particular link.
inner_url_$cntShows the url of the particular link.
no_of_links_availableShows the number of inner links available for the site.
outputmessageThis field will provide a detailed success/failure message
statusSuccess/Fail

1.39 view_inner_links - Possible Error Values:
Error Title Error Description

1.39 view_inner_links Sample Php Code:
function view_inner_links($site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=view_inner_links&outputformat=$outputformat&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.39 view_inner_links Sample Url:

1.39 view_inner_links Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{site}



{outputmessage}

{status}

{errorno}

{no_of_links_available}

{inner_link_id_$cnt}

{inner_title_$cnt}

{inner_url_$cnt}



1.39 view_inner_links Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","s
ite":"{site}"},"output":{"outputmessage":"{outputmessage}","status":"{status}","
errorno":"{errorno}","no_of_links_available":"{no_of_links_available}","inner_li
nk_id_$cnt":"{inner_link_id_$cnt}","inner_title_$cnt":"{inner_title_$cnt}","inne
r_url_$cnt":"{inner_url_$cnt}"}}

1.39 view_inner_links Sample Php Output:
a:2:{s:5:"input";a:5:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:4:"site";s:6:"{site}";}s:6:"output";
a:7:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"status";s:8:"{status}";s:7
:"errorno";s:9:"{errorno}";s:21:"no_of_links_available";s:23:"{no_of_links_avail
able}";s:18:"inner_link_id_$cnt";s:20:"{inner_link_id_$cnt}";s:16:"inner_title_$
cnt";s:18:"{inner_title_$cnt}";s:14:"inner_url_$cnt";s:16:"{inner_url_$cnt}";}}

1.40 delete_inner_link Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'delete_inner_link' out here
inner_link_idPass the inner_link_id of the link that needs to be deleted.
siteThe site url or site id.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.40 delete_inner_link Output Variables:
Field Name Field Description
errornoError No.
inner_links_availableA number of inner links available for the site after the deletion.
inner_link_idA confirmation of the inner_link_id deleted.
outputmessageThis field will provide a detailed success/failure message
statusSuccess/Fail

1.40 delete_inner_link - Possible Error Values:
Error Title Error Description

1.40 delete_inner_link Sample Php Code:
function delete_inner_link($inner_link_id, $site, $outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=delete_inner_link&outputformat=$outputformat&inner_link_id=$inner_link_id&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.40 delete_inner_link Sample Url:

1.40 delete_inner_link Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{inner_link_id}

{site}



{outputmessage}

{status}

{errorno}

{inner_link_id}

{inner_links_available}



1.40 delete_inner_link Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","i
nner_link_id":"{inner_link_id}","site":"{site}"},"output":{"outputmessage":"{out
putmessage}","status":"{status}","errorno":"{errorno}","inner_link_id":"{inner_l
ink_id}","inner_links_available":"{inner_links_available}"}}

1.40 delete_inner_link Sample Php Output:
a:2:{s:5:"input";a:6:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:13:"inner_link_id";s:15:"{inner_link
_id}";s:4:"site";s:6:"{site}";}s:6:"output";a:5:{s:13:"outputmessage";s:15:"{out
putmessage}";s:6:"status";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:13:"inn
er_link_id";s:15:"{inner_link_id}";s:21:"inner_links_available";s:23:"{inner_lin
ks_available}";}}

1.41 add_inner_link Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'add_inner_link' out here
siteThe site id/url for which the inner link needs to be added.
titleThe title / anchor text for the link to be added.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.
urlThe url of the inner link to be added.

1.41 add_inner_link Output Variables:
Field Name Field Description
errornoError No.
inner_links_availableThe number of inner links available after adding this link.
inner_link_idThe inner_link_id of the newly added link.
outputmessageThis field will provide a detailed success/failure message
statusSuccess/Fail

1.41 add_inner_link - Possible Error Values:
Error Title Error Description

1.41 add_inner_link Sample Php Code:
function add_inner_link($site, $title, $url, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=add_inner_link&outputformat=$outputformat&site=$site&title=$title&url=$url";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.41 add_inner_link Sample Url:

1.41 add_inner_link Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{title}

{url}

{site}



{outputmessage}

{status}

{errorno}

{inner_link_id}

{inner_links_available}



1.41 add_inner_link Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","t
itle":"{title}","url":"{url}","site":"{site}"},"output":{"outputmessage":"{outpu
tmessage}","status":"{status}","errorno":"{errorno}","inner_link_id":"{inner_lin
k_id}","inner_links_available":"{inner_links_available}"}}

1.41 add_inner_link Sample Php Output:
a:2:{s:5:"input";a:7:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:5:"title";s:7:"{title}";s:3:"url";s:
5:"{url}";s:4:"site";s:6:"{site}";}s:6:"output";a:5:{s:13:"outputmessage";s:15:"
{outputmessage}";s:6:"status";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:13:
"inner_link_id";s:15:"{inner_link_id}";s:21:"inner_links_available";s:23:"{inner
_links_available}";}}

1.42 delay_submissions Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
delay_minutesEnter the number of minutes by which you'd like to delay the submissions from starting, e.g. to delay by 1 day you would enter 1440
doEnter the name of the function 'delay_submissions' out here
transactionidEnter the transactionid that needs to be delayed.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.42 delay_submissions Output Variables:
Field Name Field Description
errornoError No.
outputmessageThis field will provide a detailed success/failure message
statusSuccess/Fail
submissions_affectedWill show how many submissions were successfully delayed for the order.
transactionidA confirmation of the transactionid delayed.

1.42 delay_submissions - Possible Error Values:
Error Title Error Description

1.42 delay_submissions Sample Php Code:
function delay_submissions($delay_minutes, $transactionid, $outputformat='json', $print_query=false)

{ 
  $this->query =
"do=delay_submissions&outputformat=$outputformat&delay_minutes=$delay_minutes&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.42 delay_submissions Sample Url:

1.42 delay_submissions Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{transactionid}

1440



{outputmessage}

{status}

{errorno}

{transactionid}

1200



1.42 delay_submissions Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","t
ransactionid":"{transactionid}","delay_minutes":"1440"},"output":{"outputmessage
":"{outputmessage}","status":"{status}","errorno":"{errorno}","transactionid":"{
transactionid}","submissions_affected":"1200"}}

1.42 delay_submissions Sample Php Output:
a:2:{s:5:"input";a:6:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:13:"transactionid";s:15:"{transactio
nid}";s:13:"delay_minutes";s:4:"1440";}s:6:"output";a:5:{s:13:"outputmessage";s:
15:"{outputmessage}";s:6:"status";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s
:13:"transactionid";s:15:"{transactionid}";s:20:"submissions_affected";s:4:"1200
";}}

1.43 sm_add_site Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
descriptionEnter a description to be used for the submissions. Min. 60 characters, Max. 255 characters.
doEnter the name of the function 'sm_add_site' out here
keywordsEnter a list of keywords/key phrases for the site, separated by commas. Min. 10 characters, Max. 40 characters.
siteEnter the url for the site.
titleEnter a title to be used for the submissions. Min. 4 characters, Max. 60 characters.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.43 sm_add_site Output Variables:
Field Name Field Description
errornoError No.
outputmessageThis field will provide a detailed success/failure message
siteidProvides the siteid for the newly added site, this siteid variable is needed to be used for the ordering function.
statusSuccess/Fail

1.43 sm_add_site - Possible Error Values:
Error Title Error Description

1.43 sm_add_site Sample Php Code:
function sm_add_site($description, $keywords, $site, $title, $outputformat='json',
$print_query=false) 
{ 
  $this->query =
"do=sm_add_site&outputformat=$outputformat&description=$description&keywords=$keywords&site=$site&title=$title";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.43 sm_add_site Sample Url:

1.43 sm_add_site Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

http://www.your-url.com/page-to-be-submitted.html

{title}

{description}

{keywords}



{outputmessage}

{status}

{errorno}

{siteid}



1.43 sm_add_site Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","s
ite":"http:\/\/www.your-url.com\/page-to-be-submitted.html","title":"{title}","d
escription":"{description}","keywords":"{keywords}"},"output":{"outputmessage":"
{outputmessage}","status":"{status}","errorno":"{errorno}","siteid":"{siteid}"}}

1.43 sm_add_site Sample Php Output:
a:2:{s:5:"input";a:8:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:4:"site";s:49:"http://www.your-url.c
om/page-to-be-submitted.html";s:5:"title";s:7:"{title}";s:11:"description";s:13:
"{description}";s:8:"keywords";s:10:"{keywords}";}s:6:"output";a:4:{s:13:"output
message";s:15:"{outputmessage}";s:6:"status";s:8:"{status}";s:7:"errorno";s:9:"{
errorno}";s:6:"siteid";s:8:"{siteid}";}}

1.44 sm_edit_site Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_edit_site' out here
keywordsList of keywords separated by comma. Min. 10 characters, Max. 40 characters. Do not pass the parameter if no editing is required for this field.
siteEnter the siteid or the site url
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.44 sm_edit_site Output Variables:
Field Name Field Description
errornoError No.
outputmessageThis field will provide a detailed success/failure message
siteidA confirmation of the siteid that was edited.
statusSuccess/Fail

1.44 sm_edit_site - Possible Error Values:
Error Title Error Description

1.44 sm_edit_site Sample Php Code:
function sm_edit_site($keywords, $site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=sm_edit_site&outputformat=$outputformat&keywords=$keywords&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.44 sm_edit_site Sample Url:

1.44 sm_edit_site Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{site}

{keywords}



{outputmessage}

{status}

{errorno}

{siteid}



1.44 sm_edit_site Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","s
ite":"{site}","keywords":"{keywords}"},"output":{"outputmessage":"{outputmessage
}","status":"{status}","errorno":"{errorno}","siteid":"{siteid}"}}

1.44 sm_edit_site Sample Php Output:
a:2:{s:5:"input";a:6:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:4:"site";s:6:"{site}";s:8:"keywords"
;s:10:"{keywords}";}s:6:"output";a:4:{s:13:"outputmessage";s:15:"{outputmessage}
";s:6:"status";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:6:"siteid";s:8:"{s
iteid}";}}

1.45 sm_submit_sites Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_submit_sites' out here
no_of_directoriesEnter the no of directories you want to submit to. Enter "all" to submit to all remaining directories.
prLeave blank to submit to all directories, sorted by higher PR first. It can be set to a number between 0-3. Example: Setting it to '2' would have the order submitted to all directories of a PR 2 and higher.
siteEnter the siteid or the site url which needs to be submitted.
speedEnter the number of weeks over which you'd like the submissions distributed. Can choose between 2-5. Leaving blank or setting it at 1 will have the submissions complete in the quickest time frame possible.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.45 sm_submit_sites Output Variables:
Field Name Field Description
availablemxShows the amount of $MX available in the user's account.
errornoError No.
no_of_directories_submitted_toDisplays the total number of directories the site will be submitted to.
outputmessageThis field will provide a detailed success/failure message
siteidA confirmation of the siteid for which the order has been placed, this siteid will need to be passed to the next function 'ordersite' to complete the order.
statusSuccess/Fail
total_costThe total price payable on the order.
transactionidThe transactionid generated for this order. You will need to use this transactionid variable in the ordersite function to complete the order.

1.45 sm_submit_sites - Possible Error Values:
Error Title Error Description

1.45 sm_submit_sites Sample Php Code:
function sm_submit_sites($no_of_directories, $pr, $site, $speed, $outputformat='json',
$print_query=false) 
{ 
  $this->query =
"do=sm_submit_sites&outputformat=$outputformat&no_of_directories=$no_of_directories&pr=$pr&site=$site&speed=$speed";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.45 sm_submit_sites Sample Url:

1.45 sm_submit_sites Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{site}

{pr}

{no_of_directories}

{speed}



{outputmessage}

{status}

{errorno}

{availablemx}

{no_of_directories_submitted_to}

{siteid}

{total_cost}

{transactionid}



1.45 sm_submit_sites Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","s
ite":"{site}","pr":"{pr}","no_of_directories":"{no_of_directories}","speed":"{sp
eed}"},"output":{"outputmessage":"{outputmessage}","status":"{status}","errorno"
:"{errorno}","availablemx":"{availablemx}","no_of_directories_submitted_to":"{no
_of_directories_submitted_to}","siteid":"{siteid}","total_cost":"{total_cost}","
transactionid":"{transactionid}"}}

1.45 sm_submit_sites Sample Php Output:
a:2:{s:5:"input";a:8:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:4:"site";s:6:"{site}";s:2:"pr";s:4:"
{pr}";s:17:"no_of_directories";s:19:"{no_of_directories}";s:5:"speed";s:7:"{spee
d}";}s:6:"output";a:8:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"status";
s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:11:"availablemx";s:13:"{available
mx}";s:30:"no_of_directories_submitted_to";s:32:"{no_of_directories_submitted_to
}";s:6:"siteid";s:8:"{siteid}";s:10:"total_cost";s:12:"{total_cost}";s:13:"trans
actionid";s:15:"{transactionid}";}}

1.46 sm_order_site Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_order_site' out here
transactionidPass the transactionid for which the order is being completed.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.46 sm_order_site Output Variables:
Field Name Field Description
availablemxShow $MX balance after the order.
errornoError No.
mxusedA confirmation of the $MX credits used for this order.
outputmessageThis field will provide a detailed success/failure message
statusSuccess/Fail
transactionidA confirmation of the transactionid for this order.

1.46 sm_order_site - Possible Error Values:
Error Title Error Description

1.46 sm_order_site Sample Php Code:
function sm_order_site($transactionid, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=sm_order_site&outputformat=$outputformat&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.46 sm_order_site Sample Url:

1.46 sm_order_site Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{transactionid}



{outputmessage}

{status}

{errorno}

{availablemx}

{mxused}

{transactionid}



1.46 sm_order_site Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","t
ransactionid":"{transactionid}"},"output":{"outputmessage":"{outputmessage}","st
atus":"{status}","errorno":"{errorno}","availablemx":"{availablemx}","mxused":"{
mxused}","transactionid":"{transactionid}"}}

1.46 sm_order_site Sample Php Output:
a:2:{s:5:"input";a:5:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:13:"transactionid";s:15:"{transactio
nid}";}s:6:"output";a:6:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"status
";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:11:"availablemx";s:13:"{availab
lemx}";s:6:"mxused";s:8:"{mxused}";s:13:"transactionid";s:15:"{transactionid}";}
}

1.47 sm_get_directories_info Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_get_directories_info' out here
outputformatChoose either xml,json or php as the preferred output format
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.47 sm_get_directories_info Output Variables:
Field Name Field Description
directoryinfoA break-up of the number of directories in the format given in the example.
errornoError No.
outputmessageThis field will provide a detailed success/failure message
pr0Shows the number of PR0 directories. Similarly the fields pr1 to pr10 show the number of directories under the respective PR. If there are 0 directories under a particular PR, then the field will not be displayed.
statusSuccess/Fail
totalShows the total number of directories in our list.

1.47 sm_get_directories_info - Possible Error Values:
Error Title Error Description

1.47 sm_get_directories_info Sample Php Code:
function sm_get_directories_info( $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=sm_get_directories_info&outputformat=$outputformat";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.47 sm_get_directories_info Sample Url:

1.47 sm_get_directories_info Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{outputformat}



{outputmessage}

{status}

{errorno}

{directoryinfo}

{pr0}

{total}



1.47 sm_get_directories_info Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","o
utputformat":"{outputformat}"},"output":{"outputmessage":"{outputmessage}","stat
us":"{status}","errorno":"{errorno}","directoryinfo":"{directoryinfo}","pr0":"{p
r0}","total":"{total}"}}

1.47 sm_get_directories_info Sample Php Output:
a:2:{s:5:"input";a:5:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:12:"outputformat";s:14:"{outputforma
t}";}s:6:"output";a:6:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"status";
s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:13:"directoryinfo";s:15:"{directo
ryinfo}";s:3:"pr0";s:5:"{pr0}";s:5:"total";s:7:"{total}";}}

1.48 sm_get_site_list Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_get_site_list' out here
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.48 sm_get_site_list Output Variables:
Field Name Field Description
detailsA list of all the sites in the account in the following format: siteid,site url,site status(active/inactive); The 3 values for each site are separated by commas and each site is separated from the other with a semi-colon.
errornoError No.
no_of_sites_availableShows the number of active/inactive sites in the account.
outputmessageThis field will provide a detailed success/failure message
statusSuccess/Fail
useridA confirmation of the userid for which the output is being shown.

1.48 sm_get_site_list - Possible Error Values:
Error Title Error Description

1.48 sm_get_site_list Sample Php Code:
function sm_get_site_list( $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=sm_get_site_list&outputformat=$outputformat";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.48 sm_get_site_list Sample Url:

1.48 sm_get_site_list Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}



{outputmessage}

{status}

{errorno}
{details}
{no_of_sites_available} {userid}

1.48 sm_get_site_list Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}"},"
output":{"outputmessage":"{outputmessage}","status":"{status}","errorno":"{error
no}","details":"{details}","no_of_sites_available":"{no_of_sites_available}","us
erid":"{userid}"}}

1.48 sm_get_site_list Sample Php Output:
a:2:{s:5:"input";a:4:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";}s:6:"output";a:6:{s:13:"outputmessage
";s:15:"{outputmessage}";s:6:"status";s:8:"{status}";s:7:"errorno";s:9:"{errorno
}";s:7:"details";s:9:"{details}";s:21:"no_of_sites_available";s:23:"{no_of_sites
_available}";s:6:"userid";s:8:"{userid}";}}

1.49 sm_add_title_description Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
descriptionEnter a description for the site. Min. 60 characters, Max. 255 characters.
distribution_ratioIf you would like this title used more or less often than the other titles, then use this figure. By default, it remains at 10. If there's another title set to 5, this title will then be submitted twice as many times as the other title.
doEnter the name of the function 'sm_add_title_description' out here
siteEnter the siteid or the site url
titleEnter the title for the site. Min. 4 characters, Max.60 characters.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.49 sm_add_title_description Output Variables:
Field Name Field Description
errornoError No.
outputmessageThis field will provide a detailed success/failure message
statusSuccess/Fail
tdidProvides the unique id associated with this title and description.
title_description_countShows number of titles and descriptions available in the site

1.49 sm_add_title_description - Possible Error Values:
Error Title Error Description

1.49 sm_add_title_description Sample Php Code:
function sm_add_title_description($description, $distribution_ratio, $site, $title,
$outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=sm_add_title_description&outputformat=$outputformat&description=$description&distribution_ratio=$distribution_ratio&site=$site&title=$title";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.49 sm_add_title_description Sample Url:

1.49 sm_add_title_description Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{site}

{title}

{description}

{distribution_ratio}



{outputmessage}

{status}

{errorno}

{tdid}

{title_description_count}



1.49 sm_add_title_description Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","s
ite":"{site}","title":"{title}","description":"{description}","distribution_rati
o":"{distribution_ratio}"},"output":{"outputmessage":"{outputmessage}","status":
"{status}","errorno":"{errorno}","tdid":"{tdid}","title_description_count":"{tit
le_description_count}"}}

1.49 sm_add_title_description Sample Php Output:
a:2:{s:5:"input";a:8:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:4:"site";s:6:"{site}";s:5:"title";s:
7:"{title}";s:11:"description";s:13:"{description}";s:18:"distribution_ratio";s:
20:"{distribution_ratio}";}s:6:"output";a:5:{s:13:"outputmessage";s:15:"{outputm
essage}";s:6:"status";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:4:"tdid";s:
6:"{tdid}";s:23:"title_description_count";s:25:"{title_description_count}";}}

1.50 sm_get_site_info Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_get_site_info' out here
siteEnter the siteid or the site url for which you want to get the information
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.50 sm_get_site_info Output Variables:
Field Name Field Description
description_$cntdescription_1, description_2 ... the count goes up to the number of descriptions available for the site and each field displays the respective description.
distribution_ratio_$cntdistribution_ratio_1, distribution_ratio_2 ... the count goes up to the number of titles available for the site and each field displays the respective distribution ratio for each title/description combination.
errornoError No.
inactive_reasonIf a site is inactive, it will show the reason for it being inactive.
keywordsShows the keywords mentioned for this site.
outputmessageThis field will provide a detailed success/failure message
pr1plus_directories_leftShows the total number of PR1+ directories left for this site to be submitted to.
pr2plus_directories_leftShows the total number of PR2+ directories left for this site to be submitted to.
pr3plus_directories_leftShows the total number of PR3+ directories left for this site to be submitted to.
siteidThe unique id "siteid" associated with this site.
site_added_dateThe date on which the site was added.
site_urlDisplays the website url
statusSuccess/Fail
title_$cnttitle_1, title_2 ... the count goes up to the number of titles available for the site and each field displays the respective title.
title_description_countShows the number of titles and descriptions available for this site.
total_directories_leftShows the total number of directories left for this site to be submitted to.
website_statusShows whether a site is Active or Inactive. Inactive sites cannot be ordered for and if there are submissions pending, they will be on hold till it's active again.

1.50 sm_get_site_info - Possible Error Values:
Error Title Error Description

1.50 sm_get_site_info Sample Php Code:
function sm_get_site_info($site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=sm_get_site_info&outputformat=$outputformat&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.50 sm_get_site_info Sample Url:

1.50 sm_get_site_info Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{site}



{outputmessage}

{status}

{errorno}

{description_$cnt}

{title_$cnt}

{title_description_count}

{distribution_ratio_$cnt}

{keywords}

{inactive_reason}

{pr1plus_directories_left}

{pr2plus_directories_left}

{pr3plus_directories_left}

{siteid}

{site_added_date}

{site_url}

{total_directories_left}

{website_status}



1.50 sm_get_site_info Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","s
ite":"{site}"},"output":{"outputmessage":"{outputmessage}","status":"{status}","
errorno":"{errorno}","description_$cnt":"{description_$cnt}","title_$cnt":"{titl
e_$cnt}","title_description_count":"{title_description_count}","distribution_rat
io_$cnt":"{distribution_ratio_$cnt}","keywords":"{keywords}","inactive_reason":"
{inactive_reason}","pr1plus_directories_left":"{pr1plus_directories_left}","pr2p
lus_directories_left":"{pr2plus_directories_left}","pr3plus_directories_left":"{
pr3plus_directories_left}","siteid":"{siteid}","site_added_date":"{site_added_da
te}","site_url":"{site_url}","total_directories_left":"{total_directories_left}"
,"website_status":"{website_status}"}}

1.50 sm_get_site_info Sample Php Output:
a:2:{s:5:"input";a:5:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:4:"site";s:6:"{site}";}s:6:"output";
a:17:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"status";s:8:"{status}";s:
7:"errorno";s:9:"{errorno}";s:16:"description_$cnt";s:18:"{description_$cnt}";s:
10:"title_$cnt";s:12:"{title_$cnt}";s:23:"title_description_count";s:25:"{title_
description_count}";s:23:"distribution_ratio_$cnt";s:25:"{distribution_ratio_$cn
t}";s:8:"keywords";s:10:"{keywords}";s:15:"inactive_reason";s:17:"{inactive_reas
on}";s:24:"pr1plus_directories_left";s:26:"{pr1plus_directories_left}";s:24:"pr2
plus_directories_left";s:26:"{pr2plus_directories_left}";s:24:"pr3plus_directori
es_left";s:26:"{pr3plus_directories_left}";s:6:"siteid";s:8:"{siteid}";s:15:"sit
e_added_date";s:17:"{site_added_date}";s:8:"site_url";s:10:"{site_url}";s:22:"to
tal_directories_left";s:24:"{total_directories_left}";s:14:"website_status";s:16
:"{website_status}";}}

1.51 sm_submission_summary Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_submission_summary' out here
pending_transaction_detailsOptional field to display the pending number of submissions for the site by transactionid. Value options: No (default), Yes
siteEnter the siteid or site url for which you want a submission summary report.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.51 sm_submission_summary Output Variables:
Field Name Field Description
errornoError No.
outputmessageThis field will provide a detailed success/failure message
pending_directoriesShows the number of directories that this site can still be submitted to.
pending_submissions_by_transactionIf the pending_transaction_details parameter was passed, this will return the transaction id along with the number of pending and completed submissions in the following format: "103422|200|21;103423|150|0;" (the first value denotes the transactionid, the second the number of pending submissions and the third the number of submissions completed)
siteidA confirmation of the siteid for which the report has been generated.
statusSuccess/Fail
submissions_madeShows the number of submissions that have been made till date for this site.
submissions_pendingShows the number of submissions pending on outstanding orders for this site.
urlA confirmation of the url for which the report is being shown.

1.51 sm_submission_summary - Possible Error Values:
Error Title Error Description

1.51 sm_submission_summary Sample Php Code:
function sm_submission_summary($pending_transaction_details, $site, $outputformat='json',
$print_query=false) 
{ 
  $this->query =
"do=sm_submission_summary&outputformat=$outputformat&pending_transaction_details=$pending_transaction_details&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.51 sm_submission_summary Sample Url:

1.51 sm_submission_summary Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

no/yes

{site}



{outputmessage}

{status}

{errorno}

{pending_directories}

{pending_submissions_by_transaction}

{siteid}

{submissions_made}

{submissions_pending}

{url}



1.51 sm_submission_summary Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","p
ending_transaction_details":"no\/yes","site":"{site}"},"output":{"outputmessage"
:"{outputmessage}","status":"{status}","errorno":"{errorno}","pending_directorie
s":"{pending_directories}","pending_submissions_by_transaction":"{pending_submis
sions_by_transaction}","siteid":"{siteid}","submissions_made":"{submissions_made
}","submissions_pending":"{submissions_pending}","url":"{url}"}}

1.51 sm_submission_summary Sample Php Output:
a:2:{s:5:"input";a:6:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:27:"pending_transaction_details";s:6
:"no/yes";s:4:"site";s:6:"{site}";}s:6:"output";a:9:{s:13:"outputmessage";s:15:"
{outputmessage}";s:6:"status";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:19:
"pending_directories";s:21:"{pending_directories}";s:34:"pending_submissions_by_
transaction";s:36:"{pending_submissions_by_transaction}";s:6:"siteid";s:8:"{site
id}";s:16:"submissions_made";s:18:"{submissions_made}";s:19:"submissions_pending
";s:21:"{submissions_pending}";s:3:"url";s:5:"{url}";}}

1.52 sm_submission_report Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_submission_report' out here
from_dateEnter date in "yyyy-mm-dd" format. Passing this parameter will retrieve all records after this date.
siteEnter the siteid or site url for which you want the report.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.52 sm_submission_report Output Variables:
Field Name Field Description
description_$cntThe description used for this particular submission. The number at the end will increment by 1 for each record, you will need to loop through the list to get all records.
directory_url_$cntThe url of the directory. The number at the end will increment by 1 for each record, you will need to loop through the list to get all records.
errornoError No.
no_of_records_availableShows the number of records available in the report. Provides the number of loops you'll need to go through to retrieve each record of the report.
outputmessageThis field will provide a detailed success/failure message
siteidA confirmation of the siteid for which the report is shown.
statusSuccess/Fail
submission_date_$cntThe date on which the submission was made. The number at the end will increment by 1 for each record, you will need to loop through the list to get all records.
title_$cntThe title used for this particular submission. The number at the end will increment by 1 for each record, you will need to loop through the list to get all records.
urlA confirmation of the url for which the report is generated.

1.52 sm_submission_report - Possible Error Values:
Error Title Error Description

1.52 sm_submission_report Sample Php Code:
function sm_submission_report($from_date, $site, $outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=sm_submission_report&outputformat=$outputformat&from_date=$from_date&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.52 sm_submission_report Sample Url:

1.52 sm_submission_report Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{site}

2011-04-03



{outputmessage}

{status}

{errorno}

{url}

{siteid}

{no_of_records_available}

{title_$cnt}

{description_$cnt}

{directory_url_$cnt}

{submission_date_$cnt}



1.52 sm_submission_report Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","s
ite":"{site}","from_date":"2011-04-03"},"output":{"outputmessage":"{outputmessag
e}","status":"{status}","errorno":"{errorno}","url":"{url}","siteid":"{siteid}",
"no_of_records_available":"{no_of_records_available}","title_$cnt":"{title_$cnt}
","description_$cnt":"{description_$cnt}","directory_url_$cnt":"{directory_url_$
cnt}","submission_date_$cnt":"{submission_date_$cnt}"}}

1.52 sm_submission_report Sample Php Output:
a:2:{s:5:"input";a:6:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:4:"site";s:6:"{site}";s:9:"from_date
";s:10:"2011-04-03";}s:6:"output";a:10:{s:13:"outputmessage";s:15:"{outputmessag
e}";s:6:"status";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:3:"url";s:5:"{ur
l}";s:6:"siteid";s:8:"{siteid}";s:23:"no_of_records_available";s:25:"{no_of_reco
rds_available}";s:10:"title_$cnt";s:12:"{title_$cnt}";s:16:"description_$cnt";s:
18:"{description_$cnt}";s:18:"directory_url_$cnt";s:20:"{directory_url_$cnt}";s:
20:"submission_date_$cnt";s:22:"{submission_date_$cnt}";}}

1.53 sm_invoice_details Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_invoice_details' out here
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.53 sm_invoice_details Output Variables:
Field Name Field Description
amount_$cntThe total amount paid towards the transaction.
errornoError No.
outputmessageThis field will provide a detailed success/failure message
statusSuccess/Fail
total_no_of_transactionsShows the number of invoices available, you will need to use this number to loop through the invoice list.
transactionid_$cntShows the transactionid
transactiontime_$cntShows the transaction date.

1.53 sm_invoice_details - Possible Error Values:
Error Title Error Description

1.53 sm_invoice_details Sample Php Code:
function sm_invoice_details( $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=sm_invoice_details&outputformat=$outputformat";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.53 sm_invoice_details Sample Url:

1.53 sm_invoice_details Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}



{outputmessage}

{status}

{errorno}

{amount_$cnt}

{total_no_of_transactions}

{transactionid_$cnt}

{transactiontime_$cnt}



1.53 sm_invoice_details Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}"},"
output":{"outputmessage":"{outputmessage}","status":"{status}","errorno":"{error
no}","amount_$cnt":"{amount_$cnt}","total_no_of_transactions":"{total_no_of_tran
sactions}","transactionid_$cnt":"{transactionid_$cnt}","transactiontime_$cnt":"{
transactiontime_$cnt}"}}

1.53 sm_invoice_details Sample Php Output:
a:2:{s:5:"input";a:4:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";}s:6:"output";a:7:{s:13:"outputmessage
";s:15:"{outputmessage}";s:6:"status";s:8:"{status}";s:7:"errorno";s:9:"{errorno
}";s:11:"amount_$cnt";s:13:"{amount_$cnt}";s:24:"total_no_of_transactions";s:26:
"{total_no_of_transactions}";s:18:"transactionid_$cnt";s:20:"{transactionid_$cnt
}";s:20:"transactiontime_$cnt";s:22:"{transactiontime_$cnt}";}}

1.54 sm_invoice_specific Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_invoice_specific' out here
transactionidEnter the transactionid for which you want to retrieve the invoice details.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.54 sm_invoice_specific Output Variables:
Field Name Field Description
errornoError No.
first_nameUser/client account's first name
last_nameUser/client account's last name
mx_creditedShows the amount of $MX credited at the end of this order, if any.
mx_usedShows the amount of $MX used for this order, if any.
no_of_submissionsShows the number of submissions for this order.
order_dateThe date on which the order was placed.
order_idThe order number generated by Paypal/2CO, if paid using any of those methods.
outputmessageThis field will provide a detailed success/failure message
payment_methodShows whether the payment for this transaction was made by "Paypal", "2CO" or "MXonly"
refund_amountShows if any amount has been refunded towards this transaction.
refund_statusShows whether there was a "Partial Refund", "Full Refund" or a "Payment reversed" on this order.
special_notesShows any notes made on this order.
special_offer_detailsIf there have been any special offer discounts that have been used with this transction, they will be shown.
speed_in_weeksShows the number of weeks over which this order was chosen to be spread out. If blank, then so such option was chosen in the ordering process.
statusSuccess/Fail
submission_typeWill show type of order, typically will show "Social Bookmarking"
totalPrice paid, after deducting any $MX that may have been used.
transactionidA confirmation of the transactionid for which the invoice is being shown.
transaction_timeThe time of the transaction.
type_of_orderShows details about the type of order that was selected, whether it was to "All Directories", a set of "PR3+ Directories", etc.
unit_priceThe price per submission.
useridA confirmation of the userid for which this invoice is being shown.
websites_submittedA list of all the websites submitted under this transaction, separated by a comma.

1.54 sm_invoice_specific - Possible Error Values:
Error Title Error Description

1.54 sm_invoice_specific Sample Php Code:
function sm_invoice_specific($transactionid, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=sm_invoice_specific&outputformat=$outputformat&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.54 sm_invoice_specific Sample Url:

1.54 sm_invoice_specific Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{transactionid}



{outputmessage}

{status}

{errorno}

{first_name}

{last_name}

{mx_credited}

{mx_used}

{no_of_submissions}

{order_date}

{order_id}

{payment_method}

{refund_amount}

{refund_status}

{special_notes}

{special_offer_details}

{speed_in_weeks}

{submission_type}

{total}

{transactionid}

{transaction_time}

{type_of_order}

{unit_price}

{userid}

{websites_submitted}



1.54 sm_invoice_specific Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","t
ransactionid":"{transactionid}"},"output":{"outputmessage":"{outputmessage}","st
atus":"{status}","errorno":"{errorno}","first_name":"{first_name}","last_name":"
{last_name}","mx_credited":"{mx_credited}","mx_used":"{mx_used}","no_of_submissi
ons":"{no_of_submissions}","order_date":"{order_date}","order_id":"{order_id}","
payment_method":"{payment_method}","refund_amount":"{refund_amount}","refund_sta
tus":"{refund_status}","special_notes":"{special_notes}","special_offer_details"
:"{special_offer_details}","speed_in_weeks":"{speed_in_weeks}","submission_type"
:"{submission_type}","total":"{total}","transactionid":"{transactionid}","transa
ction_time":"{transaction_time}","type_of_order":"{type_of_order}","unit_price":
"{unit_price}","userid":"{userid}","websites_submitted":"{websites_submitted}"}}

1.54 sm_invoice_specific Sample Php Output:
a:2:{s:5:"input";a:5:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:13:"transactionid";s:15:"{transactio
nid}";}s:6:"output";a:24:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"statu
s";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:10:"first_name";s:12:"{first_n
ame}";s:9:"last_name";s:11:"{last_name}";s:11:"mx_credited";s:13:"{mx_credited}"
;s:7:"mx_used";s:9:"{mx_used}";s:17:"no_of_submissions";s:19:"{no_of_submissions
}";s:10:"order_date";s:12:"{order_date}";s:8:"order_id";s:10:"{order_id}";s:14:"
payment_method";s:16:"{payment_method}";s:13:"refund_amount";s:15:"{refund_amoun
t}";s:13:"refund_status";s:15:"{refund_status}";s:13:"special_notes";s:15:"{spec
ial_notes}";s:21:"special_offer_details";s:23:"{special_offer_details}";s:14:"sp
eed_in_weeks";s:16:"{speed_in_weeks}";s:15:"submission_type";s:17:"{submission_t
ype}";s:5:"total";s:7:"{total}";s:13:"transactionid";s:15:"{transactionid}";s:16
:"transaction_time";s:18:"{transaction_time}";s:13:"type_of_order";s:15:"{type_o
f_order}";s:10:"unit_price";s:12:"{unit_price}";s:6:"userid";s:8:"{userid}";s:18
:"websites_submitted";s:20:"{websites_submitted}";}}

1.55 sm_delete_title_description Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_delete_title_description' out here
siteEnter the site id or url from which you want to delete a title.
tdidEnter the tdid of the title/description that needs to be deleted.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.55 sm_delete_title_description Output Variables:
Field Name Field Description
errornoError No.
outputmessageThis field will provide a detailed success/failure message
siteidA confirmation of the siteid from which the title was deleted.
statusSuccess/Fail
tdidA confirmation of the tdid which was deleted.
title_description_countThe number of titles and descriptions remaining for the site.

1.55 sm_delete_title_description - Possible Error Values:
Error Title Error Description

1.55 sm_delete_title_description Sample Php Code:
function sm_delete_title_description($site, $tdid, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=sm_delete_title_description&outputformat=$outputformat&site=$site&tdid=$tdid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.55 sm_delete_title_description Sample Url:

1.55 sm_delete_title_description Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{tdid}

{site}



{outputmessage}

{status}

{errorno}

{title_description_count}

{tdid}

{siteid}



1.55 sm_delete_title_description Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","t
did":"{tdid}","site":"{site}"},"output":{"outputmessage":"{outputmessage}","stat
us":"{status}","errorno":"{errorno}","title_description_count":"{title_descripti
on_count}","tdid":"{tdid}","siteid":"{siteid}"}}

1.55 sm_delete_title_description Sample Php Output:
a:2:{s:5:"input";a:6:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:4:"tdid";s:6:"{tdid}";s:4:"site";s:6
:"{site}";}s:6:"output";a:6:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"st
atus";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:23:"title_description_count
";s:25:"{title_description_count}";s:4:"tdid";s:6:"{tdid}";s:6:"siteid";s:8:"{si
teid}";}}

1.56 sm_transaction_status Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_transaction_status' out here
transactionidEnter the transactionid for which you want to fetch the status.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.56 sm_transaction_status Output Variables:
Field Name Field Description
errornoError No.
incomplete_reasonTells whether payment was never completed or a refund was made on the order.
mail_sentWhether a submission completion mail was sent to the registered email address.
mx_creditedThe $MX credited to the account at the end of the order.
no_of_sites_orderedThe number of sites for which an order was placed under this transaction.
outputmessageThis field will provide a detailed success/failure message
siteid_$cntThe siteid for which the order was placed. A looping variable going on to cover all the sites ordered under the transaction.
statusSuccess/Fail
submissions_complete_$cntThe number of submissions finally made for the respective site. If the submissions for the site are not completely done as yet, the output will show as "Not yet complete"
submissions_ordered_$cntThe number of submissions ordered for the respective site.
transactionidThe transactionid fetched.
transaction_statusWill show either "Complete" for an order where all the submissions have been made, "Pending" for an order that is still underway, "Incomplete" for an order that was never completely paid for or was refunded.
type_of_orderShows the type of order

1.56 sm_transaction_status - Possible Error Values:
Error Title Error Description

1.56 sm_transaction_status Sample Php Code:
function sm_transaction_status($transactionid, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=sm_transaction_status&outputformat=$outputformat&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.56 sm_transaction_status Sample Url:

1.56 sm_transaction_status Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{transactionid}



{outputmessage}

{status}

{errorno}

{incomplete_reason}

{mail_sent}

{mx_credited}

{no_of_sites_ordered}

{siteid_$cnt}

{submissions_complete_$cnt}

{submissions_ordered_$cnt}

{transactionid}

{transaction_status}

{type_of_order}



1.56 sm_transaction_status Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","t
ransactionid":"{transactionid}"},"output":{"outputmessage":"{outputmessage}","st
atus":"{status}","errorno":"{errorno}","incomplete_reason":"{incomplete_reason}"
,"mail_sent":"{mail_sent}","mx_credited":"{mx_credited}","no_of_sites_ordered":"
{no_of_sites_ordered}","siteid_$cnt":"{siteid_$cnt}","submissions_complete_$cnt"
:"{submissions_complete_$cnt}","submissions_ordered_$cnt":"{submissions_ordered_
$cnt}","transactionid":"{transactionid}","transaction_status":"{transaction_stat
us}","type_of_order":"{type_of_order}"}}

1.56 sm_transaction_status Sample Php Output:
a:2:{s:5:"input";a:5:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:13:"transactionid";s:15:"{transactio
nid}";}s:6:"output";a:13:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"statu
s";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:17:"incomplete_reason";s:19:"{
incomplete_reason}";s:9:"mail_sent";s:11:"{mail_sent}";s:11:"mx_credited";s:13:"
{mx_credited}";s:19:"no_of_sites_ordered";s:21:"{no_of_sites_ordered}";s:11:"sit
eid_$cnt";s:13:"{siteid_$cnt}";s:25:"submissions_complete_$cnt";s:27:"{submissio
ns_complete_$cnt}";s:24:"submissions_ordered_$cnt";s:26:"{submissions_ordered_$c
nt}";s:13:"transactionid";s:15:"{transactionid}";s:18:"transaction_status";s:20:
"{transaction_status}";s:13:"type_of_order";s:15:"{type_of_order}";}}

1.57 sm_cancel_order Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_cancel_order' out here
transactionidPass the transactionid that needs to be deleted.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.57 sm_cancel_order Output Variables:
Field Name Field Description
errornoError No.
outputmessageThis field will provide a detailed success/failure message. On success, it will state that the order was successfully deleted and show the amount of $MX credited. It could fail if, 1) the order was already deleted previously, 2) it's not a valid transactionid, 3) the order is already underway in which case you'd need to call the cancel_remaining_submissions function or 4) the order was never completely paid for in the first place.
statusSuccess/Fail

1.57 sm_cancel_order - Possible Error Values:
Error Title Error Description

1.57 sm_cancel_order Sample Php Code:
function sm_cancel_order($transactionid, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=sm_cancel_order&outputformat=$outputformat&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.57 sm_cancel_order Sample Url:

1.57 sm_cancel_order Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{transactionid}



{outputmessage}

{status}

{errorno}



1.57 sm_cancel_order Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","t
ransactionid":"{transactionid}"},"output":{"outputmessage":"{outputmessage}","st
atus":"{status}","errorno":"{errorno}"}}

1.57 sm_cancel_order Sample Php Output:
a:2:{s:5:"input";a:5:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:13:"transactionid";s:15:"{transactio
nid}";}s:6:"output";a:3:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"status
";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";}}

1.58 sm_cancel_remaining_submissions Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_cancel_remaining_submissions' out here
transactionidPass the transactionid for which the remaining submissions need to be cancelled.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.58 sm_cancel_remaining_submissions Output Variables:
Field Name Field Description
errornoError No.
outputmessageThis field will provide a detailed success/failure message. On success, it will state that the remaining submissions of the order were successfully deleted and it will fail if there are no remaining submissions to be cancelled.
statusSuccess/Fail
submissions_cancelledThis field will display the number of submissions actually cancelled.

1.58 sm_cancel_remaining_submissions - Possible Error Values:
Error Title Error Description

1.58 sm_cancel_remaining_submissions Sample Php Code:
function sm_cancel_remaining_submissions($transactionid, $outputformat='json', $print_query=false) 
{ 
  $this->query =
"do=sm_cancel_remaining_submissions&outputformat=$outputformat&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.58 sm_cancel_remaining_submissions Sample Url:

1.58 sm_cancel_remaining_submissions Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{transactionid}



{outputmessage}

{status}

{errorno}

{submissions_cancelled}



1.58 sm_cancel_remaining_submissions Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","t
ransactionid":"{transactionid}"},"output":{"outputmessage":"{outputmessage}","st
atus":"{status}","errorno":"{errorno}","submissions_cancelled":"{submissions_can
celled}"}}

1.58 sm_cancel_remaining_submissions Sample Php Output:
a:2:{s:5:"input";a:5:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:13:"transactionid";s:15:"{transactio
nid}";}s:6:"output";a:4:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"status
";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:21:"submissions_cancelled";s:23
:"{submissions_cancelled}";}}

1.59 sm_reset_title_description Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_reset_title_description' out here
sitePass the siteid of the site for which the titles/descriptions need to be reset.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.59 sm_reset_title_description Output Variables:
Field Name Field Description
errornoError No.
outputmessageThis field will provide a detailed success/failure message
siteidThe siteid affected.
statusSuccess/Fail

1.59 sm_reset_title_description - Possible Error Values:
Error Title Error Description

1.59 sm_reset_title_description Sample Php Code:
function sm_reset_title_description($site, $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=sm_reset_title_description&outputformat=$outputformat&site=$site";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.59 sm_reset_title_description Sample Url:

1.59 sm_reset_title_description Sample XML Output:
 



{uname}

{upass}

{apikey}

{do}

{site}



{outputmessage}

{status}

{errorno}

{siteid}



1.59 sm_reset_title_description Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"{do}","s
ite":"{site}"},"output":{"outputmessage":"{outputmessage}","status":"{status}","
errorno":"{errorno}","siteid":"{siteid}"}}

1.59 sm_reset_title_description Sample Php Output:
a:2:{s:5:"input";a:5:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:4:"{do}";s:4:"site";s:6:"{site}";}s:6:"output";
a:4:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"status";s:8:"{status}";s:7
:"errorno";s:9:"{errorno}";s:6:"siteid";s:8:"{siteid}";}}

1.60 sm_delay_submissions Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
delay_minutesEnter the number of minutes by which you'd like to delay the submissions from starting, e.g. to delay by 1 day you would enter 1440
doEnter the name of the function 'sm_delay_submissions' out here
outputformatChoose either xml,json or php as the preferred output format
transactionidEnter the transactionid that needs to be delayed.
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.60 sm_delay_submissions Output Variables:
Field Name Field Description
errornoError No.
outputmessageThis field will provide a detailed success/failure message
statusSuccess/Fail
submissions_affectedWill show how many submissions were successfully delayed for the order.
transactionidA confirmation of the transactionid delayed.

1.60 sm_delay_submissions - Possible Error Values:
Error Title Error Description

1.60 sm_delay_submissions Sample Php Code:
function sm_delay_submissions($delay_minutes, $transactionid, $outputformat='json',
$print_query=false) 
{ 
  $this->query =
"do=sm_delay_submissions&outputformat=$outputformat&delay_minutes=$delay_minutes&transactionid=$transactionid";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.60 sm_delay_submissions Sample Url:

1.60 sm_delay_submissions Sample XML Output:
 



json

{apikey}

{uname}

{upass}

sm_delay_submissions

{delay_minutes}

{transactionid}



{outputmessage}

{status}

{errorno}

{submissions_affected}

{transactionid}



1.60 sm_delay_submissions Sample Json Output:
{"input":{"outputformat":"json","apikey":"{apikey}","uname":"{uname}","upass":"{
upass}","do":"sm_delay_submissions","delay_minutes":"{delay_minutes}","transacti
onid":"{transactionid}"},"output":{"outputmessage":"{outputmessage}","status":"{
status}","errorno":"{errorno}","submissions_affected":"{submissions_affected}","
transactionid":"{transactionid}"}}

1.60 sm_delay_submissions Sample Php Output:
a:2:{s:5:"input";a:7:{s:12:"outputformat";s:4:"json";s:6:"apikey";s:8:"{apikey}"
;s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:2:"do";s:20:"sm_delay_sub
missions";s:13:"delay_minutes";s:15:"{delay_minutes}";s:13:"transactionid";s:15:
"{transactionid}";}s:6:"output";a:5:{s:13:"outputmessage";s:15:"{outputmessage}"
;s:6:"status";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:20:"submissions_aff
ected";s:22:"{submissions_affected}";s:13:"transactionid";s:15:"{transactionid}"
;}}

1.61 sm_get_current_pricing Input Parameters:
Field Name Field Description
apikeyEnter the API key of your Account.
doEnter the name of the function 'sm_get_current_pricing' out here
outputformatChoose either xml,json or php as the preferred output format
unameEnter the username of the account to which the API key belongs.
upassPassword of the account to which the API key belongs.

1.61 sm_get_current_pricing Output Variables:
Field Name Field Description
errornoError No.
normal_submission_costThe price per submission
outputmessageThis field will provide a detailed success/failure message
statusSuccess/Fail

1.61 sm_get_current_pricing - Possible Error Values:
Error Title Error Description

1.61 sm_get_current_pricing Sample Php Code:
function sm_get_current_pricing( $outputformat='json', $print_query=false) 
{ 
  $this->query = "do=sm_get_current_pricing&outputformat=$outputformat";
  $this->res = $this->call_api($this->query, $print_query); 
  return $this->res; 
}

1.61 sm_get_current_pricing Sample Url:

1.61 sm_get_current_pricing Sample XML Output:
 



{uname}

{upass}

{apikey}

sm_get_current_pricing

json



{outputmessage}

{status}

{errorno}

{normal_submission_cost}



1.61 sm_get_current_pricing Sample Json Output:
{"input":{"uname":"{uname}","upass":"{upass}","apikey":"{apikey}","do":"sm_get_c
urrent_pricing","outputformat":"json"},"output":{"outputmessage":"{outputmessage
}","status":"{status}","errorno":"{errorno}","normal_submission_cost":"{normal_s
ubmission_cost}"}}

1.61 sm_get_current_pricing Sample Php Output:
a:2:{s:5:"input";a:5:{s:5:"uname";s:7:"{uname}";s:5:"upass";s:7:"{upass}";s:6:"a
pikey";s:8:"{apikey}";s:2:"do";s:22:"sm_get_current_pricing";s:12:"outputformat"
;s:4:"json";}s:6:"output";a:4:{s:13:"outputmessage";s:15:"{outputmessage}";s:6:"
status";s:8:"{status}";s:7:"errorno";s:9:"{errorno}";s:22:"normal_submission_cos
t";s:24:"{normal_submission_cost}";}}