Table Of Contents

Previous topic

ServicePlan

Next topic

ServiceTerms

Application Packaging Standard

Last updated 18-Mar-2019

ServicePlanCategory

Service Plan Category resource. It determines two important things about a service plan: tax category and grouping of plans by some criterion.

Schema

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

{
  "name": "ServicePlanCategory",
  "id": "http://www.odin.com/billing/ServicePlanCategory/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "relations": {
    "taxCategory": {
      "type": "http://www.odin.com/billing/TaxCategory/1.0"
    },
    "vendor": {
      "type": "http://parallels.com/aps/types/pa/account",
      "required": true
    }
  },
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "description": {
      "type": "http://aps-standard.org/types/core/i18n/1.0#MLString",
      "required": true
    }
  }
}

Properties

NAME TYPE ATTRIBUTES DEFAULT DESCRIPTION
description Multi-Language String Required   Category description
name String Required   Category name

Relationship

NAME TYPE REQUIRED DESCRIPTION
taxCategory TaxCategory No Category’s tax category
vendor PAAccount Yes Vendor - owner of this category

Examples

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