Offentligkonst.se/Om projektet/Teknisk dokumentation/Api

Från Wikimedia
Hoppa till: navigering, sök
  Huvudsida     Donationer     Påverkan     Jag vill hjälpa till!     Om projektet     FAQ     In English    
  Projektet     2013     2015     2016     Tidslinje över stämningen     Tekniskt     FAQ     In English    
  Parametrar     Databas     Api     Wikipedianslutning     Licenser    

Varför på engelska? (Swedish for "Why in English?")

Dokumentationen nedan är på engelska av två anledningar. Den första är för att api:et, och likaså databasen, är skrivet på engelska. Dvs. parameternamnen, funktionerna, klasserna etc. är alla på engelska. Även de resultat som visas är till stor del på engelska. Undantaget är .klm filerna som ger svenska beskrivningar samt, självfallet, innehållet i databasen. Detta beror till stor del på att jag är mer van vid att programmera på engelska.

Den andra motivationen för att ha dokumentationen på engelska är att detta gör den mer tillgänglig. De flesta som är intresserade av att bygga något mot databasen behärskar troligen engelska men inte nödvändigtvis svenska.

Introduction

The api can be accessed at http://offentligkonst.se/api/api.php? In the examples below this part of the url is simply abbreviated to api.php?.

The two main parameters for the api are:

  • action - What action you would like to perform.
    • This takes one of four values: get, statistics, admin or help. Defaults to help. More info below.
  • format - Which format would you like the response in. More info in output formats below.

Several of the actions also allow you to specify constraints on which information is returned. You can read more about these under constraints below.

viktig Note that if the same parameter is added twice then only the latter is considerer. Where allowed multiple values for the same parameters are separated by the pipe "|" symbol.
viktig Note that you can add a maximum of 50 values per parameter per search.

Some api actions limit the number of results returned. For these the call also accepts the following parameters:

  • limit: The maximum number of results returned [integer in the range 1-100], defaults to 10;
  • offset: From which result to start returning the results (used in conjuncture with the continue header, see below) [positve integer], defaults to 0.

Example:

Response

The format of the response is controlled using the format parameter. Although the output varies depending on the api call the basic structure remains the same. The output contains a body carrying the bulk of the data and a header which contains at least one field:

  • success: This indicates whether the api call was successful (1) or whether it encountered an error (0).

Additionally the header may contain more fields.

  • warning: This field is included if a non-critical error occurred. These are normally related to one or more of the parameters being miss-formatted.

In the cases where the api call accepts the limit and offset parameters the header will also contain the following:

  • hits: A numbering of the returned hits. In the format "offsetoffset+#displayed_results of #total_results;
  • limit: The limit used in the api call.
  • continue: If there are more results still to display then this gives the value of the next offset.

Errors

If the api call encounters an error the header will (in addition to success=0) also contain an error_number as well as an error_message which tries to describe, in words, what went wrong. The body of the response is left empty.

Error Codes

500 - (apiMain.php) can't connect to server or database
600 - (apiMain.php) readConstraints doQuery (i.e. mySQL lookup) failed
601 - (apiMain.php) action not recognised
602 - (apiMain.php) readConstraints, to many values given for a single parameter
603 - (apiMain.php) readConstraints, to many characters in the values of a single parameter (see [1])
610 - (ApiGet.php) doQuery failed
620 - (ApiStats.php) doQuery failed
630 - (ApiAdmin.php) doQuery failed
631 - (ApiAdmin.php) info without id or table
632 - (ApiAdmin.php) function not recognised

Constraints

A general constraints is one which can be applied to either the get or the statistics module. There are also additional constraints which are applied to the artist module. The constraints are split into five types:

Exact Parameters

These will return results only when the entered value matches the result exactly. Multiple values are separated by pipes '|'. These parameters are:

  • (general) id, type, county, muni, district, source, wiki, list, commons_cat, official_url, free, owner, county_name and muni_name;
  • (artist) id, wiki and last_name.

Most of these are self explanatory. Note however the following:

  • muni: this is the (4-digit) municipal code, to restrict by name use muni_name instead (without "kommun", e.g. "Lund" instead of "Lunds kommun").
  • county: this is the county code (one or two upper case letters), to restrict by name use county_name instead.
  • wiki and list: this is the wikidata entity. i.e something like "Q1234".
  • free: this only takes the values 'pd','cc','unfree' and .

viktig You cannot use both the muni parameter and the muni_name parameter as doing so will not give the expected result. The same is true for the county/county_name parameters.

Example:

Soft Parameters

These are parameters which use wildcard searches. E.g. "ello" will give a hit for any value of the form "%ello%" where % can be any string. I.e. a hit on either of ("ello", "hello", "elloy", "mellow yellow"). These parameters are:

  • (general) title, artist and address;
  • (artist) first_name and name.

Boolean Parameters

These are parameters that take only the values "true" or "false". These parameters are:

  • (general) is_inside, is_removed, has_ugc, has_image, has_coords, has_wiki, has_list, has_cmt and has_same (i.e. has same_as);
  • (artist) is_dead.

Ranged Parameters

These are parameters where you might want to specify a numerical range of (temporal) values rather than a specific one. These parameters are:

  • (general) year, changed and created;
  • (artist) birth_year, death_year and lifespan.

These parameters work by accepting either one parameter or two parameters separated by a pipe "|". If only one value is given the parameter behaves as an exact parameter. If two values are given then any result between the two values are returned. If the second value is left out then results larger than the first value are returned. If the first value is left out then results smaller than the second value are returned. All three ranges include the end-point(s).

