MediaConnect AS
Powered by Redocly

Sharing

Send subscription share invitation

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

This API initiates the sharing of a subscription by sending a share request to the share recipient.

SecurityAuthorization_Code
Request
Request Body schema: application/json
contact
required
string

Email address or telephone number.
A phone number has to follow the telephone number standard E.164.

contactType
required
string
  • A_EMAIL: Email address
  • B_PHONENUMBER: Telephone number
productCode
required
string <= 12 characters

Product the subscriber wishes to share

firstName
string <= 30 characters

First (given) name.

lastName
string <= 30 characters

Last (family) name.

Responses
200

OK

Response Schema: application/json
status
required
string
  • SHARE_OK: A share request has been sent to the recipient.
  • NO_SUBSCRIPTION: No subscription to share.
  • SUBSCRIPTION_STOPPED: Subscription is stopped and cannot be shared.
  • REQUEST_ACCEPTED: Share request has been accepted.
  • REQUEST_DECLINED: Share request has been declined.
  • SHARING_ENDED: Share has ended.
  • SHARE_CODE_NOT_FOUND: Share code was not found.
  • SHARE_CHANGE_TYPE_NOT_SUPPORTED: Share change type is not supported.
  • ALREADY_IN_USE: Share for the specified contact is already in use.
  • SHARE_LIMIT: When another sharing was accepted and user can't accept this sharing until the other sharing is ended.
  • INVITATIONS_POOL_EXHAUSTED: When all available invitations have been used and the user cannot send new ones until other sharing is ended.
Enum: "SHARE_OK" "NO_SUBSCRIPTION" "SUBSCRIPTION_STOPPED" "REQUEST_ACCEPTED" "REQUEST_DECLINED" "SHARING_ENDED" "SHARE_CODE_NOT_FOUND" "SHARE_CHANGE_TYPE_NOT_SUPPORTED" "ALREADY_IN_USE" "SHARE_LIMIT" "INVITATIONS_POOL_EXHAUSTED"
400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/subscription/share/invitation
Request samples
application/json
{
  • "contact": "kari.nordmann@gmail.com",
  • "contactType": "A",
  • "productCode": "CO27409"
}
Response samples
application/json
{
  • "status": "SHARE_OK"
}

Accept subscription share invitation

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

This API is called to accept a share invitation.

SecurityAuthorization_Code
Request
Request Body schema: application/json
shareCode
required
string <= 255 characters

Share code, the unique key to find given share

changeType
required
string

What type of change it is:

  • ACCEPT: Accept the share
Value: "ACCEPT"
Responses
200

OK

Response Schema: application/json
status
required
string
  • SHARE_OK: A share request has been sent to the recipient.
  • NO_SUBSCRIPTION: No subscription to share.
  • SUBSCRIPTION_STOPPED: Subscription is stopped and cannot be shared.
  • REQUEST_ACCEPTED: Share request has been accepted.
  • REQUEST_DECLINED: Share request has been declined.
  • SHARING_ENDED: Share has ended.
  • SHARE_CODE_NOT_FOUND: Share code was not found.
  • SHARE_CHANGE_TYPE_NOT_SUPPORTED: Share change type is not supported.
  • ALREADY_IN_USE: Share for the specified contact is already in use.
  • SHARE_LIMIT: When another sharing was accepted and user can't accept this sharing until the other sharing is ended.
  • INVITATIONS_POOL_EXHAUSTED: When all available invitations have been used and the user cannot send new ones until other sharing is ended.
Enum: "SHARE_OK" "NO_SUBSCRIPTION" "SUBSCRIPTION_STOPPED" "REQUEST_ACCEPTED" "REQUEST_DECLINED" "SHARING_ENDED" "SHARE_CODE_NOT_FOUND" "SHARE_CHANGE_TYPE_NOT_SUPPORTED" "ALREADY_IN_USE" "SHARE_LIMIT" "INVITATIONS_POOL_EXHAUSTED"
400

Bad Request

429

Too Many Requests

500

