Get list of order attributes of plan
The Get list of order attributes of plan method returns the list of additional attributes required for the services provisioning by the given plan ID of the current reseller or any of its downstream resellers.
An API token of a manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating manager's information.
The manager's API token specified in an API request determines:
- The role and access level of the manager, which determine the availability of a method.
- The current reseller and downstream resellers accessible within a method.
The Get list of order attributes of plan method can be used for services based on the following plugins:
- VSP (Vendor service plugin).
- Office365.
- MicrosoftCspProducts.
GET {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}/order_attributesArguments
Name | Parameter Type | Data type | Required/Optional | Description |
|---|---|---|---|---|
| X-Api-Token | header | string | Required | API token of a manager that performs the operation (see Viewing and updating manager's information) |
| Content-Type | header | string | Required | Media type of the request. Specify the following: application/vnd.api+json |
| Accept | header | string | Required | Supported media types of the answer. Specify the following: application/vnd.api+json |
| base_url | path | string | Required | ActivePlatform URL |
| 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 |
| account_id | query | integer | Required | ID of an account for ordering a subscription. May affect the list of additional attributes |
| plan_resource_ids[] | query | integer | Required | Coma-separated list of IDs of resources of the specified plan to be ordered in a subscription (see Create sales order). May affect the list of additional attributes |
Response model
Name | Data type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| data | array of objects | Response data | ||||||
| order_attributes | array of objects | List of additional attributes of services | ||||||
| required | bool | Indicates whether the additional attribute is required:
| ||||||
| values | array | The list of available values of the additional attribute | ||||||
label | string | Name of the additional attribute | ||||||
| type | string | Data type of the additional attribute:
| ||||||
| key | string | Key of the additional attribute | ||||||
| priority | integer | Priority of the additional attribute | ||||||
| default_value | string | Default value of the additional attribute | ||||||
| plugin_slug | string | Plugin used for the service of the additional attribute:
| ||||||
order_attributes_info | array | Not used in the current version | ||||||
| common_message | array of objects | Additional message for an order | ||||||
| key | string | Plugin used for the service:
| ||||||
| value | string | Text of a message | ||||||
Request example (Google, VSP plugin)
GET /api/v3/resellers/1/plans/1238/order_attributes?account_id=826&plan_resource_ids[]=2205
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+jsonResponse example (Google, VSP plugin)
{
"data": {
"order_attributes": [
{
"required": true,
"values": [],
"label": "Domain name",
"type": "string",
"key": "domain_name",
"priority": 1,
"default_value": "",
"plugin_slug": "vendor_service"
},
{
"required": true,
"values": [],
"label": "Alternate email",
"type": "string",
"key": "customer_alternate_email",
"priority": 2,
"default_value": "",
"plugin_slug": "vendor_service"
},
{
"required": true,
"values": [],
"label": "Admin login",
"type": "string",
"key": "admin_login",
"priority": 3,
"default_value": "",
"plugin_slug": "vendor_service"
}
],
"order_attributes_info": [],
"common_message": []
}
}Request example (Microsoft 365, Office365 plugin)
GET /api/v3/resellers/1/plans/1132/order_attributes&account_id=820&plan_resource_ids[]=1394
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+jsonResponse example (Microsoft 365, Office365 plugin)
{
"data": {
"order_attributes": [
{
"label": "Create new Microsoft Tenant Name",
"type": "boolean",
"key": "is_new_domain",
"values": [],
"priority": 1,
"default_value": "",
"plugin_slug": "office365",
"required": true
},
{
"label": "With the .onmicrosoft.com subdomain",
"type": "boolean",
"key": "with_subdomain",
"values": [],
"priority": 1,
"default_value": "",
"plugin_slug": "office365",
"required": true
},
{
"label": "Microsoft Tenant Name",
"type": "string",
"key": "customer_domain",
"values": [],
"priority": 1,
"default_value": "",
"plugin_slug": "office365",
"required": true
},
{
"label": "Accept Microsoft Customer Agreement",
"type": "checkbox",
"key": "microsoft_customer_agreement",
"values": [],
"priority": 1,
"default_value": "",
"plugin_slug": "office365",
"required": true
}
],
"order_attributes_info": [],
"common_message": [
{
"key": "office365",
"value": "Before addition of existing tenant, please confirm invitation from <a class=\"link\" href=\"https://admin.microsoft.com/Adminportal/Home?invType=ResellerRelationship&partnerId=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&msppId=0&DAP=true#/BillingAccounts/partner-invitation\">Microsoft Cloud Solution Provider</a>"
}
]
}
}