PD Publisher : Rest API (status) - Githubissues

phax / phoss-directory

The official Peppol, TOOP and DE4A Directory software

Apache License 2.0

15 stars 6 forks source link

PD Publisher : Rest API (status) #25

Closed ssinatti closed 7 years ago

ssinatti commented 7 years ago

Good evening Philip,

Talking about REST API of PD publisher, what is the status of it? If I try to call, for example, the https://test-directory.peppol.eu/search/1.0/xml/q=test the response is : <something-will-be-here-soon be="patient" /> My goal is call from my platform the Rest APIs that I would expect are exposed by PD publisher based on query specification (6.1 Search interface).

Thank you very much for the support.

Stefano

phax commented 7 years ago

Hi Stefano. This part of the spec has not been implemented yet. I will try to focus on it...

phax commented 7 years ago

The initial "q" query works locally - both for XML and JSON output. Maybe some tuning is needed, because currently the document types are returned redudantly. I think a grouping by participant ID might help.

Edit: remove invalid example code!

phax commented 7 years ago

I decided to group the results. Edit: remove invalid example code!

ssinatti commented 7 years ago

Thank you very much Philip, a real good work, but at the moment, If I have understood correctly, this solution works only locally (on you machine), am I right?

Stefano

phax commented 7 years ago

Yes. I will deploy as soon as possible. I need to harden it a bit...

ssinatti commented 7 years ago

Ok no problem! at the moment I am focused on other topics regarding PD. Thank you very much and take me updated.

Stefano

phax commented 7 years ago

The new version is online. All the searching according to the specs should work. Next thing is to document it at http://directory.peppol.eu/public/locale-en_US/menuitem-docs-rest-api

phax commented 7 years ago

Can this be closed?

ssinatti commented 7 years ago

I'm working on it, in case of problems/doubts I will open another thread, if you prefer.

Thanks, Stefano

phax commented 7 years ago

I would like to modify the XML output slightly, so that the casing and the namespace handling are a bit more consistent. Please send me your email address again - don't have it with me. Please send it to pd@helger.com - thanks

phax commented 7 years ago

Anyway here are the changes I did afterwards:

General - search term identifier was renamed to identifierValue. identifierScheme was added.
The header attribute creation-dt was added. It contains an UTC timestamp of when the response was rendered
JSON output:
- items was renamed to matches
XML output:
- was completly reworked to fit the requirements. Using the input format BC format is not an option

Open issues I will create

The spec PDF document needs updating - #27
An XML Schema for the response document would be good - #28
~~Put the changed version live~~

Documentation is now available at http://directory.peppol.eu/public/locale-en_US/menuitem-docs-rest-api

phax commented 5 years ago

The XSD for the REST API is now available at http://directory.peppol.eu/files/directory-search-result-list-v1.xsd