Internal Server Error

patch/v1/subscription/share/invitation
Request samples
application/json
{
  • "shareCode": "1234WEF",
  • "changeType": "ACCEPT"
}
Response samples
application/json
{
  • "status": "SHARE_OK"
}

Decline share - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

This API is used to decline a share request
NB: changeType in the request has to be DECLINE

SecurityClient_Credentials
Request
Request Body schema: application/json
required
shareCode
required
string <= 255 characters

Share code, the unique key to find given share

changeType
required
string

What type of change it is:

  • DECLINE: Decline the share
Value: "DECLINE"
Responses
200

OK

Response Schema: application/json
status
required
string
  • 1: A share request has been sent to the recipient (SHARE_REQUEST_SENT).
  • 2: Share request has been accepted (REQUEST_ACCEPTED).
  • 3: Share request has been declined (REQUEST_DECLINED).
  • 4: No subscription to share (NO_SUBSCRIPTION).
  • 5: Share has ended (SHARING_ENDED).
  • 6: Share change type is not supported (SHARE_CHANGE_TYPE_NOT_SUPPORTED).
  • 7: When another sharing was accepted and user can't accept this sharing until the other sharing is ended (SHARE_LIMIT).
Enum: "1" "2" "3" "4" "5" "6" "7"
400

Bad Request

429

Too Many Requests

500

Internal Server Error

patch/v1/client/subscription/share/invitation
Request samples
application/json
{
  • "shareCode": "32479VSA",
  • "changeType": "DECLINE"
}
Response samples
application/json
{
  • "status": "5"
}

List shareable subscription rules

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

SecurityAuthorization_Code
Request
path Parameters
productCode
required
string <= 12 characters

product code

Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/product/share/rule/{productCode}
Request samples 
Response samples 
application/json
{
  • "customerProductShareRules": [
    ]
}
List distribution levels
The user needs to be logged in to use this endpoint, click here to read more.


Use this API to list all availble distribution levels for selected product. Applicable only to B2B received subscriptions. Can be used to switch from current distribution level to one of the returned distribution levels e.g. to request start distribution.


SecurityAuthorization_Code 
Request 
path Parameters
productCode
required
string  <= 12 characters 
product code


 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


get/v1/product/{productCode}/distribution-level
Request samples 
Response samples 
application/json
{
  • "distributionLevels": [
    ]
}
Change subscription share invitation details
The user needs to be logged in to use this endpoint, click here to read more.


This API is called to update a share invitation details.


SecurityAuthorization_Code 
Request 
Request Body schema: application/json
required
shareCode
required
string  <= 255 characters 
Share code, the unique key to find given share


 
firstName
string  <= 30 characters 
First (given) name.


 
lastName
string  <= 30 characters 
Last (family) name.


 
Responses 
200
OK


Response Schema: application/json
success
boolean
Informs if operation response is successful.


    

  • true: The external reference was created.
    • 

  • false The external reference was not created.
    • 



 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


patch/v1/subscription/share/invitation/data
Request samples 
application/json
{
  • "shareCode": "kyu54",
  • "firstName": "Kari",
  • "lastName": "Nordmann"
}
Response samples 
application/json
{
  • "success": true
}
List all shared subscribers
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


SecurityAuthorization_Code 
Request 
query Parameters
history
boolean
 Default:  true
    

  • 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).
    • 



 
shareType
string
 Default:  "USERS"
Share type allows you to specify which subscriptions to incude in the result:


    

  • USERS: Just user subscriptions
    • 

  • B2B: Just B2B subscriptions
    • 



 
Responses 
200
OK


Response Schema: application/json
Array of objects
List of shared subscribers


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


 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


get/v1/subscription/share
Request samples 
Response samples 
application/json
{
  • "sharedUserInformationList": [
    ],
  • "sharedSubscriptionSummary": [
    ]
}
Cancel sharing
The user needs to be logged in to use this endpoint, click here to read more.


This API cancels sharing of a subscription.


