MediaConnect AS
Powered by Redocly

Address

Change addresses

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

Address API for current and future temporary or permanent address changes.

SecurityAuthorization_Code
Request
Request Body schema: application/json
required
product
string <= 12 characters

Product code: Multiple values separated by comma (each value maximum 12 character). Required unless changeType is createPermanent.

changeType
required
string

The type of this address change. Types must be one of:

  • update: Either requires an id for a current/future address, or updates the current home address. Specified dates but no id means a failure.
  • delete: Requires an id for a future address, only works until that address' start date has not been reached
  • create: Creates a future address change, can optionally take an id from a historical address to reuse that address, requires product
  • createPermanent: Same as create, but creates a permanent future address change, ignores product and end time

It is not possible to update the address data on a future address change, this is done by deleting an id and creating a new one with the correct address. When a period is specified to an update request, it is implied that the change is to be done to a future address change.

Enum: "update" "delete" "create" "createPermanent"
id
integer

Unique id for an address to use.

This is required in these instances:

  • Update of the period on a future address change.
  • Deleting a future address change.
  • Creating a future address change using an historical address.

This is optional in these instances:

  • Updating the current home address.

These instances will lead to errors:

  • Specifying the id for the current home address, but specifying period data on an update.
  • Leaving the id blank when specifying period data on an update.
  • Specifying the id for the current home address when creating a new future address change.
  • Leaving the id blank when deleting a future address change.
careOfAddress
string <= 40 characters

The C/O for this address change.

streetAddress
string <= 40 characters

The street for this address change

streetNumber
integer

The street number for this address change

entrance
string <= 12 characters

The entrance for this address change

postalCode
string <= 10 characters

The postal code for this address change

postalPlace
string <= 30 characters

The postal place for this address change

postalAddress
string <= 40 characters

The postal address for this address change

postalAddressPostalCode
string <= 10 characters

The postal code for this address change's postal address

postalAddressPostalPlace
string <= 30 characters

The postal place for this address change's postal address

countryCode
string <= 3 characters

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

This field is required for update and create.

object
Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/customer/address
Request samples
application/json
{
  • "product": "CO27409",
  • "changeType": "update",
  • "id": 3,
  • "careOfAddress": "",
  • "streetAddress": "Grubbegata",
  • "streetNumber": 6,
  • "entrance": "A",
  • "postalCode": 179,
  • "postalPlace": "Oslo",
  • "postalAddress": "Postboks 265 Økern",
  • "postalAddressPostalCode": "0510",
  • "postalAddressPostalPlace": "Oslo",
  • "countryCode": "NO",
  • "period": {
    }
}
Response samples
application/json
{
  • "addressList": [
    ]
}

List addresses

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.

SecurityAuthorization_Code
Request
path Parameters
queryType
required
string
  • currentAddress: Get the current home(/delivery) address
  • historicalAddress: Get historical address items
  • futureAddressChange: Get future address changes
  • all: Get all address items
Enum: "currentAddress" "historicalAddress" "futureAddressChange" "all"
query Parameters
numberOfLines
integer
Default: 20

Number of lines returned in response

Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/customer/address/{queryType}
Request samples 
Response samples 
application/json
{
  • "addressList": [
    ]
}
List addresses - 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.


Address API for current and future temporary or permanent address changes. API is also used to get info on the current address/delivery address and existing changes.


SecurityClient_Credentials 
Request 
path Parameters
queryType
required
string
    

  • currentAddress: Get the current home(/delivery) address  
    • 

  • historicalAddress: Get historical address items  
    • 

  • futureAddressChange: Get future address changes  
    • 

  • all: Get all address items
    • 



 Enum: "currentAddress" "historicalAddress" "futureAddressChange" "all"  
customernumber
required
integer
Customer number is the customer identification.


 
query Parameters
numberOfLines
integer
 Default:  20
Number of lines returned in response


 
Responses 
200
OK


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


404
Not Found


429
Too Many Requests


500
Internal Server Error


get/v1/client/address/{queryType}/{customernumber}
Request samples 
Response samples 
application/json
{
  • "addressList": [
    ]
}
List addresses for product - 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.


Address API for current and future temporary or permanent address changes. API is also used to get info on the current address/delivery address and existing changes.


SecurityClient_Credentials 
Request 
path Parameters
queryType
required
string
    

  • currentAddress: Get the current home(/delivery) address  
    • 

  • historicalAddress: Get historical address items  
    • 

  • futureAddressChange: Get future address changes  
    • 

  • all: Get all address items
    • 



 Enum: "currentAddress" "historicalAddress" "futureAddressChange" "all"  
customernumber
required
integer
Customer number is the customer identification.


 
product
required
string  <= 12 characters 
Product is an parameter that limits the response to a specific product.


 
query Parameters
numberOfLines
integer
 Default:  20
Number of lines returned in response


 
Responses 
200
OK


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


404
Not Found


429
Too Many Requests


500
Internal Server Error


get/v1/client/address/{queryType}/{customernumber}/{product}
Request samples 
Response samples 
application/json
{
  • "addressList": [
    ]
}
List addresses for product
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.


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


This element is an parameter that limits the response to a specific product.


 
queryType
required
string
    

  • currentAddress: Get the current home(/delivery) address  
    • 

  • historicalAddress: Get historical address items  
    • 

  • futureAddressChange: Get future address changes  
    • 

  • all: Get all address items
    • 



 Enum: "currentAddress" "historicalAddress" "futureAddressChange" "all"  
query Parameters
numberOfLines
integer
 Default:  20
Number of lines returned in response


 
Responses 
200
OK


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


429
Too Many Requests


500
Internal Server Error


get/v1/customer/address/{queryType}/{product}
Request samples 
Response samples 
application/json
{
  • "addressList": [
    ]
}
➔ Next to Category