Read Subscriber

The ReadSubscriber API in OCS.io allows for retrieving subscriber details using the subscriber’s Ref ID or External ID, providing essential information for subscriber management.

API Overview

Parameters Required for Reading Subscriber

The following table lists and describes the parameters required to read a subscriber through the ReadSubscriber API:

Parameter Description

refId

Ref ID of the Subscriber.

externalId

External ID of the Subscriber.

stateHistory

Indicates whether reads also State History belonging to the Subscriber.

resources

Indicates whether reads also Resources belonging to the Subscriber.

offers

Indicates whether reads also Subscriptions belonging to the Subscriber.
Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when reading a Subscriber:

Read Subscriber Example

Here is a cURL example for the ReadSubscriber API:

curl -X GET 'https://api.ocs.io/v1/casm/subscribers/read?refId=<subscriber_ref_id>&stateHistory=true&resources=true&offers=true'

The outcome of the API call is as follows:

  • The subscriber with Ref ID <subscriber_ref_id> is retrieved.

  • If stateHistory is set to true, the state history of the subscriber is included.

  • If resources is set to true, the resources belonging to the subscriber are included.

  • If offers is set to true, the subscriptions belonging to the subscriber are included.