Connect

List all shared subscribers

Production

https://api.mediaconnect.no/capi

GET

/v1/subscription/share

Sharing

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

This API lists all users and potiential users that have recieved a share request

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.mediaconnect.no/capi/v1/subscription/share?history&shareType'

Response Example

200 - Success

{
    "sharedUserInformationList": [
        {
            "userId": 80,
            "startTime": 1560336440000,
            "endTime": 1591958840000,
            "shareStatus": "SHARE_REQUEST_SENT",
            "shareContact": "+4712345678",
            "shareContactType": "B",
            "firstName": "John",
            "lastName": "Doe",
            "productName": "ABC magazine",
            "productCode": "ABC",
            "shareCode": "XYZ",
            "customerNumber": 28
        }
    ],
    "sharedSubscriptionSummary": [
        {
            "productCode": "ABC",
            "sharesInUseCount": 1
        }
    ]
}

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

Query Params

history

boolean

optional

true: Show full share history.

false: Show organized share history, expired or ended shares for the same contact will be comitted (only recent ones will be preserved).

Default:

true

shareType

string

optional

Share type allows you to specify which subscriptions to incude in the result:

USERS: Just user subscriptions

B2B: Just B2B subscriptions

Default:

USERS

Responses

🟢200OK

application/json

Body

sharedUserInformationList

array [object {12}]

optional

List of shared subscribers

userId

integer

optional

userId of receiver for this share.

startTime

integer

optional

Start date for share

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.

endTime

integer

optional

End date for share

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.

shareStatus

enum<string>

optional

Status for share

SHARE_REQUEST_SENT: A sharing request is sent.

REQUEST_ACCEPTED: Sharing request is accepted.

REQUEST_DECLINED: Sharing request is declined.

SHARING_ENDED: Sharing is ended.

Allowed values:

SHARE_REQUEST_SENTREQUEST_ACCEPTEDREQUEST_DECLINEDSHARING_ENDED

shareContact

string

optional

Contact information - Mail or phone number.
A phone number has to follow the telephone number standard E.164.

shareContactType

enum<string>

optional

Type of share contact

A: Email address

B: Phone number

Allowed values:

firstName

string

optional

Contact information - first name.

<= 30 characters

lastName

string

optional

Contact information - last name.

<= 30 characters

productName

string

optional

Product that is being shared

productCode

string

optional

A unique code for the product

<= 12 characters

shareCode

string

optional

Share code, the unique key to find given share

<= 256 characters

customerNumber

integer

optional

CustomerNumber of receiver for this share.

sharedSubscriptionSummary

array [object {2}]

optional

List of shared subscription summaries(how many shares is in use).

productCode

string

optional

The product code

<= 12 characters

sharesInUseCount

integer

optional

How many shares is in use.

🟠400Bad Request

🟠429429

🔴500Server Error

Change subscription share invitation details

Cancel sharing