SecurityAuthorization_Code 
Request 
Request Body schema: application/json
required
shareCode
required
string  <= 255 characters 
Share code, the unique key to find given share


 
changeType
required
string
What type of change it is:


    

  • CANCEL: Cancel the share
    • 



 Value: "CANCEL"  
Responses 
200
OK


Response Schema: application/json
status
required
string
    

  • SHARE_OK: A share request has been sent to the recipient.
    • 

  • NO_SUBSCRIPTION: No subscription to share.
    • 

  • SUBSCRIPTION_STOPPED: Subscription is stopped and cannot be shared.
    • 

  • REQUEST_ACCEPTED: Share request has been accepted.
    • 

  • REQUEST_DECLINED: Share request has been declined.
    • 

  • SHARING_ENDED: Share has ended.
    • 

  • SHARE_CODE_NOT_FOUND: Share code was not found.
    • 

  • SHARE_CHANGE_TYPE_NOT_SUPPORTED: Share change type is not supported.
    • 

  • ALREADY_IN_USE: Share for the specified contact is already in use.
    • 

  • SHARE_LIMIT: When another sharing was accepted and user can't accept this sharing until the other sharing is ended.
    • 

  • INVITATIONS_POOL_EXHAUSTED: When all available invitations have been used and the user cannot send new ones until other sharing is ended.
    • 



 Enum: "SHARE_OK" "NO_SUBSCRIPTION" "SUBSCRIPTION_STOPPED" "REQUEST_ACCEPTED" "REQUEST_DECLINED" "SHARING_ENDED" "SHARE_CODE_NOT_FOUND" "SHARE_CHANGE_TYPE_NOT_SUPPORTED" "ALREADY_IN_USE" "SHARE_LIMIT" "INVITATIONS_POOL_EXHAUSTED"  
400
Bad Request


429
Too Many Requests


500
Internal Server Error


patch/v1/subscription/share
Request samples 
application/json
{
  • "shareCode": "123AFDG",
  • "changeType": "CANCEL"
}
Response samples 
application/json
{
  • "status": "SHARING_ENDED"
}
List shareable subscription nets
The user needs to be logged in to use this endpoint, click here to read more.


Use this API for per domain, IP range sharing.


SecurityAuthorization_Code 
Request 
path Parameters
productCode
required
string  <= 12 characters 
product code


 
Responses 
200
OK


Response Schema: application/json
Array of objects
 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


get/v1/customer/product/share/net/{productCode}
Request samples 
Response samples 
application/json
{
  • "nets": [
    ]
}
Change shareable subscription nets
The user needs to be logged in to use this endpoint, click here to read more.


Use this API for per domain, IP range sharing.


SecurityAuthorization_Code 
Request 
path Parameters
productCode
required
string  <= 12 characters 
Product code


 
Request Body schema: application/json
required
Array of objects
 
Responses 
200
OK


Response Schema: application/json
success
boolean
Informs if operation response is successful.


    

  • true: The external reference was created.
    • 

  • false The external reference was not created.
    • 



 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


post/v1/customer/product/share/net/{productCode}
Request samples 
application/json
{
  • "nets": [
    ]
}
Response samples 
application/json
{
  • "success": true
}
Change distribution level
The user needs to be logged in to use this endpoint, click here to read more.


Use this API to change distribution level for selected product. Applicable only to B2B received subscriptions. Can be used to switch from current distribution level to different one e.g. to request start distribution.


Request 
Request Body schema: application/json
required
productCode
string  <= 12 characters 
Product code


 
distributionLevel
string  = 1 characters 
Distribution level


 
Responses 
200
OK


Response Schema: application/json
success
boolean
Informs if operation response is successful.


    

  • true: The external reference was created.
    • 

  • false The external reference was not created.
    • 



 
400
Bad Request


429
Too Many Requests


500
Internal Server Error


patch/v1/product/delivery
Request samples 
application/json
{
  • "productCode": "ABC",
  • "distributionLevel": "N"
}
Response samples 
application/json
{
  • "success": true
}
➔ Next to Subscription