Provisioning Parameters

Special Notes:

  • Int ProvisioningDataSlotCounter: (mandatory) a number of total data slots (includes all <value>..</value> lines following after the current one) in a provisioning parameters section of the order lines in the section.
  • Int ProvisioningItemID_N: (mandatory) an ID of a provisioning item with which the following provisioning parameters are associated with.
  • Int ProvisioningParametersCounter: (mandatory) a number of provisioning parameters associated with the current provisioning item.
  • Str ProvisioningParameter: (mandatory) information required to define service parameters. For example, it is a domain name if a domain subscription is ordered, or parameters required by a registrar additionally, such as ABN/ACN for the .au zone. A provisioning parameter is submitted in the format: <ParameterName>=<ParameterValue>.

    Where:

    • <ParameterName> is a required parameter defined in a service template on which a service plan is based. This parameter can be pre-configured or added manually for some manually provisioned services, such as Blackberry, gifts, and so on. The following parameters are default for listed services.

      • Domain Registration (with or without hosting):

        • OrderOperationType: a domain operation type, applicable values are:
          • 10 for a registration
          • 20 for a renewal
          • 90 for a transfer
        • DomainID: a domain name
        • TransferKey: a transfer key which must be submitted for all operation types. It is empty for registration and renewal.

        • AdminContactID, BillingContactID, TechContactID, OwnerContactID: these parameters define the account users that will be used as the administrative, billing, personal, and technical contacts. Depending on whether you pass an existing user ID or expect the method to create a user for either of the contacts, supplementary parameters must be passed:

          • If you pass an existing user ID, the user will be assigned the corresponding contact role. No other parameters are necessary.

          • If you pass a new user ID, make sure that you also pass contact information for the new user in the ContactInfoSlot_N parameter.

            Important: LoginID is required when adding a new user as the administrative, billing, personal, or technical contact.

          For example, to use a user with ID=1 for administrative and billing information, and a user with ID 2 for technical information, the following three parameters must be passed: <AdminContactID=1>, <BillingContactID=1>, <TechContactID=2>.

        • PrimaryNSID, SecondaryNSID, ThirdNSID, FourthNSID: these four parameters must be passed if a customer wants to set domain name servers outside of CloudBlue Commerce when ordering or transferring domains. The passed parameters must adhere to these rules (otherwise, the method returns an error):
          • PrimaryNSID and SecondaryNDIS are required for the assignment of domain name servers outside of CloudBlue Commerce to take effect.
          • FourthNSID can be passed only if ThirdNSID is passed.
          • All the passed names of the name servers must be different.
          • Names of the name servers must comply with the RFC standards. For more information, please refer to https://www.rfc-editor.org/standards.
      • Hosting Service:

        DomainID: a domain name that it is used as a hosting name. The parameter is optional; it is passed if it added to a service template.

    • <ParameterValue> is a provisioning parameter value.

For services that require automatic provisioning of APS resources, the <ProvisioningParameter> must be also submitted in the <ParameterName>=<ParameterValue> format, where:

  • <ParameterName> is the aps_defaults_<serviceId> service parameter name, where <serviceId> is a user-defined name. The only requirement is that it must be unique within an order. An example of the service parameter name is aps_defaults_mso365.
  • <ParameterValue> is the JSON object representing the APS resource to be provisioned; it must be in the format required by the POST operation as explained in this section.

Service Example:

Copy 
<!-- ProvisioningDataSlotCounter -->
<value>
    <i4>3</i4>
</value>
<!-- ProvisioningItemID #0. -->
<value>
    <i4>0</i4>
</value>
<!-- ProvisioningParametersCounter for the ProvisioningItem #0 -->
<value>
    <i4>1</i4>
</value>
<!-- ProvisioningParameter #1. Domain name. Not defined. -->
<value>DomainID=</value>

Domain Registration Example (different account users specified as contacts):

Copy 
<!-- ProvisioningDataSlotCounter -->
<value>
    <i4>8</i4>
</value>
<!-- ProvisioningItemID #0. -->
<value>
    <i4>0</i4>
</value>
<!-- ProvisioningParametersCounter for the ProvisioningItem #0 -->
<value>
    <i4>6</i4>
</value>
<!-- ProvisioningParameter #1. Operation type - domain registration -->
<value>OrderOperationType=10</value>
<!-- ProvisioningParameter #2. Domain name -->
<value>DomainID=testdomain</value>
<!-- ProvisioningParameter #3. Transfer Key. 
 Transfer key should be submitted for all operation types.
 For registration and renewal - submit is empty as below -->
<value>TransferKey=</value>
<!-- ProvisioningParameter #4. Admin contact ID -->
<value>AdminContactID=0</value>
<!-- ProvisioningParameter #5. Billing contact ID -->
<value>BillingContactID=0</value>
<!-- ProvisioningParameter #6. Tech contact ID -->
<value>TechContactID=1</value>

Domain Registration Example (with specifying domain name servers outside of CloudBlue Commerce):

Copy 
<!-- ProvisioningDataSlotCounter -->
<value>
    <i4>8</i4>
</value>
<!-- ProvisioningItemID #0. -->
<value>
    <i4>0</i4>
</value>
<!-- ProvisioningParametersCounter for the ProvisioningItem #0 -->
<value>
    <i4>7</i4>
