Get provisioning profile(s)

This GET operation retrieves a provisioning profile or all provisioning profiles from your system. If you want to get a specific profile, pass the id parameter in the URL. Otherwise, all provisioning profiles are returned. If successful, you receive an HTTP response code of 200 as well as a JSON response body showing the requested profiles.

See HTTP response codes for other response codes.

GET /pcc/spcm/provisionProfile/<id>

HEADER INFO

tenant: <tenantName>

authorisation: HTTP Basic Auth

accept: application/hal+JSON

permissions: SPCM_PROVISION_PROFILE_READ_PERMISSION

URL parameters

There is one mandatory parameter.

Parameter Type Description

id

integer

The ID of the provisioning profile.


JSON response

The following shows a request for all provisioning profiles and returns them as an array.

If a specific profile is requested by passing the id in the URL, you will just see that profile and not the length or provisioningProfileDTOList key:value pairs. 
{
    "length": 2,
    "provisioningProfileDTOList" : [
        {
            "id": 39,
            "name": "turkeySauce",
            "defaultProfile": false,
            "locale": "en",
            "initialCorePlanName": "turkey",
            "subscriberClass": "gold",
            "subscriberType": "POSTPAID",
            "dpsEnabled": false,
            "dpsNotification": false,
            "eosNotification": false,
            "paygNotification": false
        },
                {
            "id": 55,
            "name": "chaCha",
            "defaultProfile": true,
            "locale": "en",
            "initialCorePlanName": "prepaidCORE",
            "subscriberClass": "Standard",
            "subscriberType": "PREPAID",
            "dpsEnabled": false,
            "dpsNotification": false,
            "eosNotification": false,
            "paygNotification": false
        }
    ]

}

Provisioning profile type descriptions

Field Type Description

id

integer

A unique identifier for the provisioning profile.

mandatory other than for creating a new profile

name

string

The name of the provisioning profile.

mandatory when creating a new profile

defaultProfile

boolean

Indicates if the profile is the default provisioning profile where true means it is the default profile and false means it is not.

mandatory when creating a new profile

initialCorePlanName

string

The name of the initial core plan.

locale

string

The subscriber’s language.

This is in 639-1 short code format.

subscriberClass

string

Denotes the class of the subscriber. This could be gold or platinum or some other descriptive term for the subscriber class.

subscriberType

string

Denotes the subscriber type. This is typically prepaid or postpaid.

dpsEnabled

boolean

Indicates whether the DPS is enabled.

  • true = the dps is enabled

  • false = the dps is disabled

dpsNotification

boolean

Indicates whether the subscriber receives DPS notifications or not.

  • true = the subscriber does receive DPS notifications

  • false = the subscriber does not receive DPS notifications

eosNotification

boolean

Indicates whether the subscriber receives EOS notifications or not.

  • true = the subscriber does receive EOS notifications

  • false = the subscriber does not receive EOS notifications

paygNotification

boolean

Indicates whether the subscriber receives payG notifications or not.

  • true = the subscriber does receive payG notifications

  • false = the subscriber does not receive payG notifications

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

provisioning profile 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