Get booster(s)

This GET operation retrieves a booster from the system by id or retrieves all boosters (if no id is passed in the URL). Query parameters can be used when retrieving all boosters to filter the type of boosters returned. If successful, you receive an HTTP response code of 200 as well as a JSON response body showing the requested booster information.

See HTTP response codes for other response codes.

GET /pcc/spcm/boosters/<id> OR (boosters?query-parameters)

HEADER INFO

authorisation: HTTP Basic Auth

tenant: <tenantName>

content-type: application/JSON

accept: application/JSON

By default, accept is XML. You must explicitly set accept in your header to application/JSON to receive a JSON response.

permissions: SPCM_PLAN_BOOSTER_READ_PERMISSION

URL parameters

Parameter Type Description

id

integer

The unique identifier of the booster.

Query parameters

There are two optional query parameters.

../boosters?type=<volumeORvalidity>

../boosters?type=<volumeORvalidity>&planDefinitionId=<planDefinitionId>
Parameter Type Description

type

integer

The id of the plan definition catalog.

planDefinitionId

string

A unique identifier for a plan definition which was assigned by the server upon creating the plan definition.


JSON response

The following sample shows the expected response from the above request.

{
    "id": "12",
    "type": "VOLUME",
    "amount": "5000",
    "cost": 470
}

Booster type descriptions

Field Type Description

id

integer

The unique identifier for the booster. This is assigned by the server upon creating a booster.

type

string

The type of booster desired by the user.

options

  • VOLUME which boosts data

  • VALIDITY which extends the plan

amount

string

The amount of data (or extension of plan).

VOLUME is in bytes, so you boost by the bytes you would like to increase. VALIDITY is in days, so you need to specify the number of days you wish to extend the plan by.

cost

integer

Specifies the cost of the booster.


HTTP response codes

Code Description

200

success!

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

booster 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

example
HTTP/1.1 500
{
    "message": "Internal server error - [Failed to get session information]",
    "status": "error"
}

503

request rejected due to overload