As a summarising example:

  • year=1980  : Returns only results where year = 1980
  • year=1980|  : Returns results where year ≥ 1980
  • year=1980|1990 : Returns results where 1980 ≤ year ≤ 1990
  • year=|1980  : Returns results where year ≤ 1980

viktig As a result these parameters do not accept multiple values in the normal sense.

viktig "lifespan" does not support an exact year but must be given an (open or closed) span.

The created and the changed parameters refer to when the object was first introduced into the database and when it was last changed. These can be specified at three levels

  1. Year: You may specify a year in the format YYYY.
  2. Date: Specify a date in the format YYYYMMDD.
  3. Time: Specify a time in the format YYYYMMDDHHMMSS.

Bounding Box

This creates a geographical constraint where only coordinates within a certain box are returned. The constraint is formatted as:

  • (general) bbox=bl_lon|bl_lat|tr_lon|tr_lat

where bl = bottom left, tr = top right, lat=latitude and lon=longitude.

viktig Note that coordinates must be given in decimal notation (using "." to as decimal sign).

Output formats

The available output formats that can be specified through the format parameter are:

  • xml: (default)
    • xsl: style-sheet wrapper for xml (limited to action=get, action=artist and action=admin with either function=diff or function=info)
  • json - pretty print json
    • add json=compact for compact format json
  • php: serialized php
  • wiki: a list of row-templates for Wikipedia designed using the Offentligkonstlista-template on sv.wikipedia

Map formats

  • geojson: pretty print geojson with all parameters as properties
    • add json=compact for compact format json
    • add geojson=full for a version which more in-depth information such as grouping of properties, look-up of artist_table, look-up of sv.wp articles corresponding to given wikidata id. Note that this output is significantly slower.
  • kml: creates a static kml file for map visualisation. Note that e.g. google maps will display a cached version of this file
  • dynamickml: creates a dynamic kml file for map visualisation. Unlike the static version this is not cached by e.g. google maps. As you move around on the map the bbox parameter will automatically update.
  • googlemaps: opens the above dynamic kml file directly in google maps centred, and zoomed in, on Sweden (for action=get only)
    • All map formats are limited to action=get only
    • All map formats sets the has_coords constraint (to true) if this constraint isn't specified beforehand.

Examples:

Example outputs can be seen at /output.

Actions

action=get

Performs a standard SQL query on the main_table of the database based on given constraints.

In addition to the ordinary constraints and parameters this module also listens for the following parameter:

  • view: the view used [strict, enhanced, normal], defaults to normal.
  • show: the parameters to show [id, title, artist, descr, year, year_cmt, type, material, inside, address, county, muni, district, lat, lon, removed, image, source, ugc, changed, created, wiki, list, commons_cat, official_url, same_as, free, cmt, owner], defaults to showing all. (pipe-separated)

Examples:

action=artist

Performs a standard SQL query on the artist_table of the database based on given constraints.

This action allows the artist(s) to be selected using either of:

  • artwork: The id of an artwork, or a pipe-separated list of ids. Will return all artists which were involved with any of the listed works.
  • A combination of id, wiki, first_name, last_name, name, birth_year, death_year, is_dead, lifespan
    • "lifespan" is a ranged parameter where the whole of the artists lifespan must fit in the given range;
    • "name" is a soft parameter searching against a combination of first and last name.

In addition to the ordinary constraints and parameters this module also listens for the following parameter:

  • show: the parameters to show [id, first_name, last_name, wiki, birth_date, birth_year, death_date, death_year, creator, changed, works], defaults to showing all. (pipe-separated)
    • "creator" is the corresponding creator template on Wikimedia Commons
    • "works" are a list of all of the works by the artist found in the database

viktig You cannot combine the artwork parameter with any other constraint (apart from show).

Examples:

action=statistics

Gives statistics about the database. The two existing stats to look are determined by whether the "table" or "column" parameters are set. Aditionally you can break down the result using the split parameter:

  • table: This will give you the number of entries in a given table. [all, main, artist, audit, county, muni, source, ugc, aka], defaults to all. (pipe-separted)
    • Note that tables other than main or audit will ignore any additional constraints
  • column: Shows the number of items in the main table where the given column is non-zero [id, title, artist, descr, year, year_cmt, type, inside, address, county, muni, district, lat, lon, removed, image, source, ugc, changed, created, wiki, list, commons_cat, official_url, same_as, free, cmt, owner], no default. (pipe-separted)
  • split: Showes the result broken down by municipality, county or source [muni, county, source], no default.
    • Note that split will not work on either multiple tables or columns nor for tables other than main or audit.

The body of the response changes depending on the options but takes the following general shapes:

  • table : table_name->count
  • column: column_name->count
  • split: split_type->[split_name->value,table/column_name->count] e.g. muni->[muni_name->"Lund","main"->"4"]

Examples:

action=admin

Includes some maintenance functions that will not be of interest to the average user.

To use set the function parameter to one of:

  • info: Displays all known info for a given object as identified by its id and table
  • lists: Displays all known Wikipedia lists being referenced in the database (referred to by Wikidata id)
  • diff: produces a list of changes in main_table wrt. audit_table (listens for global constraints)
  • objectlessArtist: produces a list of artists that have no objects
  • yearlessArtist: produces a list of artists that have no death_year and where birth_year is also missing or occurred more than 100 years ago
  • artistlessObject: produces a list of objects that have no linked artists


viktig In diff it is important to note that created indicates when the object was introduced in each table. As a result in main_table this indicates when the object was first introduced whereas in audit_table it indicates when a change to the original information was first introduced.

Examples: