CustDiscountManagement¶

In this document:

Schema
Custom Operations
Structures
Examples

Schema ¶

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

{
  "name": "CustDiscountManagement",
  "id": "http://parallels.com/pa/custdiscount-management/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "access": {},
  "operations": {
    "addCustDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/create",
      "verb": "POST",
      "response": {
        "type": "CustDiscountXmlRpcResponse"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "custDiscount": {
          "kind": "body",
          "type": "CustDiscount"
        }
      }
    },
    "updateCustDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/update",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "custDiscount": {
          "kind": "body",
          "type": "CustDiscount"
        }
      }
    },
    "deleteCustDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/delete",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "deleteRequest": {
          "kind": "body",
          "type": "CustDiscountDeleteRequest"
        }
      }
    },
    "addAccountInDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/account-in-discount/create",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "accountInDiscount": {
          "kind": "body",
          "type": "AccountInDiscount"
        }
      }
    },
    "deleteAccountInDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/account-in-discount/delete",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "accountInDiscount": {
          "kind": "body",
          "type": "AccountInDiscount"
        }
      }
    },
    "addClassInDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/class-in-discount/create",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "classInDiscount": {
          "kind": "body",
          "type": "ClassInDiscount"
        }
      }
    },
    "deleteClassInDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/class-in-discount/delete",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "classInDiscount": {
          "kind": "body",
          "type": "ClassInDiscount"
        }
      }
    },
    "addPlanInDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-plan/create",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedPlan": {
          "kind": "body",
          "type": "DiscountedPlan"
        }
      }
    },
    "deletePlanInDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-plan/delete",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedPlan": {
          "kind": "body",
          "type": "DiscountedPlan"
        }
      }
    },
    "addPlanperiodInDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-planperiod/create",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedPlanperiod": {
          "kind": "body",
          "type": "DiscountedPlanPeriod"
        }
      }
    },
    "deletePlanperiodInDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-planperiod/delete",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedPlanperiod": {
          "kind": "body",
          "type": "DiscountedPlanPeriod"
        }
      }
    },
    "addResourceInDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-resource/create",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedResource": {
          "kind": "body",
          "type": "DiscountedResource"
        }
      }
    },
    "deleteResourceInDiscountXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-resource/delete",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedResource": {
          "kind": "body",
          "type": "DiscountedResource"
        }
      }
    },
    "addDiscountedProductGroupXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-product-group/create",
      "verb": "POST",
      "response": {
        "type": "DiscountedProductGroupXmlRpcResponse"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedResource": {
          "kind": "body",
          "type": "DiscountedProductGroup"
        }
      }
    },
    "updateDiscountedProductGroupXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-product-group/update",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedResource": {
          "kind": "body",
          "type": "DiscountedProductGroup"
        }
      }
    },
    "deleteDiscountedProductGroupXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-product-group/delete",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedResource": {
          "kind": "body",
          "type": "DiscountedProductGroupDeleteRequest"
        }
      }
    },
    "addDiscountedPlanInGroupXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-plan-in-group/create",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedPlan": {
          "kind": "body",
          "type": "DiscountedPlanInGroup"
        }
      }
    },
    "deleteDiscountedPlanInGroupXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-plan-in-group/delete",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedPlan": {
          "kind": "body",
          "type": "DiscountedPlanInGroup"
        }
      }
    },
    "addDiscountedPlanPeriodInGroupXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-planperiod-in-group/create",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedPlanperiod": {
          "kind": "body",
          "type": "DiscountedPlanPeriodInGroup"
        }
      }
    },
    "deleteDiscountedPlanPeriodInGroupXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-planperiod-in-group/delete",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedPlanperiod": {
          "kind": "body",
          "type": "DiscountedPlanPeriodInGroup"
        }
      }
    },
    "addDiscountedResourceInGroupXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-resource-in-group/create",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedResource": {
          "kind": "body",
          "type": "DiscountedResourceInGroup"
        }
      }
    },
    "deleteDiscountedResourceInGroupXmlrpc": {
      "path": "/custdiscount/xmlrpc/discounted-resource-in-group/delete",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "discountedResource": {
          "kind": "body",
          "type": "DiscountedResourceInGroup"
        }
      }
    }
  },
  "structures": {
    "CustDiscountXmlRpcResponse": {
      "type": "object",
      "properties": {
        "discID": {
          "type": "integer"
        }
      }
    },
    "CustDiscount": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "required": true
        },
        "type": {
          "type": "string",
          "required": true,
          "default": "NO",
          "enum": [
            "ACCOUNT_OR_CLASS",
            "PROMO_CODE",
            "ONE_TIME"
          ]
        },
        "status": {
          "type": "string",
          "required": true,
          "default": "ACTIVE",
          "enum": [
            "INACTIVE",
            "ACTIVE"
          ]
        },
        "promoCode": {
          "type": "string"
        },
        "discountPercent": {
          "type": "number"
        },
        "isForAllPlans": {
          "type": "boolean"
        },
        "isForAllResources": {
          "type": "boolean"
        },
        "groupID": {
          "type": "integer"
        },
        "priority": {
          "type": "integer"
        },
        "applicationRule": {
          "type": "string",
          "required": true,
          "default": "NO",
          "enum": [
            "SUCCESSIVE",
            "ARITHMETIC_SUM"
          ]
        }
      }
    },
    "CustDiscountDeleteRequest": {
      "type": "object",
      "properties": {
        "discID": {
          "type": "integer"
        }
      }
    },
    "AccountInDiscount": {
      "type": "object",
      "properties": {
        "discID": {
          "type": "integer"
        },
        "accountID": {
          "type": "integer"
        }
      }
    },
    "ClassInDiscount": {
      "type": "object",
      "properties": {
        "discID": {
          "type": "integer"
        },
        "classID": {
          "type": "integer"
        }
      }
    },
    "DiscountedPlan": {
      "type": "object",
      "properties": {
        "discID": {
          "type": "integer"
        },
        "planID": {
          "type": "integer"
        }
      }
    },
    "DiscountedPlanPeriod": {
      "type": "object",
      "properties": {
        "discID": {
          "type": "integer"
        },
        "planPeriodID": {
          "type": "integer"
        }
      }
    },
    "DiscountedResource": {
      "type": "object",
      "properties": {
        "discID": {
          "type": "integer"
        },
        "resourceID": {
          "type": "integer"
        }
      }
    },
    "DiscountedProductGroupXmlRpcResponse": {
      "type": "object",
      "properties": {
        "groupID": {
          "type": "integer"
        }
      }
    },
    "DiscountedProductGroup": {
      "type": "object"
    },
    "DiscountedProductGroupDeleteRequest": {
      "type": "object"
    },
    "DiscountedPlanInGroup": {
      "type": "object",
      "properties": {
        "groupID": {
          "type": "integer"
        },
        "planID": {
          "type": "integer"
        }
      }
    },
    "DiscountedPlanPeriodInGroup": {
      "type": "object",
      "properties": {
        "groupID": {
          "type": "integer"
        },
        "planPeriodID": {
          "type": "integer"
        }
      }
    },
    "DiscountedResourceInGroup": {
      "type": "object",
      "properties": {
        "groupID": {
          "type": "integer"
        },
        "resourceID": {
          "type": "integer"
        }
      }
    }
  }
}

