WikiTree App Interfaces
- Profile
- Images
Date:
[unknown]
[unknown]
Location: [unknown]
Surname/tag: WT_APPS
Location: [unknown]
Surname/tag: WT_APPS
This page has been accessed 789 times.
Contents |
Introduction
The following is intended for use by WikiTree app developers, and documents parameters for several WikiTree apps. Use this if you wish to start an app from another app (or another location).
The entry point for an app is a URL in the form https://apps.wikitree.com/apps/userAccount/appname where 'userAccount' is the app server user account (based on the user's WikiTree ID) and 'appname' is a directory (appname/) or filename (appname.php). Arguments follow in the URI in the form ?name=val&name=val&name=val
This App Link Builder tool uses the parameters below to automatically produce customized links to the apps.
BioCheck
A tool to check profile sources by Kay (Sands) Knight. Help: BioCheckHelp.
Base URL
Parameters
- action - the action to execute. The default is checkQuery. Action can have any of the following values:
- checkQuery - check results from a WikiTree+ search using the parameters:
- query - the string to use for a WikiTree+ text/search. This is required for action=query.
- maxProfiles - the maximum number of profiles to return from a WikiTree+ search. This is optional; when not supplied the default of 1000 is used.
- checkProfile - check a specific profile using the parameters:
- profileId - the WikiTree ID. This is required for action=checkProfile.
- numAncestorGen - the number of ancestor generations to check. This is optional; when not supplied the default of 5 is used.
- numDescendantGen the number of descendant generations to check. This is optional; when not supplied the default of 2 is used.
- checkWatchlist - check profiles on the watchlist for the signed in user
- checkRandom - check a random set of profiles
- checkChallenge - check a challenge tracked by WikiTree+
- challengeName - name of the challenge to check
- challengeDate - date of the challenge in the form YYYYDDMM
- WikiTreeID - WikiTree Id for the challenge contributor
- checkStart - a value of either user or auto. When set auto the check will run immediately. The default is user.
Examples
- https://apps.wikitree.com/apps/sands1865/biocheck/?action=checkQuery&query=gedFile=export_bloodtree.ged&maxProfiles=500&checkStart=auto
- https://apps.wikitree.com/apps/sands1865/biocheck/?action=checkProfile&profileId=Sands-1865&numAncestorGen=4&numDescendantGen=1&checkStart=auto
- https://apps.wikitree.com/apps/sands1865/biocheck/?action=checkWatchlist&checkStart=auto
- https://apps.wikitree.com/apps/sands1865/biocheck/?action=checkChallenge&challengeName=SourcerersChallenge&challengeDate=20231001&WikiTreeID=Sands-1865&checkStart=auto
FanChart
A tool to display your Ancestors in a Fan Chart by Greg Clarke. Help: About the WikiTree Fan Chart app Base URL
Parameters
- id - the WikiTree ID for the primary person in the Fan Chart. The ID can be the WikiTree Name (e.g. Clarke-11007) or the WikiTree ID # (e.g. 19066309 )
- Note: using none as the id will give you a Blank Fan Chart that you can use as a template
- NumGens - the number of generations to display initially (default: 5)
- ph - the phase number for the app.
- ph=1 is required when you wish to generate a new Fan Chart from a new ID
- ph=0 will take you to the New Fan Chart entry screen where you can enter your own WikiTree ID (which is what will happen if the Fan Chart app is called without any parameters)
- Other parameters:
- Every setting has a unique parameter with options, and they can also be called directly from the initial URL. An exhaustive list will be published in the Fan Chart help document, soon to be updated. Here are some of the most popular:
- XDs - determines which exact dates are displayed
- Y - shows Full birth date and Full death date
- YY - shows the LifeSpan (from YYYY - YYYY )
- B - shows Birth Date and Location
- D - shows Death Date and Location
- X - shows both Birth and Death Dates and Locations
- font - determines which font to display in the cells of the Fan Chart
- options include: Arial, Courier, Times
- showHighlights - whether to show the Name Highlight rectangles under each name in the Fan Chart (default is now N)
- options are Y or N
- showWedgeBackgrounds - whether to colour in each wedge of the Fan Chart (default is now N)
- options are Y or N
Examples
- https://apps.wikitree.com/apps/clarke11007/fan.php?ph=1&id=none
- https://apps.wikitree.com/apps/clarke11007/fan.php?ph=1&id=Clarke-11007&font=Times&XDs=X
- https://apps.wikitree.com/apps/clarke11007/fan.php?ph=1&id=Clarke-11007&NumGens=6&XDs=Y&showWedgeBackgrounds=Y&showPhoto=Y&showPhotos=Y&ColourBy=GGPs&palette=Pastels
Profile Overview
Profile Overview gives a visual overview of a group of people.
Base URL
Parameters
- view - the view to display (default: the most recently used view (except for 'watchlist') or 'ancestors'). View can have any of the following values:
- ancestors - view ancestors using the parameters:
- id - WikiTree ID
- genNum (optional) - the number of generations of ancestors to display (max: 10; default: the most recently used value or 5).
- descendants - view descendants using the parameters:
- id - WikiTree ID
- genNumD (optional) - the number of generations of descendants to display (max: 5; default: the most recently used value or 2).
- relatives - view relatives using the parameter:
- id - WikiTree ID
- watchlist - view watchlist. This returns your watchlist ordered by WikiTree ID. You must be logged in for this. It uses the following optional parameters:
- offset - which profile to start from (default: 0)
- limit - the length of the result list (default: 150; max: 250)
Examples
- Up to 6 generations of Charles Darwin's ancestors:
- Up to 4 generations of George Beacall's descendants:
- Queen Victoria's relatives (parents, spouse, siblings, children):
- 100 people from your watchlist, starting at number 2300:
Surnames Generator
A tool to list your Ancestors' Surnames for use in a Profile or Free Space page.
Base URL
Parameters
- id - the WikiTree ID for the primary person in the Surnames List. The ID can be the WikiTree Name (e.g. Clarke-11007) or the WikiTree ID # (e.g. 19066309 )
- maxGens - the number of generations ABOVE the primary person to search for Surnames (default: 6)
- ph - the phase number for the app.
- ph=0 will take you to the entry screen where you can enter your own ID and # of generations
- ph=1 is required when you wish to automatically generate a Surnames List
- Note: This app requires the user to be logged into the APPS server, so, despite the parameters sent to it, if the user hasn't already logged in via another app on the server, you will be presented with the screen showing the CLIENT LOGIN button
Examples
- Open up to data entry screen:
- Automatically generate a surnames chart for the app developer:
Collaboration
- Login to edit this profile and add images.
- Private Messages: Contact the Profile Managers privately: Kay Knight and Greg Clarke. (Best when privacy is an issue.)
- Public Comments: Login to post. (Best for messages specifically directed to those editing this profile. Limit 20 per day.)
Comments
Leave a message for others who see this profile.
There are no comments yet.
Login to post a comment.