</value>
<!-- ProvisioningParameter #1. Operation type - domain registration -->
<value>OrderOperationType=10</value>
<!-- ProvisioningParameter #2. Domain name -->
<value>DomainID=testdomain</value>
<!-- ProvisioningParameter #3. Transfer Key. 
 Transfer key should be submitted for all operation types. 
 For registration and renewal - submit is empty as below -->
<value>TransferKey=</value>
<!-- ProvisioningParameter #4. The first Name Server. -->
<value>PrimaryNSID = ns1.google.com</value>
<!-- ProvisioningParameter #5. The second Name Server. -->
<value>SecondaryNSID = ns2.google.com</value>
<!-- ProvisioningParameter #6. The third Name Server. -->
<value>ThirdNSID = ns1.ascio.com</value>
<!-- ProvisioningParameter #7. The fourth Name Server. -->
<value>FourthNSID = ns2.ascio.com</value>

Domain Registration in the .com.au zone through AusRegistry Example

Copy 
<!-- ProvisioningDataSlotCounter -->
<value>
    <i4>13</i4>
</value>
<!-- ProvisioningItemID #0. -->
<value>
    <i4>0</i4>
</value>
<!-- ProvisioningParametersCounter for the ProvisioningItem #0 -->
<value>
    <i4>11</i4>
</value>
<!-- ProvisioningParameter #1. Operation type – domain registration -->
<value>OrderOperationType=10</value>
<!-- ProvisioningParameter #2. Domain name -->
<value>DomainID=bluewings</value>
<!-- ProvisioningParameter #3. Transfer Key. 
 Transfer key should be submitted for all operation types.
 For registration and renewal – submit is empty as below -->
<value>TransferKey=</value>
<!-- ProvisioningParameter #4. Registrant name -->
<value>R_NAME=John Smith</value>
<!-- ProvisioningParameter #5. Registrant ID type -->
<value>R_ID_TYPE=1</value>
<!-- ProvisioningParameter #6. Registrant ID -->
<value>R_ID=Blue wings</value>
<!-- ProvisioningParameter #7. Eligibility type -->
<value>E_TYPE=4</value>
<!-- ProvisioningParameter #8. Eligibility name -->
<value>E_NAME=Blue wings</value>
<!-- ProvisioningParameter #9. Eligibility ID type -->
<value>E_ID_TYPE=1</value>
<!-- ProvisioningParameter #10. Eligibility ID -->
<value>E_ID=Blue wings</value>
<!-- ProvisioningParameter #11. Eligibility reason -->
<value>P_REASON=1</value>

Service + Domain Registration Example (without specifying separate account users for contacts):

Copy 
<!-- ProvisioningDataSlotCounter -->
<value>
    <i4>8</i4>
</value>
<!-- ProvisioningItemID #0. -->
<value>
    <i4>0</i4>
</value>
<!-- ProvisioningParametersCounter for the ProvisioningItem #0 -->
<value>
    <i4>1</i4>
</value>
<!-- ProvisioningParameter #1. Hosting subscription name – domain name. -->
<value>DomainID=testdomain</value>
<!-- ProvisioningItemID #1. -->
<value>
    <i4>1</i4>
</value>
<!-- ProvisioningParametersCounter for the ProvisioningItem #1 -->
<value>
    <i4>3</i4>
</value>
<!-- ProvisioningParameter #1. Operation type – domain registration -->
<value>OrderOperationType=10</value>
<!-- ProvisioningParameter #2. Domain name -->
<value>DomainID=testdomain</value>
<!-- ProvisioningParameter #3. Transfer Key.
  Transfer key should be submitted for all operation types. 
  For registration and renewal – submit is empty as below -->
<value>TransferKey=</value>

Service + Resource Example:

Copy 
<!-- ProvisioningDataSlotCounter -->
<value>
    <i4>3</i4>
</value>
<!-- ProvisioningItemID #0. -->
<value>
    <i4>0</i4>
</value>
<!-- ProvisioningParametersCounter for the ProvisioningItem #0 -->
<value>
    <i4>1</i4>
</value>
<!-- ProvisioningParameter #1. Domain name. Not defined. -->
<value>DomainID=</value>

Domain Registration to Existing Subscription Example (separate account users are specified for contacts):

Copy 
<!-- ProvisioningDataSlotCounter -->
<value>
    <i4>8</i4>
</value>
<!-- ProvisioningItemID #0. -->
<value>
    <i4>0</i4>
</value>
<!-- ProvisioningParametersCounter for the ProvisioningItem #0 -->
<value>
    <i4>6</i4>
</value>
<!-- ProvisioningParameter #1. Operation type – domain registration -->
<value>OrderOperationType=10</value>
<!-- ProvisioningParameter #2. Domain name -->
<value>DomainID=testdomain</value>
<!-- ProvisioningParameter #3. Transfer Key. 
  Transfer key should be submitted for all operation types. 
  For registration and renewal – submit is empty as below -->
<value>TransferKey=</value>
<!-- ProvisioningParameter #4. Admin contact ID -->
<value>AdminContactID=1</value>
<!-- ProvisioningParameter #5. Billing contact ID -->
<value>BillingContactID=1</value>
<!-- ProvisioningParameter #6. Tech contact ID -->
<value>TechContactID=2</value>

© 2024 Ingram Micro, Inc. All Rights Reserved. Privacy Policy, Terms of Use and Legal

CloudBlue, an Ingram Micro business, uses cookies to improve the usability of our site. By continuing to use this site and/or logging in you are accepting the use of these cookies. For more information, visit our Privacy Policy.
I accept