SANDBOX Species Observations - Read

API change history

Atlas_GetGeoJsonAtlasCells

Get geojson atlas cells

Try it

Request

Request URL

Request parameters

  • integer

    Format - int32. The overlapping layer id

  • integer

    Format - int32. The atlaslayer id

  • (optional)
    integer

    Format - int32. The taxon id

  • (optional)
    integer

    Format - int32. The from year

  • (optional)
    integer

    Format - int32. The end year

  • (optional)
    boolean

    Show only species in result list.

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.
  • string
    OAuth 2.0 access token obtained from ids.artdatabanken.se. Supported grant types: Authorization code.

Request body

Responses

200 OK

OK

Representations

{
  "atlasCells": {
    "type": "string",
    "features": {
      "type": "string",
      "featureId": "string",
      "geometry": {
        "type": "string",
        "coordinateArray": [
          [
            [
              0.0
            ]
          ]
        ]
      },
      "properties": {
        "value": 0,
        "name": "string"
      }
    }
  },
  "legendProperties": {
    "min": 0,
    "max": 0,
    "labels": {
      "min": 0,
      "max": 0,
      "color": "string",
      "opacity": 0.0,
      "hoverOpacity": 0.0
    }
  },
  "count": 0
}
{
  "type": "object",
  "properties": {
    "atlasCells": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "features": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "featureId": {
              "type": "string"
            },
            "geometry": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string"
                },
                "coordinateArray": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "array",
                      "items": {
                        "format": "double",
                        "type": "number"
                      }
                    }
                  }
                }
              }
            },
            "properties": {
              "type": "object",
              "properties": {
                "value": {
                  "format": "int32",
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "legendProperties": {
      "type": "object",
      "properties": {
        "min": {
          "format": "int32",
          "type": "integer"
        },
        "max": {
          "format": "int32",
          "type": "integer"
        },
        "labels": {
          "type": "object",
          "properties": {
            "min": {
              "format": "int32",
              "type": "integer"
            },
            "max": {
              "format": "int32",
              "type": "integer"
            },
            "color": {
              "type": "string"
            },
            "opacity": {
              "format": "double",
              "type": "number"
            },
            "hoverOpacity": {
              "format": "double",
              "type": "number"
            }
          }
        }
      }
    },
    "count": {
      "format": "int32",
      "type": "integer"
    }
  }
}
{
  "atlasCells": {
    "type": "string",
    "features": {
      "type": "string",
      "featureId": "string",
      "geometry": {
        "type": "string",
        "coordinateArray": [
          [
            [
              0.0
            ]
          ]
        ]
      },
      "properties": {
        "value": 0,
        "name": "string"
      }
    }
  },
  "legendProperties": {
    "min": 0,
    "max": 0,
    "labels": {
      "min": 0,
      "max": 0,
      "color": "string",
      "opacity": 0.0,
      "hoverOpacity": 0.0
    }
  },
  "count": 0
}
{
  "type": "object",
  "properties": {
    "atlasCells": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "features": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "featureId": {
              "type": "string"
            },
            "geometry": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string"
                },
                "coordinateArray": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "array",
                      "items": {
                        "format": "double",
                        "type": "number"
                      }
                    }
                  }
                }
              }
            },
            "properties": {
              "type": "object",
              "properties": {
                "value": {
                  "format": "int32",
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "legendProperties": {
      "type": "object",
      "properties": {
        "min": {
          "format": "int32",
          "type": "integer"
        },
        "max": {
          "format": "int32",
          "type": "integer"
        },
        "labels": {
          "type": "object",
          "properties": {
            "min": {
              "format": "int32",
              "type": "integer"
            },
            "max": {
              "format": "int32",
              "type": "integer"
            },
            "color": {
              "type": "string"
            },
            "opacity": {
              "format": "double",
              "type": "number"
            },
            "hoverOpacity": {
              "format": "double",
              "type": "number"
            }
          }
        }
      }
    },
    "count": {
      "format": "int32",
      "type": "integer"
    }
  }
}
<AtlasCellGeoJson>
  <atlasCells>
    <type>string</type>
    <features>
      <type>string</type>
      <featureId>string</featureId>
      <geometry>
        <type>string</type>
        <coordinateArray>0</coordinateArray>
      </geometry>
      <properties>
        <value>0</value>
        <name>string</name>
      </properties>
    </features>
  </atlasCells>
  <legendProperties>
    <min>0</min>
    <max>0</max>
    <labels>
      <min>0</min>
      <max>0</max>
      <color>string</color>
      <opacity>0</opacity>
      <hoverOpacity>0</hoverOpacity>
    </labels>
  </legendProperties>
  <count>0</count>
</AtlasCellGeoJson>
{
  "type": "object",
  "properties": {
    "atlasCells": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "features": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "featureId": {
              "type": "string"
            },
            "geometry": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string"
                },
                "coordinateArray": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "array",
                      "items": {
                        "format": "double",
                        "type": "number"
                      }
                    }
                  }
                }
              }
            },
            "properties": {
              "type": "object",
              "properties": {
                "value": {
                  "format": "int32",
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "legendProperties": {
      "type": "object",
      "properties": {
        "min": {
          "format": "int32",
          "type": "integer"
        },
        "max": {
          "format": "int32",
          "type": "integer"
        },
        "labels": {
          "type": "object",
          "properties": {
            "min": {
              "format": "int32",
              "type": "integer"
            },
            "max": {
              "format": "int32",
              "type": "integer"
            },
            "color": {
              "type": "string"
            },
            "opacity": {
              "format": "double",
              "type": "number"
            },
            "hoverOpacity": {
              "format": "double",
              "type": "number"
            }
          }
        }
      }
    },
    "count": {
      "format": "int32",
      "type": "integer"
    }
  }
}
<AtlasCellGeoJson>
  <atlasCells>
    <type>string</type>
    <features>
      <type>string</type>
      <featureId>string</featureId>
      <geometry>
        <type>string</type>
        <coordinateArray>0</coordinateArray>
      </geometry>
      <properties>
        <value>0</value>
        <name>string</name>
      </properties>
    </features>
  </atlasCells>
  <legendProperties>
    <min>0</min>
    <max>0</max>
    <labels>
      <min>0</min>
      <max>0</max>
      <color>string</color>
      <opacity>0</opacity>
      <hoverOpacity>0</hoverOpacity>
    </labels>
  </legendProperties>
  <count>0</count>
</AtlasCellGeoJson>
{
  "type": "object",
  "properties": {
    "atlasCells": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "features": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "featureId": {
              "type": "string"
            },
            "geometry": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string"
                },
                "coordinateArray": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "array",
                      "items": {
                        "format": "double",
                        "type": "number"
                      }
                    }
                  }
                }
              }
            },
            "properties": {
              "type": "object",
              "properties": {
                "value": {
                  "format": "int32",
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "legendProperties": {
      "type": "object",
      "properties": {
        "min": {
          "format": "int32",
          "type": "integer"
        },
        "max": {
          "format": "int32",
          "type": "integer"
        },
        "labels": {
          "type": "object",
          "properties": {
            "min": {
              "format": "int32",
              "type": "integer"
            },
            "max": {
              "format": "int32",
              "type": "integer"
            },
            "color": {
              "type": "string"
            },
            "opacity": {
              "format": "double",
              "type": "number"
            },
            "hoverOpacity": {
              "format": "double",
              "type": "number"
            }
          }
        }
      }
    },
    "count": {
      "format": "int32",
      "type": "integer"
    }
  }
}

400 Bad Request

Failure due to client-side problem

Representations

{
  "developerMessages": [
    "string"
  ],
  "statusCode": "OK"
}
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}
{
  "developerMessages": [
    "string"
  ],
  "statusCode": "OK"
}
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}
<ResponseMessage>
  <developerMessages>string</developerMessages>
  <statusCode>OK</statusCode>
