Welcome to the documentation of the Picturae Webkitchen components, on this website you can find information how to implement our components on your own website.

You can also try the demo to see how our application should behave. In case you have any questions you can contact us at contact@picturae.com.

Mediabank
Mediabank 2.0
Genealogie
Webexpo
Memorix Archives

Picturae Webkitchen - Genealogie

Genealogy - recipes and ingredients

The following page gives information about the available recipes and their ingredients.

  • /{catch:(.*)}

    Method: options 
                    
Capture all OPTIONS requests

  • /config/{id:[a-zA-Z0-9_-]+}

    Method: get 
                    
Show predefined config for the client this endpoint receives the following parameters:
lang={language} Optional language
Example request: /config/{config-id}?apiKey={key}&lang=nl

  • /config

    Method: get 
                    
List all available predefined config for the client to use, the following parameters are available:
lang={language} Optional language
meta={0(default)|1} Return the list of metafields for the configuration.
Request:
Example /config/?apiKey={key}&lang=nl&meta=1

  • /filters

    Method: get 
                    
List filters, this endpoint receives the following parameters:
q={searchterm} global search term could search on specific fields e.g. field:{term}
fq[]={field1:"value x"} Apply filter to query
fq[]={field2:"value y"} Apply filter to query
facetSort={index, count} Index will sort filters by ascii value, count will sort the filters by result
lang={val} Two character language (if available e.g nl)
Example request: /filters?apiKey={key}&q=*:*

  • /filter/{field}

    Method: get 
                    
List filters, this endpoint receives the following parameters:
q={searchterm} global search term could search on specific fields e.g. field:{term}
page={number} result offset
rows={number} amount of rows to return in resultset, default 100 max 1000
fq[]={field1:"value x"} Apply filter to query
fq[]={field2:"value y"} Apply filter to query
facetSort={index, count} Index will sort filters by ascii value, count will sort the filters by result
lang={val} Two character language (if available e.g nl)
object_type={val} filter on object type
Example request: /filter/{filter_field}?apiKey={key}&q=*:*&page=1&rows=1

  • /register

    Method: get 
                    
