Entitle subscriber
Added by IBM contributorIBM | Edited by Vidyashri Hegde on June 30, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Entitle a subscriber to a subscription. This action assigns a seat for the subscriber in the subscription.

The API caller must have one of the following roles to run the API:

  • CustomerAdministrator
  • User
  • VSR

Table 1. API details
Method
Resource address
Operation header
POST
resource/subscriber/<subscriber_id>/subscription/<subscription_id>?acceptTOU=<true/false>
x-operation: entitleSubscriber

URL parameters


Provide the following parameters.

Table 2. Parameters

Parameter
Required
Description
subscriber_id
Yes
The ID of the subscriber. To obtain the ID, see the Get subscriber list by email address and Get subscriber list by customer ID topics.
subscription_id
Yes
The ID of the subscription. To obtain the ID, see the Get subscription list and Get subscription list by customer ID topics.
acceptTOU
No
Default value is true. The operation with ?acceptTOU=true automatically accepts TermsOfUse for the seat. Acceptable values "true" and "false" are case sensitive.
NOTE: Entitle a subscriber to notes/inotes subscription we need to add subscriber attribute dom__emailAddress(notes)/yun__emailAddress(inotes) to subscriber json.This attribute need to be added using update subscriber API before calling entitle subscriber API.

How to add subscriber attribute:Get subscriber json using API Get subscriber by ID. Add an attribute dom__emailAddress for notes subscription,yun__emailAddress for inotes subscription to SubscriberAttributeSet entry in the subscriber json response.

sample : Replace subscriber attribute with dom__emailAddress for notes subscription,yun__emailAddress for inotes subscription.

{
"StringValue": "subscriber email address",
"SubscriberId": subscriberId,
"BooleanValue": false,
"Name": "subscriber attribute",
"Type": "STRING",
"IntegerValue": 1,
}


A map that contains the seat ID and the subscription ID is returned. For example, if you post the resource/subscriber/30099153/subscription/1 resource address, the map returns a seat ID of 1244:

{

"HashMap": {

"Value": [

1244

],

"Key": [

1

]

}

}


For a list of common HTTP status codes that are returned for API calls, see HTTP status codes.

Parent topic: Subscriber management services

Input
Method URI Description
POST /api/bss/resource/subscriber/{subscriber_id}/subscription/{subscription_id} Entitle a subscriber to a subscription. This action assigns a seat for the subscriber in the subscription.
The API caller must have one of the following roles to run the API:
CustomerAdministrator
User
VSR
Content Type: text/plain
Name Type Optional Description
subscriber_id
string No The ID of the subscriber.
subscription_id
string No The ID of the subscription.
Name Type Optional Description
acceptTOU
string No Default value is false. The operation with ?acceptTOU=true automatically accepts TermsOfUse for the seat. Acceptable values "true" and "false" are case sensitive.
Name Type Optional Description
x-operation
string No entitleSubscriber
Output
Content Type: application/json
Examples
if you post the resource/subscriber/30099153/subscription/1 resource address, the map returns a seat ID of 1244

Response returned by the server
{

    "HashMap": {

        "Value":  [

            1244

        ],

        "Key":  [

            1

        ]

    }

}