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.
This 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.
If 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.
If 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.
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.
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.
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.
Enter examples of categories that you would like this site listed under.
contact_email
Leave 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_name
Enter the contact person's name for this site.
country
Enter 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.
description
Enter a description to be used for the submissions. Min. 100 characters, Max. 255 characters.
do
Enter the function name "add_site" out here
keywords
Enter a list of keywords/key phrases for the site, separated by commas. Min. 20 characters, Max. 100 characters.
outputformat
Choose either xml,json or php as the preferred output format
title
Enter a title to be used for the submissions. Min. 4 characters, Max. 45 characters.
uname
Enter the username of the account to which you want to add this site.
upass
Enter the password of the account to which you want to add this site.
url
Enter the url for the site.
1.2 add_site Output Variables:
Field Name
Field Description
errorno
error no
outputmessage
This field will provide a detailed success/failure message.
siteid
Provides the siteid for the newly added site, this siteid variable is needed to be used for the ordering function.
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
1.2 add_site Sample Json Output:
{"input":{"do":"add_site","apikey":"adsfdsfdsfasdfdsafas","uname":"api_key_usern
ame","upass":"api_key_password","url":"http:\/\/www.sample-url.com","contact_nam
e":"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:3:"url";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
apikey
Enter the API key of your Account
category_preferences
Enter the category preferences for the site. Do not pass the parameter if no editing is required for this field.
contact_email
Leave 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_name
The contact name to be used for the submissions of this site. Do not pass the parameter if no editing is required for this field.
country
Country that the site targets. Do not pass the parameter if no editing is required for this field.
do
Enter the function name "edit_site" out here
keywords
List of keywords separated by comma. Min. 20 characters, Max. 100 characters. Do not pass the parameter if no editing is required for this field.
outputformat
Choose either xml,json or php as the preferred output format
profile_name
Enter 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.
site
Enter the siteid or the site url
uname
Enter the username of the account which you want to access.
{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
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
apikey
Enter the API key of your Account
do
Enter the function name "submit_sites" out here
no_of_directories
Enter the no of directories you want to submit to. Enter "all" to submit to all remaining directories.
outputformat
Choose either xml,json or php as the preferred output format
pr
Leave 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.
site
Enter the siteid or the site url which needs to be submitted.
speed
Enter 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.
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.4 submit_sites Output Variables:
Field Name
Field Description
availablemx
Shows the amount of $MX available in the user's account.
email_handling
Will show "Y" if email handling is enabled for this site and this order else will show "N"
errorno
Error No
no_of_directories_submitted_to
Displays the total number of directories the site will be submitted to.
outputmessage
Detailed success/fail message
siteid
A 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.
status
Success/Fail
total_cost
The total price payable on the order.
transactionid
The transactionid generated for this order. You will need to use this transactionid variable in the ordersite function to complete the order.
Enter the function name "get_directories_info" out here
outputformat
Choose either xml,json or php as the preferred output format
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.6 get_directories_info Output Variables:
Field Name
Field Description
directoryinfo
A break-up of the number of directories in the format given in the example.
errorno
Error No
outputmessage
Detailed success/fail message
pr0
Shows 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.
status
Success/Fail
total
Shows the total number of directories in our list.
Choose either xml,json or php as the preferred output format
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.7 get_site_list Output Variables:
Field Name
Field Description
details
A 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.
errorno
Error No
no_of_sites_available
Shows the number of active/inactive sites in the account.
outputmessage
Detailed success/fail message
status
Success/Fail
userid
A confirmation of the userid for which the output is being shown.
Enter a description for the site. Min. 100 characters, Max. 255 characters.
distribution_ratio
If 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.
do
Enter the function name "add_title_description" out here
outputformat
Choose either xml,json or php as the preferred output format
site
Enter the siteid or the site url
title
Enter the title for the site. Min. 4 characters, Max.45 characters.
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.8 add_title_description Output Variables:
Field Name
Field Description
errorno
Error No
outputmessage
Detailed success/fail message
status
Success/Fail
tdid
Provides the unique id associated with this title and description.
title_description_count
Shows number of titles and descriptions available in the site.
1.8 add_title_description - Possible Error Values:
Choose either xml,json or php as the preferred output format
site
Enter the siteid or the site url for which you want to get the information
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.9 get_site_info Output Variables:
Field Name
Field Description
category_preferences
Shows the category preferences mentioned for this site.
contact_email
Displays 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_name
Displays the name used for submissions being made for the site.
country
Name of the primary country which this site targets.
description_$cnt
description_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_$cnt
distribution_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_enabled
Shows "Yes" or "No" depending on whether or not the email handling service has been enabled or not.
errorno
Error No
group_name
Provides the name of the group under which site this site has been classified.
inactive_reason
If a site is inactive, it will show the reason for it being inactive.
keywords
Shows the keywords mentioned for this site.
outputmessage
Detailed success/fail message
pr1plus_directories_left
Shows the total number of PR1+ directories left for this site to be submitted to.
pr2plus_directories_left
Shows the total number of PR2+ directories left for this site to be submitted to.
pr3plus_directories_left
Shows the total number of PR3+ directories left for this site to be submitted to.
siteid
The unique id "siteid" associated with this site.
site_added_date
The date on which the site was added.
site_url
Displays the website url
status
Success/Fail
title_$cnt
title_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_count
Shows the number of titles and descriptions available for this site.
total_directories_left
Shows the total number of directories left for this site to be submitted to.
website_status
Shows 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.
Optional to enter the city this site targets, in case city specific address information is needed to be used for any form filling.
Country
Optional to enter the country this site targets, in case country specific address information is needed to be used for any form filling.
do
Enter the function name "create_custom_list" out here
instruction
Any instructions you'd like to mention for the url.
list_description
Optionally mention a description for the list.
list_name
Mention an existing list name/id OR a new list name for this set of urls.
outputformat
Choose either xml,json or php as the preferred output format
paid_list
State wheter this is a paid list of directories or not. State "Yes" if a paid list, else state "No", which is the default
replacelist
If 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
State
Optional to enter the State this site targets, in case state specific address information is needed to be used for any form filling.
submiturl
Enter the url of the page which should be opened directly for attempting a submission or taking desired action.
title
Enter a title or short description for this page
U1
An alernate url from the same site where a submission can be made.
U2
An alernate url from the same site where a submission can be made.
U3
An alernate url from the same site where a submission can be made.
U4
An alernate url from the same site where a submission can be made.
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
url
Enter 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
errorno
Error No
listid
Returns the list id for the list.
listname
Reconfirms the list name
outputmessage
Detailed success/fail message
replacedlist
Will show if list was replaced or not. Will show "Y" if replaced.
status
Success/Fail
userid
Returns userid for the account to which this list has been added.
Enter the function name "submit_custom_sites" out here
list
Enter the list id or list name to which you want to submit.
outputformat
Choose either xml,json or php as the preferred output format
site
Enter either the site url or the site id that needs to be submitted.
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.11 submit_custom_sites Output Variables:
Field Name
Field Description
availablemx
Shows the $MX available in the account.
errorno
Error No
no_of_directories_submitted_to
Displays the total number of directories the site will be submitted to.
price
Shows the amount payable for the transaction. Ensure that there is sufficient $MX balance before proceeding to next step.
transactionid
The transactionid generated for this order. You will need to use this transactionid variable for the order_site_for_custom function to complete the order.
Enter the function name "submission_summary" out here
outputformat
Choose either xml,json or php as the preferred output format
pending_transaction_details
Optional field to display the pending number of submissions for the site by transactionid.
site
Enter the siteid or site url for which you want a submission summary report.
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.12 submission_summary Output Variables:
Field Name
Field Description
errorno
Error No
outputmessage
Detailed success/fail message
pending_directories
Shows the number of directories that this site can still be submitted to.
pending_submissions_by_transaction
If 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)
siteid
A confirmation of the siteid for which the report has been generated.
status
Success/Fail
submissions_made
Shows the number of submissions that have been made till date for this site.
submissions_pending
Shows the number of submissions pending on outstanding orders for this site.
url
A confirmation of the url for which the report is being shown.
Enter the function name "submission_report" out here
outputformat
Choose either xml,json or php as the preferred output format
site
Enter the siteid or site url for which you want the report.
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.13 submission_report Output Variables:
Field Name
Field Description
description_$cnt
The 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_$cnt
The 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.
errorno
Error No
no_of_records_available
Shows 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.
outputmessage
Detailed success/fail message
siteid
A confirmation of the siteid for which the report is shown.
status
Success/Fail
submission_date_$cnt
The 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_$cnt
The 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.
url
A confirmation of the url for which the report is generated.
Choose either xml,json or php as the preferred output format
site
Enter the siteid or the site url
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.14 email_report Output Variables:
Field Name
Field Description
email_date_$cnt
The date we reviewed the e-mail.
errorno
Error No
from_$cnt
Shows the from email or directory url. The count goes up to the number of records available.
no_of_records_available
Shows the number of records present in the email report for this site.
outputmessage
Detailed success/fail message
status
Success/Fail
subject_$cnt
The subject line of the email. The count goes up to the number of records available.
type_of_email_$cnt
The 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.
Choose either xml,json or php as the preferred output format
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.16 get_group_list Output Variables:
Field Name
Field Description
default_profile_id
The 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_name
The name of the default profile.
errorno
Error No
no_of_profiles
Show the number of profiles/groups available in the account.
outputmessage
Detailed success/fail message
profile_id_1
The 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_1
The 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...
Enter the function name "invoice_details" out here
outputformat
Choose either xml,json or php as the preferred output format
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.18 invoice_details Output Variables:
Field Name
Field Description
amount_$cnt
The total amount paid towards the transaction.
datecreation_$cnt
The date the subscription was created.
errorno
Error No
is_subscription_$cnt
If it is a transaction that is part of a recurring subscription, it will show "Yes", else "No"
no_of_subscriptions
Shows 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.
outputmessage
Detailed success/fail message
particular_subscrid_$cnt
If an invoice is relating to a particular subscription, it will show the subscription id.
status
Success/Fail
subscrid_$cnt
The unique subscription id.
total_no_of_transactions
Shows the number of invoices available, you will need to use this number to loop through the invoice list.
Enter the function name "invoice_specific" out here
outputformat
Choose either xml,json or php as the preferred output format
transactionid
Enter the transactionid for which you want to retrieve the invoice details.
uname
Enter the username of the account to which the API key belongs.
upass
Password of the account to which the API key belongs.
1.20 invoice_specific Output Variables:
Field Name
Field Description
display_name_$cnt
If this is an invoice for a paid directory order, then it will show the name of the directory.
display_url_$cnt
If this is an invoice for a paid directory order, then it will show the url of the directory.
first_name
User/client account's first name
last_name
User/client account's last name
mx_credited
Shows the amount of $MX credited at the end of this order, if any.
mx_used
Shows the amount of $MX used for this order, if any.
no_of_submissions
Shows 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_date
The date on which the order was placed.
order_id
The order number generated by Paypal/2CO, if paid using any of those methods.
payment_method
Shows whether the payment for this transaction was made by "Paypal", "2CO" or "MXonly"
price_paid_$cnt
The price paid for the directory.
refund_amount
Shows if any amount has been refunded towards this transaction.
refund_status
Shows whether there was a "Partial Refund", "Full Refund" or a "Payment reversed" on this order.
special_notes
Shows any notes made on this order.
special_offer_details
If there have been any special offer discounts that have been used with this transction, they will be shown.
speed_in_weeks
Shows 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.
status
Success/Fail
submission_type
Will show whether this transaction was for "Normal Directory Submissions", "Paid Directories" or "Custom Submissions"
total
Price paid, after deducting any $MX that may have been used.
transactionid
A confirmation of the transactionid for which the invoice is being shown.
transaction_time
The time of the transaction.
type_of_order
Shows 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_price
The price per submission.
userid
A confirmation of the userid for which this invoice is being shown.
websites_submitted
A list of all the websites submitted under this transaction, separated by a comma.
Enter the function name "custom_submission_summary" out here
site
Enter the site id or the site url for which the submission summary is needed.
uname
Enter the username of the account to which the API key belongs.
upass
Password of the account to which the API key belongs.
1.22 custom_submission_summary Output Variables:
Field Name
Field Description
customsubmissionreport
Shows 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.
outputmessage
This field will provide a detailed success/failure message.
siteid
A confirmation of the site id for which the submission summary has been retrieved.
status
Success/Fail
url
A confirmation of the site url for which the submission summary has been retrieved.
1.22 custom_submission_summary - Possible Error Values:
Enter the directory url that this site was submitted to.
do
Enter the function name "upload_submissions" out here
site
Enter 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.
uname
Enter the username of the account to which the API key belongs.
upass
Password of the account to which the API key belongs.
1.25 upload_submissions Output Variables:
Field Name
Field Description
did
A confirmation of the did (directory's id)
directory
A confirmation of the directory url uploaded.
outputmessage
This field will provide a detailed success/failure message.
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.30 get_custom_site_info Output Variables:
Field Name
Field Description
address1
Address Line 1
address2
Address Line 2
category_preferences
Shows the category preferences mentioned for this site.
city
City
company_name
Company Name of Website's official name
contact_email
Displays 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_name
The name that will be used for submissions.
country
Country
description_$cnt
description_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_$cnt
distribution_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_enabled
Shows "Yes" or "No" depending on whether or not the email handling service has been enabled or not.
fax
Fax
group_name
The name of the group to which the site belongs.
inactive_reason
If a site is inactive, it will show the reason for it being inactive.
keywords
Shows the keywords mentioned for this site.
no_of_employees
No. of employees
phone
Phone
sales_email
The e-mail contact of the Sales person
sales_name
Contact Name for Sales
siteid
The unique id "siteid" associated with this site.
site_added_date
The date on which the site was added.
site_url
Displays the website url
state
State/Region
title_$cnt
title_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_count
Shows the number of titles and descriptions available for this site.
website_status
Shows 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_established
Year established.
zipcode
Zip / Postal Code
1.30 get_custom_site_info - Possible Error Values:
Enter the function name "transaction_status" out here
transactionid
Enter the transactionid for which you want to fetch the status.
uname
Enter the username of the account you want to access.
upass
Enter the password of the account you want to access.
1.31 transaction_status Output Variables:
Field Name
Field Description
email_handling_$cnt
Whether email handling was enabled for the site for this particular transaction. Output will either be "Yes" or "No"
errorno
Error No
incomplete_reason
Tells whether payment was never completed or a refund was made on the order.
mail_sent
Whether a submission completion mail was sent to the registered email address.
mx_credited
The $MX credited to the account at the end of the order.
no_of_sites_ordered
The number of sites for which an order was placed under this transaction.
outputmessage
Detailed success/fail message
siteid_$cnt
The siteid for which the order was placed. A looping variable going on to cover all the sites ordered under the transaction.
status
Success/Fail
submissions_complete_$cnt
The 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_$cnt
The number of submissions ordered for the respective site.
transactionid
The transactionid fetched.
transaction_status
Will 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_order
Shows the type of order, whether "Normal Directory Submissions", "Paid Directories" or "Custom" submissions.
Enter the username of the account to which the API key belongs.
upass
Password of the account to which the API key belongs.
1.32 cancel_order Output Variables:
Field Name
Field Description
outputmessage
This 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.
This 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.
status
Success/Fail
submissions_cancelled
This field will display the number of submissions actually cancelled.
1.33 cancel_remaining_submissions - Possible Error Values:
This field will provide a detailed success/failure message.
percentage_fee_$cnt
The percentage fee charged per submission.
status
Success/Fail
submission_fee_$cnt
The fee charged per submission.
summary
A 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_$cnt
The title used.
url_$cnt
The url of the directory submitted to.
1.38 custom_paid_submission_report - Possible Error Values: