Refresh

This website manage.optidigital.ca/kb/answer/2288 is currently offline. Cloudflare's Always Online™ shows a snapshot of this web page from the Internet Archive's Wayback Machine. To check for the live version, click Refresh.

Add

Description

Places a CodeGuard Order for the specified domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required The domain name for which the Order is to be placed
customer-id Integer Required The Customer under whom the Order should be added
months Integer Required The number of months for which the Order is to be placed
plan-id Integer Required The plan under which the Order should be added. To fetch the plan details i.e. plan-id etc., use this method.
auto-renew Boolean Optional

Enables / Disables the Auto Renewal setting for the Order

Note

Auto-Renewal
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.
discount-amount Float Optional Discount amount for the order value.

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/codeguard/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice&discount-amount=0.00

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Add Action (actiontypedesc)

  • Action ID of the CodeGuard Order Add Action (eaqid)

  • CodeGuard Order Add Action Status (actionstatus)

  • Description of the CodeGuard Order Add Action Status (actionstatusdesc)

  • Invoice ID of the CodeGuard Order Add Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the CodeGuard Order (customerid)

  • Discount Amount (discount-amount)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.