Custom Operations ¶

OPERATION	VERB	PATH
addCustDiscountXmlrpc	POST	/custdiscount/xmlrpc/create
updateCustDiscountXmlrpc	POST	/custdiscount/xmlrpc/update
deleteCustDiscountXmlrpc	POST	/custdiscount/xmlrpc/delete
addAccountInDiscountXmlrpc	POST	/custdiscount/xmlrpc/account-in-discount/create
deleteAccountInDiscountXmlrpc	POST	/custdiscount/xmlrpc/account-in-discount/delete
addClassInDiscountXmlrpc	POST	/custdiscount/xmlrpc/class-in-discount/create
deleteClassInDiscountXmlrpc	POST	/custdiscount/xmlrpc/class-in-discount/delete
addPlanInDiscountXmlrpc	POST	/custdiscount/xmlrpc/discounted-plan/create
deletePlanInDiscountXmlrpc	POST	/custdiscount/xmlrpc/discounted-plan/delete
addPlanperiodInDiscountXmlrpc	POST	/custdiscount/xmlrpc/discounted-planperiod/create
deletePlanperiodInDiscountXmlrpc	POST	/custdiscount/xmlrpc/discounted-planperiod/delete
addResourceInDiscountXmlrpc	POST	/custdiscount/xmlrpc/discounted-resource/create
deleteResourceInDiscountXmlrpc	POST	/custdiscount/xmlrpc/discounted-resource/delete
addDiscountedProductGroupXmlrpc	POST	/custdiscount/xmlrpc/discounted-product-group/create
updateDiscountedProductGroupXmlrpc	POST	/custdiscount/xmlrpc/discounted-product-group/update
deleteDiscountedProductGroupXmlrpc	POST	/custdiscount/xmlrpc/discounted-product-group/delete
addDiscountedPlanInGroupXmlrpc	POST	/custdiscount/xmlrpc/discounted-plan-in-group/create
deleteDiscountedPlanInGroupXmlrpc	POST	/custdiscount/xmlrpc/discounted-plan-in-group/delete
addDiscountedPlanPeriodInGroupXmlrpc	POST	/custdiscount/xmlrpc/discounted-planperiod-in-group/create
deleteDiscountedPlanPeriodInGroupXmlrpc	POST	/custdiscount/xmlrpc/discounted-planperiod-in-group/delete
addDiscountedResourceInGroupXmlrpc	POST	/custdiscount/xmlrpc/discounted-resource-in-group/create
deleteDiscountedResourceInGroupXmlrpc	POST	/custdiscount/xmlrpc/discounted-resource-in-group/delete

addCustDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/create

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
custDiscount	CustDiscount

Returns

updateCustDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/update

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
custDiscount	CustDiscount

Returns

deleteCustDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/delete

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
deleteRequest	CustDiscountDeleteRequest

Returns

addAccountInDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/account-in-discount/create

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
accountInDiscount	AccountInDiscount

Returns

deleteAccountInDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/account-in-discount/delete

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
accountInDiscount	AccountInDiscount

Returns

addClassInDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/class-in-discount/create

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
classInDiscount	ClassInDiscount

Returns

deleteClassInDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/class-in-discount/delete

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
classInDiscount	ClassInDiscount

Returns

addPlanInDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-plan/create

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedPlan	DiscountedPlan

Returns

deletePlanInDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-plan/delete

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedPlan	DiscountedPlan

Returns

addPlanperiodInDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-planperiod/create

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedPlanperiod	DiscountedPlanPeriod

Returns

deletePlanperiodInDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-planperiod/delete

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedPlanperiod	DiscountedPlanPeriod

Returns

addResourceInDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-resource/create

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedResource	DiscountedResource

Returns

deleteResourceInDiscountXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-resource/delete

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedResource	DiscountedResource

Returns

addDiscountedProductGroupXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-product-group/create

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedResource	DiscountedProductGroup

Returns

updateDiscountedProductGroupXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-product-group/update

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedResource	DiscountedProductGroup

Returns

deleteDiscountedProductGroupXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-product-group/delete

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedResource	DiscountedProductGroupDeleteRequest

Returns

addDiscountedPlanInGroupXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-plan-in-group/create

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedPlan	DiscountedPlanInGroup

Returns

deleteDiscountedPlanInGroupXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-plan-in-group/delete

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedPlan	DiscountedPlanInGroup

Returns

addDiscountedPlanPeriodInGroupXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-planperiod-in-group/create

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedPlanperiod	DiscountedPlanPeriodInGroup

Returns

deleteDiscountedPlanPeriodInGroupXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-planperiod-in-group/delete

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedPlanperiod	DiscountedPlanPeriodInGroup

