coretgenealogie

Genealogical API's » Genealogie Online doorzoeken » GenealogyService

Waarschuwing: deze API wordt niet meer actief ondersteund tenzij hier behoefte naar is!


Beschikbare API - GenealogyService

De zoekmogelijkheid die wordt geboden is gebaseerd op de SOAP webservice interface zoals deze door phpGedView wordt gedefinieerd. Deze keuze is geïnspireerd door het Distributed Family Tree Project en het in dit kader ontwikkelde Genesis programma dat gebruik maakt van deze webservice (en ook Genealogie Online via de hier beschreven webservice doorzoekt).

Van de 10 functies in phpGedView's webservice is er een drietal, die te maken hebben met het zoeken. Alleen deze drie zijn geïmplementeerd en bereikbaar via het endpoint http://www.genealogieonline.nl/pgv/genservice.php (WSDL):

De WSDL van deze webservice (op het http://www.genealogieonline.nl/ domein) toont alle functies, maar alleen de 3 hier genoemde functies zijn gerealiseerd! De overige geven een SOAP fault met melding not implemented.

Hieronder worden de 3 functies toegelicht. Dit is grotendeels een kopie van PhpGedView's webservice beschrijving, gecomplementeerd met enkele opmerkingen mijnerzijds (deze zijn vetgedrukt).

ServiceInfo

Provides information about the server and what it supports. Note: Only method that does not require authentication.

Parameters

ServiceInfo does not take any parameters!

Returns - ServiceInfo

Name Description
compression Comma delimited list of supported compression libraries (ie. none,zlib,zip)
apiVersion Version of the API
server The server's identification (ie. PHPGedView 3.4)
gedcomList ArrayOfGedcomList(Complex Type)
- title Title of the gedcom
- id Gedcom id

Authenticate

Logs you into the service. Allows you to set the default gedcom and compression methods to use. All methods require the session id returned from this method with the exception of ServiceInfo.

This implementation doesn't provide functions which require logon, so username/password should be blank!

Parameters

Name Description
username Username that has been created on the service you are trying to connect to. Leave blank to connect as a guest.
Password Password for the provided username. Leave blank to connect as a guest.
gedcom_id The gedcom id to use for all calls to the service. Defaults to the default gedcom set by the server. See also: ServiceInfo for a list of gedcoms on the server.
Compression Not implemented - Choose the compression library to use. See also: ServiceInfo for a list of supported libraries

Returns - authResult

Name Description
SID Your session id. This must be provided when using any other methods of the service. Exception: ServiceInfo
Message Server message to give details about the authentication attempt.
gedcom_id The gedcom id that the server has chosen.
compressionMethod Not implemented - The compression method the server has chosen.

Search

Performs a basic or advanced search on the gedcom specified in Authenticate. Note: The following methods all require a session id acquired from Authenticate (not applicable for Genealogie Online).

Parameters

Name Description
SID Session id that was returned from Authenticate. This field is optional!
query Query string to search with (ie 'John')
Supports keyword searching in the following syntax:
field=value&field2=value2
Keywords: NAME, BIRTHDATE, DEATHDATE, BIRTHPLACE, DEATHPLACE, GENDER, SURNAME
Start Index of results to start at. To retrieve results 50 - <maxResults> you set start at 50. Optional, default is 0.
maxResults Maximum number of results to return. Optional, maximum (and default) is 50.

Returns - SearchResult

Name Description
totalResults Total number of results found.
Persons ArrayOfPerson(Complex Type)
- PID Person ID. This ID can be used to construct the URL of the person on the Genealogie Online website (just prepend http://www.genealogieonline.nl/pgv/individual.php?pid={pid}); this is conform the phpGedView construct. The ged={gedcom_id} part of the (phpGedView) URL is not used within Genealogie Online.
- gedcomName Person's name in gedcom syntax
- birthDate Date of birth
- birthplace Place of birth
- deathPlace Place of death
- deathDate Date of death
- gender Gender
- gedcom Returns an empty string. See getPersonByID to retrieve gedcom. This part is left blank!

Gebruik

Er kan gratis gebruik gemaakt worden van deze API.

Het wordt op prijs gesteld als er een link opgenomen wordt naar https://www.genealogieonline.nl/ en/of één van de logo's zichtbaar gemaakt wordt: