Connect

List shared subscriptions

Production

https://api.mediaconnect.no/capi

GET

/v1/subscription/shared

Subscription

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

This API will return a list of all shared products the user subscribes to with their status.

This list may be empty in cases where the user has no shared subcriptions in the system.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.mediaconnect.no/capi/v1/subscription/shared'

Response Example

200 - Success

{
    "sharedSubscriptions": [
        {
            "productCode": "CO27409",
            "stopped": false,
            "startTime": 1651010400000,
            "endTime": 1651010400000,
            "paid": false,
            "customerNumber": 22067744,
            "customerName": {
                "firstName": "Ola",
                "middleName": "Fjordstrand",
                "lastName": "Nordmann",
                "companyName": "Company International Ltd",
                "departmentName": "Support"
            },
            "shareCode": "123AFDG",
            "shareType": "USERS",
            "shareStatus": "SHARING_ENDED",
            "shareStartTime": 1659022300643,
            "shareEndTime": 1669022300643
        }
    ]
}

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

Responses

🟢200OK

application/json

Body

sharedSubscriptions

array [object {12}]

optional

productCode

string

optional

A unique code for the product

<= 12 characters

stopped

boolean

optional

Informs if the subscription is stopped.

true: The subscription is stopped.

false: The subscription is not stopped.

startTime

integer

optional

Start of the subscription period.

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

endTime

integer

optional

End of the subscription period.

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

paid

boolean

optional

Informs if the subscription period is paid.

true: The subscription period is paid.

false: The subscription period is unpaid.

customerNumber

integer

optional

Owner customer number

customerName

object (Name)

optional

shareCode

string

optional

Share code, the unique key to find given share

<= 255 characters

shareType

string

optional

The type of sharing:

USERS

B2B

shareStatus

enum<string>

optional

The status of sharing:

REQUEST_ACCEPTED: The sharing request is accepted.

SHARING_ENDED: The sharing is ended.

Allowed values:

REQUEST_ACCEPTEDSHARING_ENDED

shareStartTime

integer

optional

Start time of sharing

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC

shareEndTime

integer

optional

End time of sharing

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC

🟠400Bad Request

🟠429429

🔴500Server Error

Change distribution level

List subscriptions