IFRCGo / go-api

MIT License
13 stars 6 forks source link

Creating HXL outputs #368

Open SimonbJohnson opened 5 years ago

SimonbJohnson commented 5 years ago

Documenting the process needed for creating HXL outputs. Roughly mapping from the API for ease.

The HXL standard http://hxlstandard.org/

Documenting tagging here: https://docs.google.com/spreadsheets/d/1aQOOzqZdQtHRO33bAAfBBnERF4y-xNgHkIR0hCJv7ek/edit#gid=0

SimonbJohnson commented 5 years ago

Is there a data definition document? The are some variables I can't figure out on https://prddsgocdnapi.azureedge.net/api/v2/appeal/

szabozoltan69 commented 5 years ago

There is an API documentation here: https://prddsgocdnapi.azureedge.net/docs/

Concerning the appeals I recommend https://github.com/IFRCGo/go-api/blob/master/api/models.py, especially for atype and status see https://github.com/IFRCGo/go-api/blob/master/api/models.py#L366-#L377

Concerning the appeal table it can be also useful: https://osztalyta.li/go/tables/api_appeal.html

dereklieu commented 5 years ago

@SimonbJohnson if you're wondering how appeals data maps to what you see on that page, this script is a lot of it: https://github.com/IFRCGo/go-api/blob/master/api/management/commands/ingest_appeals.py

SimonbJohnson commented 3 years ago

I was speaking to Luke Caley today about getting HXL outputs for some of the GO API. I've been creating them myself on the follow repo: https://github.com/SimonbJohnson/ifrc_HXL

What do I need to provide to have HXL outputs in GO with appropriate guidance/documentation?

LukeCaley commented 3 years ago

Xref: https://github.com/IFRCGo/go-frontend/issues/1819

nanometrenat commented 2 months ago

@LukeCaley @ypyelab I know there are HXLated GO datasets on HDX these days - are the HXL/GO API mappings documented somewhere public? i.e. is there still work required under this ticket or can it be closed? Cheers!

https://hxlstandard.org/ cc @arunissun