IOXIO Dataspace Sandbox

Product Gateway (1.0.0)

Download OpenAPI specification:Download

Product Gateway to fetch Data Products from registered data sources in the Dataspace.

Data Products

draft/AirQuality/Current

Current air quality

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
lat
required
number (Latitude) [ -90 .. 90 ]

The latitude coordinate of the desired location

lon
required
number (Longitude) [ -180 .. 180 ]

The longitude coordinate of the desired location

Responses

Request samples

Content type
application/json
{
  • "lat": 60.192059,
  • "lon": 24.945831
}

Response samples

Content type
application/json
{
  • "airQualityIndex": 30,
  • "timestamp": "2020-04-03T13:00:00Z",
  • "attribution": [
    ]
}

draft/Company/BasicInfo

Information about the company

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
companyId
required
string (Company ID)

The ID of the company

Responses

Request samples

Content type
application/json
{
  • "companyId": "2464491-9"
}

Response samples

Content type
application/json
{
  • "name": "Digital Living International Oy",
  • "companyId": "2464491-9",
  • "companyForm": "LLC",
  • "registrationDate": "2012-02-23"
}

draft/Company/Recommendation

Data Product for company recommendations score

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
keywords
required
string (Keywords)

Keyword data to base recommendations on

Responses

Request samples

Content type
application/json
{
  • "keywords": "Looking for data product companies to invest on"
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

draft/Company/Shareholders

Information about the shareholders of the company

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
companyId
required
string (Company ID)

The ID of the company, only supports Finnish business ID's

Responses

Request samples

Content type
application/json
{
  • "companyId": "2464491-9"
}

Response samples

Content type
application/json
{
  • "shareSeries": [
    ],
  • "owners": [
    ]
}

draft/Energy/Battery/ChargingHistory

Charging history of a battery

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
serialNumber
required
string (Serial Number)

The serial number of the battery

start
string <date-time> (Start Time)

Include history entries starting from this time (inclusive)

end
string <date-time> (End Time)

Include history entries until this time (exclusive)

limit
integer (Limit) [ 1 .. 100 ]
Default: 100

Limit number of history entries to return

offset
integer (Offset) >= 0
Default: 0

Offset of history records to return

Responses

Request samples

Content type
application/json
{
  • "serialNumber": "MPP48V-296cde7f",
  • "start": "2022-09-09T00:00:00",
  • "end": "2022-09-10T00:00:00",
  • "limit": 100,
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "batteryChargingHistory": [
    ],
  • "totalCount": 1
}

draft/Energy/Battery/ProductDataSheet

Product Data Sheet for batteries

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
productCode
required
string (Product Code)

The product code used by the manufacturer

Responses

Request samples

Content type
application/json
{
  • "productCode": "MPP48V"
}

Response samples

Content type
application/json
{
  • "manufacturer": "Valmet Automotive",
  • "productCode": "MPP48V",
  • "name": "Modular Power Pack, 48 V",
  • "cellType": "lithium-titanate",
  • "capacity": 2.2,
  • "energy": 46,
  • "voltage": {
    },
  • "peakDischargingPower": 20,
  • "peakChargingPower": 20,
  • "continuousPower": 10,
  • "standbyConsumption": 1,
  • "cycleLife": 20000,
  • "dimensions": {
    },
  • "weight": 41,
  • "operatingTemperature": {
    },
  • "ipRating": "IP6K9K",
  • "maxCoolantPressure": 3.5,
  • "standardsCompliance": [
    ]
}

draft/Health/Diagnoses

Health diagnoses in ICD codes

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
object (HealthDiagnosesRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "diagnoses": [
    ]
}

draft/Key/CreateAssignment

Create assignment

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
keyId
required
string (Key ID) non-empty ^[0-9a-f]+$

UID of a key as a hex encoded string without delimiters

lockId
required
string (Lock ID) non-empty

Vendor specific ID for a lock

sharedSecret
required
string (Shared Secret)

Shared secret between the productizer and the system using it

Responses

Request samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678",
  • "sharedSecret": "string"
}

Response samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678"
}

draft/Key/DeleteAssignment

Delete assignment

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
keyId
required
string (Key ID) non-empty ^[0-9a-f]+$

UID of a key as a hex encoded string without delimiters

lockId
required
string (Lock ID) non-empty

Vendor specific ID for a lock

sharedSecret
required
string (Shared Secret)

Shared secret between the productizer and the system using it

Responses

Request samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678",
  • "sharedSecret": "string"
}

Response samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678"
}

draft/Key/LockAssignmentExists

Check if lock assignment exists

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
keyId
required
string (Key ID) non-empty ^[0-9a-f]+$

UID of a key as a hex encoded string without delimiters

lockId
required
string (Lock ID) non-empty

Vendor specific ID for a lock

sharedSecret
required
string (Shared Secret)

Shared secret between the productizer and the system using it

Responses

Request samples

Content type
application/json
{
  • "keyId": "a1b2c3d4e5f6890",
  • "lockId": "12345678",
  • "sharedSecret": "string"
}