Returns

addDiscountedResourceInGroupXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-resource-in-group/create

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedResource	DiscountedResourceInGroup

Returns

deleteDiscountedResourceInGroupXmlrpc¶

HTTP Request

POST /aps/2/resources/{aps-id}/custdiscount/xmlrpc/discounted-resource-in-group/delete

Description

Parameters

PARAMETER	TYPE	DESCRIPTION
discountedResource	DiscountedResourceInGroup

Returns

Structures ¶

CustDiscountXmlRpcResponse¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
discID	Integer	Not Required

CustDiscount¶

NAME	TYPE	ATTRIBUTES	DEFAULT
name	String	Required
type	Enum	Required	NO
status	Enum	Required	ACTIVE
promoCode	String	Not Required
discountPercent	Number	Not Required
isForAllPlans	Boolean	Not Required
isForAllResources	Boolean	Not Required
groupID	Integer	Not Required
priority	Integer	Not Required
applicationRule	Enum	Required	NO

CustDiscountDeleteRequest¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
discID	Integer	Not Required

AccountInDiscount¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
discID	Integer	Not Required
accountID	Integer	Not Required

ClassInDiscount¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
discID	Integer	Not Required
classID	Integer	Not Required

DiscountedPlan¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
discID	Integer	Not Required
planID	Integer	Not Required

DiscountedPlanPeriod¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
discID	Integer	Not Required
planPeriodID	Integer	Not Required

DiscountedResource¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
discID	Integer	Not Required
resourceID	Integer	Not Required

DiscountedProductGroupXmlRpcResponse¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
groupID	Integer	Not Required

DiscountedProductGroup¶

DiscountedProductGroupDeleteRequest¶

DiscountedPlanInGroup¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
groupID	Integer	Not Required
planID	Integer	Not Required

DiscountedPlanPeriodInGroup¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
groupID	Integer	Not Required
planPeriodID	Integer	Not Required

DiscountedResourceInGroup¶

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
groupID	Integer	Not Required
resourceID	Integer	Not Required

Examples ¶

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← BssAccountInformation

CustomerClass →

CloudBlue Commerce API

Previous topic

Next topic

CustDiscountManagement¶

Schema¶

Custom Operations¶

addCustDiscountXmlrpc¶

updateCustDiscountXmlrpc¶

deleteCustDiscountXmlrpc¶

addAccountInDiscountXmlrpc¶

deleteAccountInDiscountXmlrpc¶

addClassInDiscountXmlrpc¶

deleteClassInDiscountXmlrpc¶

addPlanInDiscountXmlrpc¶

deletePlanInDiscountXmlrpc¶

addPlanperiodInDiscountXmlrpc¶

deletePlanperiodInDiscountXmlrpc¶

addResourceInDiscountXmlrpc¶

deleteResourceInDiscountXmlrpc¶

addDiscountedProductGroupXmlrpc¶

updateDiscountedProductGroupXmlrpc¶

deleteDiscountedProductGroupXmlrpc¶

addDiscountedPlanInGroupXmlrpc¶

deleteDiscountedPlanInGroupXmlrpc¶

addDiscountedPlanPeriodInGroupXmlrpc¶

deleteDiscountedPlanPeriodInGroupXmlrpc¶

addDiscountedResourceInGroupXmlrpc¶

deleteDiscountedResourceInGroupXmlrpc¶

Structures¶

CustDiscountXmlRpcResponse¶

CustDiscount¶

CustDiscountDeleteRequest¶

AccountInDiscount¶

ClassInDiscount¶

DiscountedPlan¶

DiscountedPlanPeriod¶

DiscountedResource¶

DiscountedProductGroupXmlRpcResponse¶

DiscountedProductGroup¶

DiscountedProductGroupDeleteRequest¶

DiscountedPlanInGroup¶

DiscountedPlanPeriodInGroup¶

DiscountedResourceInGroup¶

Examples¶

Schema ¶

Custom Operations ¶

Structures ¶

Examples ¶