Validate the Reseller's Plan provisioning attributes

The Validate the Reseller's Plan provisioning attributes method is used with ordering a new Subscription for validating the values of additional attributes required for the Service provisioning by the given Plan ID of the current Reseller or any of its downstream Resellers. See also Get a List of the Reseller's Plan provisioning attributes and Create a Sales Order.

If it is necessary, during validation of the Microsoft Customer Domain Name (Tenant name) for the specified Account, the Microsoft Customer Agreement is accepted on behalf of the Manager determined by the token in the API request.

Access to the current Reseller and downstream Resellers is determined by the Manager's token in the API request.

The Validate the Reseller's Plan provisioning attributes method validates values of additional attributes only for the following Services:

 POST {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}/provisioning_attributes/validation

Arguments

Name			Parameter Type	Data type	Required/Optional	Description
X-Api-Token			header	string	Required	API token of the Manager that performs the operation (see Viewing and updating manager's information)
Content-Type			header	string	Required	Indicates the media type (text/html or text/JSON) of the request that is sent to the server by the client (browser)
Accept			header	string	Required	Information about data types that the client (browser) supports
reseller_id			path	integer	Required	ID of the current Reseller or any of its downstream Resellers (see Viewing and updating reseller general information)
plan_id			path	integer	Required	ID of the Plan
data			form	object	Required	Information about attributes of the operation
	account_id		form	integer	Required	ID of an Account used for ordering the Subscription
	attributes		form	array	Required	List of additional attributes and their values depending on the Service linked to the specified Plan
		key	form	string	Required	Key of the additional attribute
		value	form	Depends on the attribute	Required	Value of the additional attribute

Response model

Name

Data type

Description

key

string

Key of the additional attribute

value

Depends on the attribute

Value of the additional attribute

microsoft_customer_agreement

bool

Indicates whether the Microsoft Customer Agreement is accepted:

true — the Microsoft Customer Agreement is accepted.
false — the Microsoft Customer Agreement is not accepted.

Specified if, during validation of the Microsoft Customer Domain Name (Tenant name) for the specified Account, the Microsoft Customer Agreement has been accepted

Errors

Status	Error text	Comment
422	Validation is failed	An error occurred on the Vendor site. Try again later
	Plan does not have provisioning attributes	The Service linked to the specified Plan does not require validation of attributes with this API method
	Request contains two types of domains (new and exist)	To validate the Microsoft Customer Domain Name (Tenant name), specify only one of the following options: new customer domain name or existing customer domain name, not both
	Subdomain is invalid. Must be '.onmicrosoft.com'	To validate the Microsoft Customer Domain Name (Tenant name), specify a customer domain name including the '.onmicrosoft.com' (for example, example.onmicrosoft.com)
	Account already has a domain <domain> in the Microsoft network	The customer domain name specified in the request as an existing domain name is not found in the platform, but the specified Account has another domain name in the platform. To validate the existing Microsoft Customer Domain Name (Tenant name), specify <domain> as the value of the parameter of the existing customer domain name The customer domain name is specified in the request as a new domain name, but the specified Account already has a domain name in the platform. To validate the Microsoft Customer Domain Name (Tenant name), specify <domain> as the value of the parameter of the existing customer domain name
	Must be subscription to Microsoft Azure service	To validate a Subscription for the Microsoft Azure RI Service, specify an existing Subscription for the Microsoft Azure Service of the specified Account
	Account id must be the owner of subscription id

Request example (Microsoft Azure RI)

POST /api/v3/resellers/1/plans/1770/provisioning_attributes/validation
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

{
    "data": {
        "account_id": 784,
        "attributes": [
            {
                "key": "reservation_scope",
                "value": "All Subscriptions"
            },
            {
                "key": "azure_subscriptions",
                "value": [
                    "#3007831 Azure (Office365 plugin) (XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)"
                ]
            }
        ]
    }
}

Response example (Microsoft Azure RI)

[
    {
        "key": "reservation_scope",
        "value": "All Subscriptions"
    },
    {
        "key": "azure_subscriptions",
        "value": [
            "3007831 Azure (Office365 plugin) (XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)"
        ]
    }
]

Request example (Microsoft Azure, new tenant name)

POST /api/v3/resellers/1/plans/1768/provisioning_attributes/validation
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

{
    "data": {
        "account_id": 784,
        "attributes": [
            {
                "key": "new_customer_domain",
                "value": "example.onmicrosoft.com"
            }
        ]
    }
}

Response example (Microsoft Azure, new tenant name)

[
    {
        "key": "new_customer_domain",
        "value": "example.onmicrosoft.com",
        "microsoft_customer_agreement": true
    }
]