</ResponseMessage>
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}
<ResponseMessage>
  <developerMessages>string</developerMessages>
  <statusCode>OK</statusCode>
</ResponseMessage>
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}

500 Internal Server Error

Failure due to server-side problem

Representations

{
  "developerMessages": [
    "string"
  ],
  "statusCode": "OK"
}
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}
{
  "developerMessages": [
    "string"
  ],
  "statusCode": "OK"
}
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}
<ResponseMessage>
  <developerMessages>string</developerMessages>
  <statusCode>OK</statusCode>
</ResponseMessage>
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}
<ResponseMessage>
  <developerMessages>string</developerMessages>
  <statusCode>OK</statusCode>
</ResponseMessage>
{
  "description": "A response message returned to a developer with more detailed information about the exception.",
  "type": "object",
  "properties": {
    "developerMessages": {
      "description": "An error message that can be used by a developer to track down an error",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "The http response code that the API responded with.",
      "enum": [
        "OK",
        "Created",
        "Accepted",
        "BadRequest",
        "Unauthorized",
        "InternalServerError"
      ],
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.artdatabanken.se/sandbox-observations-r/v2/atlas/geojsonatlascells?areaId={areaId}&atlasLayerId={atlasLayerId}?taxonId={integer}&fromYear={integer}&toYear={integer}&includeSpeciesOnly={boolean}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"

--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}");
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

            // Request parameters
            queryString["taxonId"] = "{integer}";
            queryString["fromYear"] = "{integer}";
            queryString["toYear"] = "{integer}";
            queryString["includeSpeciesOnly"] = "{boolean}";
            var uri = "https://api.artdatabanken.se/sandbox-observations-r/v2/atlas/geojsonatlascells?areaId={areaId}&atlasLayerId={atlasLayerId}&" + 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/sandbox-observations-r/v2/atlas/geojsonatlascells?areaId={areaId}&atlasLayerId={atlasLayerId}");

            builder.setParameter("taxonId", "{integer}");
            builder.setParameter("fromYear", "{integer}");
            builder.setParameter("toYear", "{integer}");
            builder.setParameter("includeSpeciesOnly", "{boolean}");

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


            // 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
            "taxonId": "{integer}",
            "fromYear": "{integer}",
            "toYear": "{integer}",
            "includeSpeciesOnly": "{boolean}",
        };
      
        $.ajax({
            url: "https://api.artdatabanken.se/sandbox-observations-r/v2/atlas/geojsonatlascells?areaId={areaId}&atlasLayerId={atlasLayerId}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            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/sandbox-observations-r/v2/atlas/geojsonatlascells?areaId={areaId}&atlasLayerId={atlasLayerId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"taxonId={integer}",
                         @"fromYear={integer}",
                         @"toYear={integer}",
                         @"includeSpeciesOnly={boolean}",
                      ];
    
    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 setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
    // 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/sandbox-observations-r/v2/atlas/geojsonatlascells?areaId={areaId}&atlasLayerId={atlasLayerId}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'taxonId' => '{integer}',
    'fromYear' => '{integer}',
    'toYear' => '{integer}',
    'includeSpeciesOnly' => '{boolean}',
);

$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}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
    # Request parameters
    'taxonId': '{integer}',
    'fromYear': '{integer}',
    'toYear': '{integer}',
    'includeSpeciesOnly': '{boolean}',
})

try:
    conn = httplib.HTTPSConnection('api.artdatabanken.se')
    conn.request("GET", "/sandbox-observations-r/v2/atlas/geojsonatlascells?areaId={areaId}&atlasLayerId={atlasLayerId}&%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}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'taxonId': '{integer}',
    'fromYear': '{integer}',
    'toYear': '{integer}',
    'includeSpeciesOnly': '{boolean}',
})

try:
    conn = http.client.HTTPSConnection('api.artdatabanken.se')
    conn.request("GET", "/sandbox-observations-r/v2/atlas/geojsonatlascells?areaId={areaId}&atlasLayerId={atlasLayerId}&%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/sandbox-observations-r/v2/atlas/geojsonatlascells?areaId={areaId}&atlasLayerId={atlasLayerId}')

query = URI.encode_www_form({
    # Request parameters
    'taxonId' => '{integer}',
    'fromYear' => '{integer}',
    'toYear' => '{integer}',
    'includeSpeciesOnly' => '{boolean}'
})
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 headers
request['Authorization'] = '{access token}'
# 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