Get count of subscriber service state

This GET operation gets a count of subscribers by service state (in service, out of service, or obsolete). If successful, you receive an HTTP response code of 200. See HTTP response codes for other response codes.

If no query parameter is defined, a count of all subscriber service states is returned.

GET /pcc/spcm/oam/subscribers/service-state?serviceState=<service-state>

HEADER INFO

tenant: <tenantName>

authorisation: HTTP Basic Auth

accept: application/json

permissions: SPCM_OAM_READ_PERMISSION


Query parameters

Parameter Type Description

serviceState

string

The service state of the subscriber(s) from which you want a count returned.

options

  • IN_SERVICE = the subscriber is in service and treated as operational.

  • OUT_OF_SERVICE = the subscriber is out of service and treated as non-operational.

  • OBSOLETE = the subscriber is out of service and treated as non-operational; the subscriber can be deleted from the database in this service-state.


JSON response

The example below is a typical response for getting OUT_OF_SERVICE subscribers. The response returns the <service-state> with the value being an integer of the count of subscribers in that state.

{
  "OUT_OF_SERVICE" : 42
}

SPCM O&M type descriptions

These are the JSON key-value pair descriptions for the SPCM OM API operations.

Field Type Description

msisdnPrefixes

string

A list of MSISDN prefixes of subscribers to match.

invertMatch

boolean

A flag indicating if the inverse of the match should occur.

If set to true, all MSISDNs that do not match the prefixes listed in msisdnPrefixes will have their state changed. If set to false, all prefixes listed in msisdnPrefixes will have their state changed.

serviceState

enum

Sets the service state of the listed MSISDNs.

options

  • IN_SERVICE = sets the subscriber to being in service. This is the default state of a subscriber and means the subscriber’s plans are treated as operational.

  • OUT_OF_SERVICE = sets the subscriber to being out of service. This means that any scheduled tasks for the subscriber’s plans are treated as non-operational.

  • OBSOLETE = sets the subscriber to being obsolete. This means that any scheduled tasks for the subscriber’s plans are treated as non-operational.

    Subscribers (and his/her plans) are now eligible to be deleted from the database under this state.

HTTP response codes

These are the possible HTTP response codes for the SPCM OM service-state operation.

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

subscriber 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.

422

failed processing (after passing validation).

500

internal error

503

request rejected due to overload