DomainRegistrationResource¶

In this document:

Schema
Properties
Structures
Examples

GraphViz

Schema ¶

The considered APS type (download) extends the Resource APS type(s) and looks as follows:

{
  "name": "DomainRegistrationResource",
  "id": "http://www.ingrammicro.com/domain-management/domain-registration/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "properties": {
    "domainName": {
      "type": "string",
      "description": "Property to define if service requires domain binding.",
      "required": true,
      "readonly": true,
      "final": true
    },
    "isTransfer": {
      "type": "boolean",
      "description": "Flag to swap the setup fee with a transfer fee."
    },
    "provisioningParameters": {
      "type": "array",
      "description": "Additional parameters to pass for provisioning.",
      "items": {
        "type": "ProvisioningParameter"
      }
    }
  },
  "structures": {
    "ProvisioningParameter": {
      "type": "object",
      "properties": {
        "paramId": {
          "type": "string"
        },
        "paramValue": {
          "type": "string"
        }
      }
    }
  }
}

Properties ¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
domainName	String	Required Read Only Final
isTransfer	Boolean	Not Required
provisioningParameters	Array of ProvisioningParameter	Not Required

Structures ¶

ProvisioningParameter¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
paramId	String	Not Required
paramValue	String	Not Required

Examples ¶

Please find general description of create-read-update-delete (CRUD) operations with resources, properties, and structures respectively at:

← DomainLinkingResource

NotificationTemplate →