BoFCoRe

API change history

/Publications/lists/A1 - GET

Try it

Request

Request URL

Request body

Responses

200 OK

Success

Representations

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "readOnly": true
      },
      "category": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "readOnly": true
          },
          "code": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "subCategory": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "readOnly": true
          },
          "code": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "links": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "readOnly": true
      },
      "authors": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "firstName": {
              "type": "string",
              "readOnly": true
            },
            "lastName": {
              "type": "string",
              "readOnly": true
            }
          }
        },
        "readOnly": true
      },
      "publishingPlatform": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "readOnly": true
          },
          "bofQualityClass": {
            "format": "int32",
            "type": "integer",
            "readOnly": true
          }
        }
      },
      "status": {
        "type": "object",
        "properties": {
          "statusCode": {
            "format": "int32",
            "enum": [
              1,
              2,
              3
            ],
            "type": "integer"
          },
          "statusDate": {
            "format": "date-time",
            "type": "string",
            "readOnly": true
          }
        }
      },
      "publicationSeries": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          }
        }
      },
      "isBofit": {
        "type": "boolean",
        "readOnly": true
      }
    }
  }
}
[
  {
    "name": "string",
    "category": {
      "description": "string",
      "code": "string"
    },
    "subCategory": {
      "description": "string",
      "code": "string"
    },
    "links": [
      "string"
    ],
    "authors": [
      {
        "firstName": "string",
        "lastName": "string"
      }
    ],
    "publishingPlatform": {
      "name": "string",
      "bofQualityClass": 0
    },
    "status": {
      "statusCode": 1,
      "statusDate": "string"
    },
    "publicationSeries": {
      "name": "string"
    },
    "isBofit": true
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "readOnly": true
      },
      "category": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "readOnly": true
          },
          "code": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "subCategory": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "readOnly": true
          },
          "code": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "links": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "readOnly": true
      },
      "authors": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "firstName": {
              "type": "string",
              "readOnly": true
            },
            "lastName": {
              "type": "string",
              "readOnly": true
            }
          }
        },
        "readOnly": true
      },
      "publishingPlatform": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "readOnly": true
          },
          "bofQualityClass": {
            "format": "int32",
            "type": "integer",
            "readOnly": true
          }
        }
      },
      "status": {
        "type": "object",
        "properties": {
          "statusCode": {
            "format": "int32",
            "enum": [
              1,
              2,
              3
            ],
            "type": "integer"
          },
          "statusDate": {
            "format": "date-time",
            "type": "string",
            "readOnly": true
          }
        }
      },
      "publicationSeries": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          }
        }
      },
      "isBofit": {
        "type": "boolean",
        "readOnly": true
      }
    }
  }
}
[
  {
    "name": "string",
    "category": {
      "description": "string",
      "code": "string"
    },
    "subCategory": {
      "description": "string",
      "code": "string"
    },
    "links": [
      "string"
    ],
    "authors": [
      {
        "firstName": "string",
        "lastName": "string"
      }
    ],
    "publishingPlatform": {
      "name": "string",
      "bofQualityClass": 0
    },
    "status": {
      "statusCode": 1,
      "statusDate": "string"
    },
    "publicationSeries": {
      "name": "string"
    },
    "isBofit": true
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "readOnly": true
      },
      "category": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "readOnly": true
          },
          "code": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "subCategory": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "readOnly": true
          },
          "code": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "links": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "readOnly": true
      },
      "authors": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "firstName": {
              "type": "string",
              "readOnly": true
            },
            "lastName": {
              "type": "string",
              "readOnly": true
            }
          }
        },
        "readOnly": true
      },
      "publishingPlatform": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "readOnly": true
          },
          "bofQualityClass": {
            "format": "int32",
            "type": "integer",
            "readOnly": true
          }
        }
      },
      "status": {
        "type": "object",
        "properties": {
          "statusCode": {
            "format": "int32",
            "enum": [
              1,
              2,
              3
            ],
            "type": "integer"
          },
          "statusDate": {
            "format": "date-time",
            "type": "string",
            "readOnly": true
          }
        }
      },
      "publicationSeries": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          }
        }
      },
      "isBofit": {
        "type": "boolean",
        "readOnly": true
      }
    }
  }
}
<PublicationDtoArray>
  <name>string</name>
  <category>
    <description>string</description>
    <code>string</code>
  </category>
  <subCategory>
    <description>string</description>
    <code>string</code>
  </subCategory>
  <links>string</links>
  <authors>
    <firstName>string</firstName>
    <lastName>string</lastName>
  </authors>
  <publishingPlatform>
    <name>string</name>
    <bofQualityClass>0</bofQualityClass>
  </publishingPlatform>
  <status>
    <statusCode>1</statusCode>
    <statusDate>string</statusDate>
  </status>
  <publicationSeries>
    <name>string</name>
  </publicationSeries>
  <isBofit>true</isBofit>
