Sketching more detailed API Endpoints

[timgdavies]

In this hackpad we did some work this week sketching out potential further API methods that might be required by more advanced applications, including search, list and aggregate endpoints.

Opening this issue to keep track of that work.

@yolile was taking forward some of the ideas from this, particularly to be able to drive more visualisations from OCDS data.

[andrewlorien]

That’s great, thanks.

Over the next month we’ll be working on an API based on the data available at https://www.tenders.nsw.gov.au/?event=public.advancedsearch.home

Like the html form, the API will return either a single object or a list of objects based on 8-12 search parameters. I hadn’t considered pagination until yesterday, and I think we will offer it (we are concerned about server load and the possibility of an unintended DoS - limiting the maximum number of results per page but allowing pagination is a good solution).

We are not changing the queries we currently use for the HTML, just adding a view to map the data currently presented as HTML to the OCDS json standard. And we don’t have pretty URLs. So our endpoints will be something like ?event=API.Contract.search and ?event=API.Contract.View, and the fields returned will be exactly the same as the ones currently available in the HTML search (with a few extra elements to comply with the OCDS standard).

So. That’s an invitation from us. I’ll keep you up to date.

andrew

From: Tim Davies [mailto:notifications@github.com] Sent: Tuesday, 13 December 2016 4:27 AM To: open-contracting/api-specification Subject: [open-contracting/api-specification] Sketching more detailed API Endpoints (#3)

In this hackpad https://hackpad.com/Open-Contracting-Toolbox-API-t4RA7IQHX26 we did some work this week sketching out potential further API methods that might be required by more advanced applications, including search, list and aggregate endpoints.

Opening this issue to keep track of that work.

@yolile https://github.com/yolile was taking forward some of the ideas from this, particularly to be able to drive more visualisations from OCDS data.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/open-contracting/api-specification/issues/3 , or mute the thread https://github.com/notifications/unsubscribe-auth/AKbSYRKv1gtbwi1fzolc5Tfioxs6wnopks5rHYPOgaJpZM4LKzrs . https://github.com/notifications/beacon/AKbSYQqXThuzMFReyYjQPX65xnKHnRH7ks5rHYPOgaJpZM4LKzrs.gif

[KrzysztofMadejski]

I'd add to that POST/PUT endpoints to be able to push data from integrated services.

[tian2992]

Can you please update the link, as Hackpad was deprecated by Dropbox.

[jpmckinney]

Closing, unless Tim has a backup of the hackpad.