Connect

List addresses

Production

https://api.mediaconnect.no/capi

GET

/v1/customer/address/{queryType}

Address

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

API is used to get info on the current address and existing changes.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.mediaconnect.no/capi/v1/customer/address/?numberOfLines'

Response Example

200 - Success

{
    "addressList": [
        {
            "product": "CO27409",
            "addressType": "delivery",
            "id": 3,
            "streetAddress": "Grubbegata",
            "streetNumber": 6,
            "entrance": "A",
            "floor": 6,
            "postalCode": 179,
            "postalPlace": "Oslo",
            "postalAddress": "Postboks 265 Økern",
            "postalAddressPostalCode": "0510",
            "postalAddressPostalPlace": "Oslo",
            "countryCode": "NO",
            "period": {
                "startTime": 1559393560000,
                "endTime": 1562158360000
            }
        }
    ]
}

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

queryType

enum<string>

required

currentAddress: Get the current home(/delivery) address

historicalAddress: Get historical address items

futureAddressChange: Get future address changes

all: Get all address items

Allowed values:

currentAddresshistoricalAddressfutureAddressChangeall

Query Params

numberOfLines

integer

optional

Number of lines returned in response

Default:

Responses

🟢200OK

application/json

Body

addressList

array [object {16}]

optional

product

string

optional

The product code

<= 12 characters

addressType

enum<string>

optional

The type of this address item. Types returned on the different query types:

currentAddress: delivery and home

historicalAddress: temporary

futureAddress: temporary and permanent

Allowed values:

deliveryhometemporarypermanent

integer

optional

Unique id for this address

careOfAddress

string

optional

The C/O for this address

<= 40 characters

streetAddress

string

optional

The street for this address

<= 40 characters

streetNumber

integer

optional

The street number for this address

entrance

string

optional

The entrance for this address

<= 12 characters

floor

integer

optional

The floor for this address

suite

string

optional

The suite for this address

<= 10 characters

postalCode

string

optional

The postal code for this address

<= 10 characters

postalPlace

string

optional

The postal place for this address

<= 30 characters

postalAddress

string

optional

The postal address for this address

<= 40 characters

postalAddressPostalCode

string

optional

The postal code for this address's postal address

<= 10 characters

postalAddressPostalPlace

string

optional

The postal place for this address's postal address

<= 30 characters

countryCode

string

optional

The country code for this address - ISO 3166 - alpha-2

<= 3 characters

period

object

optional

Wrapper holding details about an address's active period

🟠400Bad Request

🟠429429

🔴500Server Error

Change addresses

List addresses - client mode