</PublicationDtoArray>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "readOnly": true
      },
      "category": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "readOnly": true
          },
          "code": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "subCategory": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "readOnly": true
          },
          "code": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "links": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "readOnly": true
      },
      "authors": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "firstName": {
              "type": "string",
              "readOnly": true
            },
            "lastName": {
              "type": "string",
              "readOnly": true
            }
          }
        },
        "readOnly": true
      },
      "publishingPlatform": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "readOnly": true
          },
          "bofQualityClass": {
            "format": "int32",
            "type": "integer",
            "readOnly": true
          }
        }
      },
      "status": {
        "type": "object",
        "properties": {
          "statusCode": {
            "format": "int32",
            "enum": [
              1,
              2,
              3
            ],
            "type": "integer"
          },
          "statusDate": {
            "format": "date-time",
            "type": "string",
            "readOnly": true
          }
        }
      },
      "publicationSeries": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          }
        }
      },
      "isBofit": {
        "type": "boolean",
        "readOnly": true
      }
    }
  }
}
<PublicationDtoArray>
  <name>string</name>
  <category>
    <description>string</description>
    <code>string</code>
  </category>
  <subCategory>
    <description>string</description>
    <code>string</code>
  </subCategory>
  <links>string</links>
  <authors>
    <firstName>string</firstName>
    <lastName>string</lastName>
  </authors>
  <publishingPlatform>
    <name>string</name>
    <bofQualityClass>0</bofQualityClass>
  </publishingPlatform>
  <status>
    <statusCode>1</statusCode>
    <statusDate>string</statusDate>
  </status>
  <publicationSeries>
    <name>string</name>
  </publicationSeries>
  <isBofit>true</isBofit>
</PublicationDtoArray>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "readOnly": true
      },
      "category": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "readOnly": true
          },
          "code": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "subCategory": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "readOnly": true
          },
          "code": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "links": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "readOnly": true
      },
      "authors": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "firstName": {
              "type": "string",
              "readOnly": true
            },
            "lastName": {
              "type": "string",
              "readOnly": true
            }
          }
        },
        "readOnly": true
      },
      "publishingPlatform": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "readOnly": true
          },
          "bofQualityClass": {
            "format": "int32",
            "type": "integer",
            "readOnly": true
          }
        }
      },
      "status": {
        "type": "object",
        "properties": {
          "statusCode": {
            "format": "int32",
            "enum": [
              1,
              2,
              3
            ],
            "type": "integer"
          },
          "statusDate": {
            "format": "date-time",
            "type": "string",
            "readOnly": true
          }
        }
      },
      "publicationSeries": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          }
        }
      },
      "isBofit": {
        "type": "boolean",
        "readOnly": true
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.boffsaopendata.fi/bofcore/v1/Publications/lists/A1"

--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);


            var uri = "https://api.boffsaopendata.fi/bofcore/v1/Publications/lists/A1?" + 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.boffsaopendata.fi/bofcore/v1/Publications/lists/A1");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);


            // 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
        };
      
        $.ajax({
            url: "https://api.boffsaopendata.fi/bofcore/v1/Publications/lists/A1?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
            },
            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.boffsaopendata.fi/bofcore/v1/Publications/lists/A1";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    // 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.boffsaopendata.fi/bofcore/v1/Publications/lists/A1');
$url = $request->getUrl();

$headers = array(
    // Request headers
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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 = {
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.boffsaopendata.fi')
    conn.request("GET", "/bofcore/v1/Publications/lists/A1?%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 = {
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.boffsaopendata.fi')
    conn.request("GET", "/bofcore/v1/Publications/lists/A1?%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.boffsaopendata.fi/bofcore/v1/Publications/lists/A1')


request = Net::HTTP::Get.new(uri.request_uri)
# 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