Skip to main content

Available Columns

Overview​

The Columns endpoint provides detailed information about the columns of the available dataset (determined by serviceId and providerId). Users can query this endpoint to retrieve metadata about the columns, such as their names and data types, to better understand the structure of the dataset before querying the Export Data endpoint for data.

Relationship with Accesses Endpoint​

Before querying the Columns endpoint, users may invoke the Accesses endpoint to obtain a list of serviceId and providerId they have access to.

GET /v1/columns/:serviceId/:providerId​

Retrieves information about the columns available in the dataset for the specified service and provider.

  • Method: GET
  • URL: https://api.kinver.no/v1/columns/{serviceId}/{providerId}
  • Authentication: Required (Token-based). See Authentication and Authorization
  • Parameters:
    • serviceId (int): The ID of the service. Users can find their accessible service IDs from the Accesses endpoint.
    • providerId (int): The ID of the provider. This should correspond with the provider ID obtained from the Accesses endpoint.
  • Description: Provides metadata about the columns for the specified service and provider's dataset, which the user has permissions to access.

Example​

GET /v1/columns/123/456
Host: api.kinver.no
kauth: <token>

Response​

  • Content-Type: application/json
  • Returns a JSON object with details about the columns.

Example Response​

{
  "data": [
    {
      "name": "column1",
      "type": "string"
    },
    {
      "name": "column2",
      "type": "number"
    }
  ]
}