Connect

List shareable subscription rules

Production

https://api.mediaconnect.no/capi

GET

/v1/customer/product/share/rule/{productCode}

Sharing

The user needs to be logged in to use this endpoint, click here to read more.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.mediaconnect.no/capi/v1/customer/product/share/rule/'

Response Example

200 - Success

{
    "customerProductShareRules": [
        {
            "productCode": "NAT",
            "shareType": "A",
            "shareCount": 3
        }
    ]
}

Request

Authorization

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://connectid.no/user/oauth/authorize

Token URL: https://connectid.no/user/oauth/token

Refresh URL: https://connectid.no/user/oauth/token

Scopes:

read-For all access

Path Params

productCode

string

required

product code

<= 12 characters

Responses

🟢200OK

application/json

Body

customerProductShareRules

array [object {9}]

optional

productCode

string

required

Product code

<= 12 characters

shareType

string

required

The type of sharing:

A: Share with users

D: B2B share

shareCount

integer

optional

The maximum number of users for sharing the product

>= 0<= 32767

couponCodeShareRecipient

string

optional

Coupon code, applicable only to B2B.

<= 12 characters

couponNumberShareRecipient

integer

optional

Coupon number, applicable only to B2B.

isCreateConnectCustomer

boolean

optional

Informs if it is recommeneded to create connect customer when user accepts share invitation:

true: It is recommended.

false: It is not recommended.

isCustomerNameRequired

boolean

optional

Informs if it is required to specify customer name in share invitation.

true: It is required.

false: It is not required.

issuer

string

optional

If specified then consents for this issuer should be collected when user accepts share invitation.

issuerConsentGroupId

integer

optional

If specified then consents for this issuer consent group should be collected when user accepts share invitation.

🟠400Bad Request

🟠429429

🔴500Server Error

Decline share - client mode

List distribution levels