Add plan definition to a catalog

This POST operation adds a plan definition to an existing plan definition catalog. If successful, you receive a response code of 200.

In order to add the plan definition to a catalog, the plan definition must be finalised.

See HTTP response codes for other response codes.

POST /pcc/spcm/planDefinitions/add-to-catalog + JSON request payload

HEADER INFO

tenant: <tenantName>

authorisation: HTTP Basic Auth

content-type: application/JSON

permissions: SPCM_PLAN_DEFINITION_UPDATE_PERMISSION

JSON request payload

You need to pass the planDefinitionName in the JSON payload along with the catalogName to which you want to add the plan definition.

Both are mandatory strings and are the only key:value pairs required.

{
    "planDefinitionName": "theGreatestPlan",
    "catalogName": "OneCallPrepaid"
}

Code Description

201/204

success!

If you receive a 204 code, you will not see a JSON response.

207

Multistatus response

Check out HTTP statuses for more details.

This is not applicable to all operations.

400

malformed request

401

unauthorised; bad username or password

403

forbidden; user does not have appropriate privileges

404

plan definition not found

409

conflict with target resource

This often occurs if the item already exists, such as a plan, group, or name.

This is not applicable to all operations.

412

failed validation; this typically means that a property was not set or a value is out of range.

example

HTTP 412
{
  "errors" : [
        {
          "field" : "name",
          "description" : "name is mandatory"
        }
    ]
}

422

failed processing (after passing validation).

example

HTTP 422
{
    "message": "Subscriber max plan count exceeded",
    "errorCode": 1
}

500

internal error

503

request rejected due to overload