Response samples

Content type
application/json
{
  • "exists": true
}

draft/Product/Manufacturing/EnvironmentalFootprint

Environmental Footprint information for a product

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
serialNumber
required
string (Serial Number)

The serial number given by the manufacturer

Responses

Request samples

Content type
application/json
{
  • "serialNumber": "MPP48V-296cde7f"
}

Response samples

Content type
application/json
{
  • "carbonEquivalent": 200,
  • "materialWaste": 8
}

draft/TimeAndDate/CurrentTime

Get the current time in a given country

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
countryCode
required
any (ISO 3166-1 alpha-2 country code)
Enum: "ad" "ae" "af" "ag" "ai" "al" "am" "ao" "aq" "ar" "as" "at" "au" "aw" "ax" "az" "ba" "bb" "bd" "be" "bf" "bg" "bh" "bi" "bj" "bl" "bm" "bn" "bo" "bq" "br" "bs" "bt" "bv" "bw" "by" "bz" "ca" "cc" "cd" "cf" "cg" "ch" "ci" "ck" "cl" "cm" "cn" "co" "cr" "cu" "cv" "cw" "cx" "cy" "cz" "de" "dj" "dk" "dm" "do" "dz" "ec" "ee" "eg" "eh" "er" "es" "et" "fi" "fj" "fk" "fm" "fo" "fr" "ga" "gb" "gd" "ge" "gf" "gg" "gh" "gi" "gl" "gm" "gn" "gp" "gq" "gr" "gs" "gt" "gu" "gw" "gy" "hk" "hm" "hn" "hr" "ht" "hu" "id" "ie" "il" "im" "in" "io" "iq" "ir" "is" "it" "je" "jm" "jo" "jp" "ke" "kg" "kh" "ki" "km" "kn" "kp" "kr" "kw" "ky" "kz" "la" "lb" "lc" "li" "lk" "lr" "ls" "lt" "lu" "lv" "ly" "ma" "mc" "md" "me" "mf" "mg" "mh" "mk" "ml" "mm" "mn" "mo" "mp" "mq" "mr" "ms" "mt" "mu" "mv" "mw" "mx" "my" "mz" "na" "nc" "ne" "nf" "ng" "ni" "nl" "no" "np" "nr" "nu" "nz" "om" "pa" "pe" "pf" "pg" "ph" "pk" "pl" "pm" "pn" "pr" "ps" "pt" "pw" "py" "qa" "re" "ro" "rs" "ru" "rw" "sa" "sb" "sc" "sd" "se" "sg" "sh" "si" "sj" "sk" "sl" "sm" "sn" "so" "sr" "ss" "st" "sv" "sx" "sy" "sz" "tc" "td" "tf" "tg" "th" "tj" "tk" "tl" "tm" "tn" "to" "tr" "tt" "tv" "tw" "tz" "ua" "ug" "um" "us" "uy" "uz" "va" "vc" "ve" "vg" "vi" "vn" "vu" "wf" "ws" "ye" "yt" "za" "zm" "zw"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "countryCode": "ad"
}

Response samples

Content type
application/json
{
  • "currentTime": "string"
}

draft/Weather/Current/Metric

Current weather in metric units

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
lat
required
number (Latitude) [ -90 .. 90 ]

The latitude coordinate of the desired location

lon
required
number (Longitude) [ -180 .. 180 ]

The longitude coordinate of the desired location

Responses

Request samples

Content type
application/json
{
  • "lat": 60.192059,
  • "lon": 24.945831
}

Response samples

Content type
application/json
{
  • "humidity": 72,
  • "pressure": 1007,
  • "rain": true,
  • "temp": 17.3,
  • "windSpeed": 2.1,
  • "windDirection": 220
}

test/Indoor/BLEBeacons

Indoor location based on BLE beacons

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
required
Array of objects (Beacons)

Responses

Request samples

Content type
application/json
{
  • "beacons": [
    ]
}

Response samples

Content type
application/json
{
  • "locationId": "849cc493-efb7-483f-b634-7a44849270f9",
  • "locationName": "Deck #3"
}

test/LetterOfCredit/ExportInstructions

Export Instructions

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
letterOfCreditNumber
required
string (Letter of credit number)

Responses

Request samples

Content type
application/json
{
  • "letterOfCreditNumber": "123"
}

Response samples

Content type
application/json
{
  • "advisingBankBic": "string",
  • "advisingBankName": "string",
  • "advisingBankReference": "string",
  • "applicantAddress": "string",
  • "applicantName": "string",
  • "beneficiaryAddress": "string",
  • "beneficiaryName": "string",
  • "confirmationInstructions": "string",
  • "contractReference": "string",
  • "creditAvailability": "string",
  • "currencyCode": "string",
  • "dateOfExpiry": "2019-08-24T14:15:22Z",
  • "descriptionOfGoods": "string",
  • "incoterm": "string",
  • "incotermPlace": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "issuingBankBic": "string",
  • "issuingBankName": "string",
  • "latestDateOfShipment": "2019-08-24T14:15:22Z",
  • "letterOfCreditValue": 0
}

