Difference between revisions of "Api"

From Wiki

Jump to: navigation, search
(Wikified all except for the 3 tables.)
m
Line 58: Line 58:
 
* include_merges - add full profile info to result.
 
* include_merges - add full profile info to result.
  
=== Notes ===
+
== Notes ==
  
 
= Tree Access =
 
= Tree Access =
Line 80: Line 80:
 
* Children ids.
 
* Children ids.
  
=== Notes ===
+
== Notes ==
  
  
Line 116: Line 116:
 
* t2 (cropped thumbnail).
 
* t2 (cropped thumbnail).
  
=== Notes ===
+
== Notes ==

Revision as of 20:20, 9 March 2010


API Notes

  • OAuth authentication.
  • Can also make calls using web browser once you're logged in.
  • First pass will be read-only.


Global Parameters

These parameters can be used in any API call.

Formats:

  • json.
  • ged (GEDCOM 5.5).
  • xml (not-GEDCOM 6).


Profile Access

geni.com/api/v1/profiles/current.<format>?<parameters> current user's profile
geni.com/api/v1/profiles/<id>.<format>?<parameters> profile for given ID
geni.com/api/v1/profiles.<format>?<parameters> your immediate family
geni.com/api/v1/profiles.<format>?ids=<id,id,...>?<parameters> profiles for given IDs (up to 50)

Fields:

Permission required for some.

  • First Name.
  • Middle Name.
  • Last Name.
  • Display Name.
  • Birth Event Id.
  • Birth Date.
  • Birth Location.
  • Death Event Id.
  • Death Date.
  • Death Location.
  • Residence Event Ids.
  • Current Location/Place of Burial.
  • Merge profile ids.
  • TBD (feel free to add desired fields here).

Parameters:

Permission required for some.

  • include_events - add full event details (including location) to result.
  • include_merges - add full profile info to result.

Notes

Tree Access

geni.com/api/v1/trees/<walk>/<id>.<format> walk starting with other profile

Walks:

  • ancestors.
  • blood_tree.
  • descendants.
  • forest.
  • immediate_family.

Fields:

  • Marriage id.
  • Partner ids.
  • Children ids.

Notes

Event Access

TBD

Media Access

Photos, Videos, Documents, Links, ...

geni.com/api/v1/media/<id>.<format> meta-data for media
geni.com/api/v1/media/tagged.<format>?profile_id=<id> meta-data for media tagged with id
geni.com/api/v1/media/photo/<id>-<size> jpeg photo by id and size
geni.com/api/v1/media/video/<id> flv video by id

Sizes:

  • original.
  • large.
  • medium.
  • small.
  • t (thumbnail).
  • t2 (cropped thumbnail).

Notes

Personal tools