Metodkatalog API

API change history

Get one Method

Get one Method

Try it

Förfrågan

Begärans-URL

Begäranparametrar

  • integer

    Format - int32. Id of method

  • (valfri)
    integer

    Format - int32. Export format id used in DAM

Begärandehuvud

  • string
    Prenumerationsnyckel som ger åtkomst till det här API:et. Hittades i din Profil.

Brödtext i begäran

Svar

200 OK

Success

Återgivningar

{
  "type": "object",
  "properties": {
    "methodId": {
      "type": "integer",
      "description": "Method Id",
      "format": "int32"
    },
    "versionId": {
      "type": "integer",
      "description": "Methods version id",
      "format": "int32"
    },
    "catalogId": {
      "type": "integer",
      "description": "Id of Catalog that Method belongs to",
      "format": "int32"
    },
    "activityId": {
      "type": "integer",
      "description": "Id of Methods activity (metod)",
      "format": "int32"
    },
    "targetGroupId": {
      "type": "integer",
      "description": "Id of Target Group",
      "format": "int32",
      "nullable": true
    },
    "requireLicense": {
      "type": "boolean",
      "description": "Is license required",
      "nullable": true
    },
    "environmentIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "Id's of environment (naturtyp)",
      "nullable": true
    },
    "assessmentId": {
      "type": "integer",
      "description": "Id of assessment",
      "format": "int32",
      "nullable": true
    },
    "assessmentBasisId": {
      "type": "integer",
      "description": "Id of assessment basis",
      "format": "int32",
      "nullable": true
    },
    "description": {
      "type": "string",
      "description": "Description of method",
      "nullable": true
    },
    "equipment": {
      "type": "string",
      "description": "Method Equipment",
      "nullable": true
    },
    "benefits": {
      "type": "string",
      "description": "Methods benefits",
      "nullable": true
    },
    "drawbacks": {
      "type": "string",
      "description": "Methods drawbacks",
      "nullable": true
    },
    "comment": {
      "type": "string",
      "description": "Comment to benefits and drawbacks",
      "nullable": true
    },
    "costEstimate": {
      "type": "string",
      "description": "Estimated cost",
      "nullable": true
    },
    "activityTypeId": {
      "type": "integer",
      "description": "Id of type of activity (metodtyp)",
      "format": "int32"
    },
    "purposeIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "Id's of method's purposes",
      "nullable": true
    },
    "taxa": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Taxon id from dyntaxa",
            "format": "int32"
          },
          "swedishName": {
            "type": "string",
            "description": "Swedish Name",
            "nullable": true
          },
          "scientificName": {
            "type": "string",
            "description": "Scientific Name",
            "nullable": true
          },
          "riskLevel": {
            "type": "string",
            "description": "Risk for invasivity\r\n    0: Very high risk\r\n    1: High risk\r\n    2: Potentially high risk\r\n    3: Low risk\r\n    4: No known risk\r\n    5: Not evaluated",
            "nullable": true
          },
          "euForordning": {
            "type": "boolean",
            "description": "Part of \"EU-förordning 1143/2014\""
          }
        },
        "additionalProperties": false,
        "description": "Taxon data"
      },
      "description": "List of taxa in Method",
      "nullable": true
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "description": "Link friendly text",
            "nullable": true
          },
          "url": {
            "type": "string",
            "description": "Link Url",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "More information urls"
      },
      "description": "List of links in Method",
      "nullable": true
    },
    "media": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uri": {
            "type": "string",
            "description": "Uri to media",
            "nullable": true
          },
          "type": {
            "type": "string",
            "description": "Type of media",
            "nullable": true
          },
          "author": {
            "type": "string",
            "description": "Medias author",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "Description set in metodkatalogen editor",
            "nullable": true
          },
          "damDescription": {
            "type": "string",
            "description": "Description from Dam-service",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "description": "List of media in Method",
      "nullable": true
    },
    "references": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "List of references in Method",
      "nullable": true
    },
    "published": {
      "type": "string",
      "description": "Date when version was published",
      "format": "date-time",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A Method"
}
{
  "methodId": 0,
  "versionId": 0,
  "catalogId": 0,
  "activityId": 0,
  "targetGroupId": 0,
  "requireLicense": true,
  "environmentIds": [
    0
  ],
  "assessmentId": 0,
  "assessmentBasisId": 0,
  "description": "string",
  "equipment": "string",
  "benefits": "string",
  "drawbacks": "string",
  "comment": "string",
  "costEstimate": "string",
  "activityTypeId": 0,
  "purposeIds": [
    0
  ],
  "taxa": [
    {
      "id": 0,
      "swedishName": "string",
      "scientificName": "string",
      "riskLevel": "string",
      "euForordning": true
    }
  ],
  "links": [
    {
      "text": "string",
      "url": "string"
    }
  ],
  "media": [
    {
      "uri": "string",
      "type": "string",
      "author": "string",
      "description": "string",
      "damDescription": "string"
    }
  ],
  "references": {},
  "published": "string"
}
{
  "type": "object",
  "properties": {
    "methodId": {
      "type": "integer",
      "description": "Method Id",
      "format": "int32"
    },
    "versionId": {
      "type": "integer",
      "description": "Methods version id",
      "format": "int32"
    },
    "catalogId": {
      "type": "integer",
      "description": "Id of Catalog that Method belongs to",
      "format": "int32"
    },
    "activityId": {
      "type": "integer",
      "description": "Id of Methods activity (metod)",
      "format": "int32"
    },
    "targetGroupId": {
      "type": "integer",
      "description": "Id of Target Group",
      "format": "int32",
      "nullable": true
    },
    "requireLicense": {
      "type": "boolean",
      "description": "Is license required",
      "nullable": true
    },
    "environmentIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "Id's of environment (naturtyp)",
      "nullable": true
    },
    "assessmentId": {
      "type": "integer",
      "description": "Id of assessment",
      "format": "int32",
      "nullable": true
    },
    "assessmentBasisId": {
      "type": "integer",
      "description": "Id of assessment basis",
      "format": "int32",
      "nullable": true
    },
    "description": {
      "type": "string",
      "description": "Description of method",
      "nullable": true
    },
    "equipment": {
      "type": "string",
      "description": "Method Equipment",
      "nullable": true
    },
    "benefits": {
      "type": "string",
      "description": "Methods benefits",
      "nullable": true
    },
    "drawbacks": {
      "type": "string",
      "description": "Methods drawbacks",
      "nullable": true
    },
    "comment": {
      "type": "string",
      "description": "Comment to benefits and drawbacks",
      "nullable": true
    },
    "costEstimate": {
      "type": "string",
      "description": "Estimated cost",
      "nullable": true
    },
    "activityTypeId": {
      "type": "integer",
      "description": "Id of type of activity (metodtyp)",
      "format": "int32"
    },
    "purposeIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "Id's of method's purposes",
      "nullable": true
    },
    "taxa": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Taxon id from dyntaxa",
            "format": "int32"
          },
          "swedishName": {
            "type": "string",
            "description": "Swedish Name",
            "nullable": true
          },
          "scientificName": {
            "type": "string",
            "description": "Scientific Name",
            "nullable": true
          },
          "riskLevel": {
            "type": "string",
            "description": "Risk for invasivity\r\n    0: Very high risk\r\n    1: High risk\r\n    2: Potentially high risk\r\n    3: Low risk\r\n    4: No known risk\r\n    5: Not evaluated",
            "nullable": true
          },
          "euForordning": {
            "type": "boolean",
            "description": "Part of \"EU-förordning 1143/2014\""
          }
        },
        "additionalProperties": false,
        "description": "Taxon data"
      },
      "description": "List of taxa in Method",
      "nullable": true
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "description": "Link friendly text",
            "nullable": true
          },
          "url": {
            "type": "string",
            "description": "Link Url",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "More information urls"
      },
      "description": "List of links in Method",
      "nullable": true
    },
    "media": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uri": {
            "type": "string",
            "description": "Uri to media",
            "nullable": true
          },
          "type": {
            "type": "string",
            "description": "Type of media",
            "nullable": true
          },
          "author": {
            "type": "string",
            "description": "Medias author",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "Description set in metodkatalogen editor",
            "nullable": true
          },
          "damDescription": {
            "type": "string",
            "description": "Description from Dam-service",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "description": "List of media in Method",
      "nullable": true
    },
    "references": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "List of references in Method",
      "nullable": true
    },
    "published": {
      "type": "string",
      "description": "Date when version was published",
      "format": "date-time",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A Method"
}
{
  "methodId": 0,
  "versionId": 0,
  "catalogId": 0,
  "activityId": 0,
  "targetGroupId": 0,
  "requireLicense": true,
  "environmentIds": [
    0
  ],
  "assessmentId": 0,
  "assessmentBasisId": 0,
  "description": "string",
  "equipment": "string",
  "benefits": "string",
  "drawbacks": "string",
  "comment": "string",
  "costEstimate": "string",
  "activityTypeId": 0,
  "purposeIds": [
    0
  ],
  "taxa": [
    {
      "id": 0,
      "swedishName": "string",
      "scientificName": "string",
      "riskLevel": "string",
      "euForordning": true
    }
  ],
  "links": [
    {
      "text": "string",
      "url": "string"
    }
  ],
  "media": [
    {
      "uri": "string",
      "type": "string",
      "author": "string",
      "description": "string",
      "damDescription": "string"
    }
  ],
  "references": {},
  "published": "string"
}
{
  "type": "object",
  "properties": {
    "methodId": {
      "type": "integer",
      "description": "Method Id",
      "format": "int32"
    },
    "versionId": {
      "type": "integer",
      "description": "Methods version id",
      "format": "int32"
    },
    "catalogId": {
      "type": "integer",
      "description": "Id of Catalog that Method belongs to",
      "format": "int32"
    },
    "activityId": {
      "type": "integer",
      "description": "Id of Methods activity (metod)",
      "format": "int32"
    },
    "targetGroupId": {
      "type": "integer",
      "description": "Id of Target Group",
      "format": "int32",
      "nullable": true
    },
    "requireLicense": {
      "type": "boolean",
      "description": "Is license required",
      "nullable": true
    },
    "environmentIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "Id's of environment (naturtyp)",
      "nullable": true
    },
    "assessmentId": {
      "type": "integer",
      "description": "Id of assessment",
      "format": "int32",
      "nullable": true
    },
    "assessmentBasisId": {
      "type": "integer",
      "description": "Id of assessment basis",
      "format": "int32",
      "nullable": true
    },
    "description": {
      "type": "string",
      "description": "Description of method",
      "nullable": true
    },
    "equipment": {
      "type": "string",
      "description": "Method Equipment",
      "nullable": true
    },
    "benefits": {
      "type": "string",
      "description": "Methods benefits",
      "nullable": true
    },
    "drawbacks": {
      "type": "string",
      "description": "Methods drawbacks",
      "nullable": true
    },
    "comment": {
      "type": "string",
      "description": "Comment to benefits and drawbacks",
      "nullable": true
    },
    "costEstimate": {
      "type": "string",
      "description": "Estimated cost",
      "nullable": true
    },
    "activityTypeId": {
      "type": "integer",
      "description": "Id of type of activity (metodtyp)",
      "format": "int32"
    },
    "purposeIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      },
      "description": "Id's of method's purposes",
      "nullable": true
    },
    "taxa": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Taxon id from dyntaxa",
            "format": "int32"
          },
          "swedishName": {
            "type": "string",
            "description": "Swedish Name",
            "nullable": true
          },
          "scientificName": {
            "type": "string",
            "description": "Scientific Name",
            "nullable": true
          },
          "riskLevel": {
            "type": "string",
            "description": "Risk for invasivity\r\n    0: Very high risk\r\n    1: High risk\r\n    2: Potentially high risk\r\n    3: Low risk\r\n    4: No known risk\r\n    5: Not evaluated",
            "nullable": true
          },
          "euForordning": {
            "type": "boolean",
            "description": "Part of \"EU-förordning 1143/2014\""
          }
        },
        "additionalProperties": false,
        "description": "Taxon data"
      },
      "description": "List of taxa in Method",
      "nullable": true
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "description": "Link friendly text",
            "nullable": true
          },
          "url": {
            "type": "string",
            "description": "Link Url",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "More information urls"
      },
      "description": "List of links in Method",
      "nullable": true
    },
    "media": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uri": {
            "type": "string",
            "description": "Uri to media",
            "nullable": true
          },
          "type": {
            "type": "string",
            "description": "Type of media",
            "nullable": true
          },
          "author": {
            "type": "string",
            "description": "Medias author",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "Description set in metodkatalogen editor",
            "nullable": true
          },
          "damDescription": {
            "type": "string",
            "description": "Description from Dam-service",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "description": "List of media in Method",
      "nullable": true
    },
    "references": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "List of references in Method",
      "nullable": true
    },
    "published": {
      "type": "string",
      "description": "Date when version was published",
      "format": "date-time",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A Method"
}

Kodexempel

@ECHO OFF

curl -v -X GET "https://api.artdatabanken.se/metodkatalog/v1/Methods/{methodId}?mediaSize={integer}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["mediaSize"] = "{integer}";
            var uri = "https://api.artdatabanken.se/metodkatalog/v1/Methods/{methodId}?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.artdatabanken.se/metodkatalog/v1/Methods/{methodId}");

            builder.setParameter("mediaSize", "{integer}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "mediaSize": "{integer}",
        };
      
        $.ajax({
            url: "https://api.artdatabanken.se/metodkatalog/v1/Methods/{methodId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.artdatabanken.se/metodkatalog/v1/Methods/{methodId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"mediaSize={integer}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.artdatabanken.se/metodkatalog/v1/Methods/{methodId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'mediaSize' => '{integer}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'mediaSize': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('api.artdatabanken.se')
    conn.request("GET", "/metodkatalog/v1/Methods/{methodId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'mediaSize': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('api.artdatabanken.se')
    conn.request("GET", "/metodkatalog/v1/Methods/{methodId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.artdatabanken.se/metodkatalog/v1/Methods/{methodId}')

query = URI.encode_www_form({
    # Request parameters
    'mediaSize' => '{integer}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body