test/Product/DimensionsAndWeights

Dimensions And Weights

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
productCode
required
string (Product code)

Responses

Request samples

Content type
application/json
{
  • "productCode": "string"
}

Response samples

Content type
application/json
{
  • "grossWeight": "string",
  • "height": 0,
  • "length": 0,
  • "netWeight": 0,
  • "productDescription": "string",
  • "productName": "string",
  • "volume": 0,
  • "width": 0
}

test/Shipment/ForwardersCargoReceipt

Cargo Receipt

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
shipmentId
required
string (Shipment ID)

Responses

Request samples

Content type
application/json
{
  • "shipmentId": "string"
}

Response samples

Content type
application/json
{
  • "carrierName": "string",
  • "exporterName": "string",
  • "finalDestination": "string",
  • "finalDestinationAddress": "string",
  • "forwarderContactPersonName": "string",
  • "forwarderContactPersonPhone": "string",
  • "forwarderName": "string",
  • "handlingUnits": 0,
  • "importerName": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "lcNumber": "string",
  • "modeOfDelivery": "string",
  • "placeOfDischarge": "string",
  • "placeOfLoading": "string",
  • "placeOfReceipt": "string",
  • "statement": "string",
  • "totalGrossWeight": 0,
  • "totalNetWeight": 0,
  • "totalVolume": 0
}

test/Shipment/InsuranceCertificate

Insurance Certificate

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
shipmentId
required
string (Shipment ID)

Responses

Request samples

Content type
application/json
{
  • "shipmentId": "string"
}

Response samples

Content type
application/json
{
  • "currencyCode": "string",
  • "descriptionOfGoods": "string",
  • "finalDestination": "string",
  • "handlingUnits": 0,
  • "instituteClauses": "string",
  • "insuranceValue": 0,
  • "insuranceValuePercentage": 0,
  • "insurerAddress": "string",
  • "insurerName": "string",
  • "modeOfDelivery": "string",
  • "placeOfReceipt": "string",
  • "totalGrossWeight": 0
}

test/Shipment/PackingList

Packing List

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
shipmentId
required
string (Shipment ID)

Responses

Request samples

Content type
application/json
{
  • "shipmentId": "string"
}

Response samples

Content type
application/json
{
  • "contractReference": "string",
  • "descriptionOfGoods": "string",
  • "finalDestination": "string",
  • "handlingUnits": 0,
  • "incoterm": "string",
  • "incotermPlace": "string",
  • "lcNumber": "string",
  • "packingDescription": "string",
  • "packingReference": "string",
  • "placeOfReceipt": "string",
  • "productItems": [
    ],
  • "totalGrossWeight": 0,
  • "totalNetWeight": 0,
  • "totalVolume": 0
}

test/Transaction/Invoice

Invoice

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
shipmentId
required
string (Shipment ID)

Responses

Request samples

Content type
application/json
{
  • "shipmentId": "string"
}

Response samples

Content type
application/json
{
  • "amountToBePaid": 0,
  • "bankContactBic": "string",
  • "bankContactIban": "string",
  • "bankContactName": "string",
  • "buyerContactPersonName": "string",
  • "buyerName": "string",
  • "buyerVatNumber": "string",
  • "contractReference": "string",
  • "countryOfOrigin": "string",
  • "currencyCode": "string",
  • "descriptionOfGoods": "string",
  • "handlingUnits": 0,
  • "incoterm": "string",
  • "incotermPlace": "string",
  • "invoiceNote": "string",
  • "invoiceReference": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "lcNumber": "string",
  • "letterOfCreditValue": 0,
  • "modeOfDelivery": "string",
  • "orderReference": "string",
  • "projectReference": "string",
  • "sellerContactPersonName": "string",
  • "sellerName": "string",
  • "sellerVatNumber": "string",
  • "taxRate": 0,
  • "totalGrossWeight": 0,
  • "totalNetWeight": 0,
  • "totalVolume": 0,
  • "valueOfShipment": 0
}

test/ioxio-dataspace-guides/Country/BasicInfo

Information about the country

query Parameters
source
required
string (Source)
header Parameters
authorization
string (User bearer token)

The login token. Value should be "Bearer [token]"

x-authorization-provider
string (Source of the token)

The bare domain of the system that provided the token

x-consent-token
string (Consent token)

Optional consent token to provide to data sources that require a consent

x-preview-token
string (Preview token)

Optional authentication token for unpublished data sources

Request Body schema: application/json
code
required
string (Code) = 2 characters

ISO 3166-1 alpha-2 code for the country

Responses

Request samples

Content type
application/json
{
  • "code": "FI"
}

Response samples

Content type
application/json
{
  • "code": "FI",
  • "name": "Finland",
  • "area": 338455,
  • "languages": [
    ],
  • "capital": {
    }
}