Search.
This endpoint receives the following parameters:
q={searchterm} global search term could search on specific fields e.g. field:{term}
page={number} result offset
rows={number} amount of rows to return in resultset, default 100 max 1000
facetFields[]={field1} Field to return facets for
facetFields[]={field2} Field to return facets for
fq[]={field1:"value x"} Apply filter to query
fq[]={field2:"value y"} Apply filter to query
qf={title^20.0+text^10.0} Apply boosting per field to improve search results
sort={field asc, field2 desc} sort by field, to generate a random result it is possible to order on random{time} asc
lang={val} Two character language (if available e.g nl
f[{field}][{param}]={value} Field parameter override
Example request: /{object_type}/?apiKey={key}&q=*:*&page=1&rows=1&facetFields[]=string_s_v1_uiterlijke_vorm&facetFields[]=strings_s_v1_vervaardigers&facetLimit=2&fq[]=string_s_v1_uiterlijke_vorm:"foto's"
Errors will always be shown in error property example:

{
"error": {
"code": 400,
"message": "undefined field: \"strinxg_s_v1_uiterlijke_vorm\""
}
}

  • /register/{id:\{?[0-9a-f]{8}\-?[0-9a-f]{4}\-?[0-9a-f]{4}\-?[0-9a-f]{4}\-?[0-9a-f]{12}\}?}

    Method: get 
                    
Get detail of object
Request:
Example /{object_type}/{id}?apiKey={key}
Errors will always be shown in error property example:

{
 "error": {
     "code": 400,
     "message": "undefined field: \"strinxg_s_v1_uiterlijke_vorm\""
 }
}

  • /register/field

    Method: get 
                    
Provides info about filterable & search fields
Request:
Example /{object_type}/field/?apiKey={key}
example response:
{
  "fields": {
    "field": {
      "order": "order_s_omschrijving",
      "search": "search_t_omschrijving",
      "facet": "search_s_omschrijving"
    }
  }
}

  • /asset

    Method: get 
                    
Search.
This endpoint receives the following parameters:
q={searchterm} global search term could search on specific fields e.g. field:{term}
page={number} result offset
rows={number} amount of rows to return in resultset, default 100 max 1000
facetFields[]={field1} Field to return facets for
facetFields[]={field2} Field to return facets for
fq[]={field1:"value x"} Apply filter to query
fq[]={field2:"value y"} Apply filter to query
qf={title^20.0+text^10.0} Apply boosting per field to improve search results
sort={field asc, field2 desc} sort by field, to generate a random result it is possible to order on random{time} asc
lang={val} Two character language (if available e.g nl
f[{field}][{param}]={value} Field parameter override
Example request: /{object_type}/?apiKey={key}&q=*:*&page=1&rows=1&facetFields[]=string_s_v1_uiterlijke_vorm&facetFields[]=strings_s_v1_vervaardigers&facetLimit=2&fq[]=string_s_v1_uiterlijke_vorm:"foto's"
Errors will always be shown in error property example:

{
"error": {
"code": 400,
"message": "undefined field: \"strinxg_s_v1_uiterlijke_vorm\""
}
}

  • /asset/{id:\{?[0-9a-f]{8}\-?[0-9a-f]{4}\-?[0-9a-f]{4}\-?[0-9a-f]{4}\-?[0-9a-f]{12}\}?}

    Method: get 
                    
Get detail of object
Request:
Example /{object_type}/{id}?apiKey={key}
Errors will always be shown in error property example:

{
 "error": {
     "code": 400,
     "message": "undefined field: \"strinxg_s_v1_uiterlijke_vorm\""
 }
}

  • /asset/field

    Method: get 
                    
Provides info about filterable & search fields
Request:
Example /{object_type}/field/?apiKey={key}
example response:
{
  "fields": {
    "field": {
      "order": "order_s_omschrijving",
      "search": "search_t_omschrijving",
      "facet": "search_s_omschrijving"
    }
  }
}

  • /deed

    Method: get 
                    
Search.
This endpoint receives the following parameters:
q={searchterm} global search term could search on specific fields e.g. field:{term}
page={number} result offset
rows={number} amount of rows to return in resultset, default 100 max 1000
facetFields[]={field1} Field to return facets for
facetFields[]={field2} Field to return facets for
fq[]={field1:"value x"} Apply filter to query
fq[]={field2:"value y"} Apply filter to query
qf={title^20.0+text^10.0} Apply boosting per field to improve search results
sort={field asc, field2 desc} sort by field, to generate a random result it is possible to order on random{time} asc
lang={val} Two character language (if available e.g nl
f[{field}][{param}]={value} Field parameter override
Example request: /{object_type}/?apiKey={key}&q=*:*&page=1&rows=1&facetFields[]=string_s_v1_uiterlijke_vorm&facetFields[]=strings_s_v1_vervaardigers&facetLimit=2&fq[]=string_s_v1_uiterlijke_vorm:"foto's"
Errors will always be shown in error property example:

{
"error": {
"code": 400,
"message": "undefined field: \"strinxg_s_v1_uiterlijke_vorm\""
}
}

  • /deed/{id:\{?[0-9a-f]{8}\-?[0-9a-f]{4}\-?[0-9a-f]{4}\-?[0-9a-f]{4}\-?[0-9a-f]{12}\}?}

    Method: get 
                    
Get detail of object
Request:
Example /{object_type}/{id}?apiKey={key}
Errors will always be shown in error property example:

{
 "error": {
     "code": 400,
     "message": "undefined field: \"strinxg_s_v1_uiterlijke_vorm\""
 }
}

  • /deed/field

    Method: get 
                    
Provides info about filterable & search fields
Request:
Example /{object_type}/field/?apiKey={key}
example response:
{
  "fields": {
    "field": {
      "order": "order_s_omschrijving",
      "search": "search_t_omschrijving",
      "facet": "search_s_omschrijving"
    }
  }
}

  • /report

    Method: get 
                    
Fetch comments
Example request: /{id}/?apiKey={key}
Errors will always be shown in error property example:

{
"error": {
"code": 400,
"message": "Could not find the requested record."
}
}

  • /report/count

    Method: get 
                    
Get error reports' count for this record.
Example request: /{id}/count?apiKey={key}
Errors will always be shown in error property example:

{
"error": {
"code": 400,
"message": "Could not find the requested record."
}
}

  • /report

    Method: post 
                    
Add an error report.
Data is expected in the POST.
id={id} ID of the record tht is being commented. Usually a deed.
name={val} Name of the user who wrote the report.
email={val} Email of the user who wrote the comment.
subject={val} Subject/summary of the entered report.
body={val} Full body of the entered report.
type={string} Optional reaction / error only required when an email notification needs to be send
url={string} Optional link to the record only required when an email notification needs to be send
Errors will always be shown in error property example:

{
"error": {
"code": 400,
"message": "Could not find the requested record."
}
}

  • /question

    Method: get 
                    
Fetch comments
Example request: /{id}/?apiKey={key}
Errors will always be shown in error property example:

{
"error": {
"code": 400,
"message": "Could not find the requested record."
}
}

  • /question/count

    Method: get 
                    
Get error reports' count for this record.
Example request: /{id}/count?apiKey={key}
Errors will always be shown in error property example:

{
"error": {
"code": 400,
"message": "Could not find the requested record."
}
}

  • /question

    Method: post 
                    
Add an error report.
Data is expected in the POST.
id={id} ID of the record tht is being commented. Usually a deed.
name={val} Name of the user who wrote the report.
email={val} Email of the user who wrote the comment.
subject={val} Subject/summary of the entered report.
body={val} Full body of the entered report.
type={string} Optional reaction / error only required when an email notification needs to be send
url={string} Optional link to the record only required when an email notification needs to be send
Errors will always be shown in error property example:

{
"error": {
"code": 400,
"message": "Could not find the requested record."
}
}

  • /person

    Method: get 
                    
Search.
This endpoint receives the following parameters:
q={searchterm} global search term could search on specific fields e.g. field:{term}
page={number} result offset
rows={number} amount of rows to return in resultset, default 100 max 1000
facetFields[]={field1} Field to return facets for
facetFields[]={field2} Field to return facets for
fq[]={field1:"value x"} Apply filter to query
fq[]={field2:"value y"} Apply filter to query
qf={title^20.0+text^10.0} Apply boosting per field to improve search results
sort={field asc, field2 desc} sort by field, to generate a random result it is possible to order on random{time} asc
lang={val} Two character language (if available e.g nl
f[{field}][{param}]={value} Field parameter override
Example request: /{object_type}/?apiKey={key}&q=*:*&page=1&rows=1&facetFields[]=string_s_v1_uiterlijke_vorm&facetFields[]=strings_s_v1_vervaardigers&facetLimit=2&fq[]=string_s_v1_uiterlijke_vorm:"foto's"
Errors will always be shown in error property example:

{
"error": {
"code": 400,
"message": "undefined field: \"strinxg_s_v1_uiterlijke_vorm\""
}
}

  • /person/{id:\{?[0-9a-f]{8}\-?[0-9a-f]{4}\-?[0-9a-f]{4}\-?[0-9a-f]{4}\-?[0-9a-f]{12}\}?}

    Method: get 
                    
Get detail of object
Request:
Example /{object_type}/{id}?apiKey={key}
Errors will always be shown in error property example:

{
 "error": {
     "code": 400,
     "message": "undefined field: \"strinxg_s_v1_uiterlijke_vorm\""
 }
}

  • /person/field

    Method: get 
                    
Provides info about filterable & search fields
Request:
Example /{object_type}/field/?apiKey={key}
example response:
{
  "fields": {
    "field": {
      "order": "order_s_omschrijving",
      "search": "search_t_omschrijving",
      "facet": "search_s_omschrijving"
    }
  }
}

  • /person/heatmap

    Method: get 
                    
Heatmap.
This endpoint will return a grid of values based on a bounding box.
It receives the following parameters:
geom=["-180 -90" TO "180 90"] the bounding box to which the grid will be based on
q={searchterm} global search term could search on specific fields e.g. field:{term}
fq[]={field1:"value x"} Apply filter to query
fq[]={field2:"value y"} Apply filter to query
qf={title^20.0+text^10.0} Apply boosting per field to improve search results
Example request: /person/heatmap/?apiKey={key}&q=*:*&geom=["-180 -90" TO "180 90"]&fq[]=string_s_v1_uiterlijke_vorm:"foto's"
Response:

{
   "geo": {
       "columns": 12,
       "grid": [
           [
               1,
               ...
           ],
*			...
       ],
       "gridLevel": 2,
       "maxX": 90,
       "maxY": 90,
       "minX": -45,
       "minY": -90,
       "rows": 32
   }
}

Errors will always be shown in error property example:

{
"error": {
"code": 400,
"message": "Bad request"
}
}

  • /autocomplete

    Method: get 
                    
Autocomplete
Example request: /autocomplete?q=ker
Example response will be as following:

{
    "autocomplete": {
        "ker": {
            "suggestion": [
                "kerk",
                "kerkbuurt"
            ]
        },
        "collation": "kerk"
    }
}