List consent given issuer - client mode

Production

https://api.mediaconnect.no/capi

GET

/v1/client/customer/privacy/consents/{issuer}

Consent

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.

API for getting consents to given issuer.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.mediaconnect.no/capi/v1/client/customer/privacy/consents/?consentGroupId&onlyActive'

Response Example

200 - Success

{
    "issuer": "468979834",
    "consents": [
        {
            "consentId": 1,
            "consentGroupId": 1,
            "target": "editoral",
            "scope": "email",
            "parentConsentId": 1,
            "selectionOrder": 2,
            "displayMode": "A",
            "created": 1560855388000,
            "texts": [
                {
                    "languageCode": "nb_NO",
                    "name": "Kommunikasjon på epost",
                    "description": "Samtykker du til å motta eposter?"
                },
                {
                    "languageCode": "en_GB",
                    "name": "Communication on email",
                    "description": "Do you agree to recevice emails?"
                }
            ],
            "active": true
        }
    ]
}

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

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

Example:

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

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

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

Scopes:

read-For all access

Path Params

issuer

string

required

Used to identify who has required the consent, ex. name of the company.

<= 255 characters

Query Params

consentGroupId

integer

optional

If group is specified, only for this group will be consents returned

onlyActive

boolean

optional

Whether to return active records or all the data:

true: It returns data only for active records.

false: It returns all the data.

Default:

true

Responses

🟢200OK

application/json

Body

issuer

string

optional

Identification of the issuer principal of the consent

<= 255 characters

consents

array [object {10}]

optional

Consents to given issuer

consentId

integer

optional

Identification number of consent

consentGroupId

integer

optional

Group id

target

string

optional

Identification of the target of consent (e.g. URL of a policy)

<= 255 characters

scope

string

optional

The scope of the consent can refer to a section or clause in the target

<= 255 characters

parentConsentId

integer

optional

Parent consent id - if belongs to other consent

selectionOrder

integer

optional

Selection order for display

displayMode

enum<string>

optional

Display behavior of consent:

I: Display if parent is inactive.

A: Display if parent is active

S: Display regardless of parent state.

null: Default by application

Allowed values:

IASnull

Default:

null

created

integer

optional

Consent creation date

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

texts

array [object {3}]

optional

Consent texts

active

boolean

optional

It informs if the consent group is in use.

true: The consent group is in use.

false: The consent group is not in use.

🟠400Bad Request

🟠429429

🔴500Server Error

List consent groups - client mode

List consent event history