task #7012
Updated by Andreas Kohlbecker over 6 years ago
Design and establish an partially automated workflow with Pensoft.
----
*The below concept is based on a discussion with Teodor Georgiev (preprint@pensoft.net) from Pensoft Publishers at the TDWG 2017 conference.*
Interaction workflow between Phycobank and Pensoft
====================================================
Phycobank is a registration for algal names and types. Phycobank will actually create registration for whole nomenclatural acts which can encompass 0 - 1 new scietific names and 0 - n typifications for the new or existing names. The different types of typifications cover Isosyntype, Isotype, Lectotype, Neotype, Paralectotype, Paraneotype, Paratype, Second step lectotype, Second step neotype & Syntype.
Phycobank aims in establishing a workflow with publishers. The this will for the first time be done with pensoft.
This document describes the basic principles of the interaction between phycobank and pensoft as discussed during the "Night at the museum" event at the TDWG conference 2017 (Andreas Kohlbecker, a.Kohlbecker@bgbm.org; Teodor Georgiev, preprint@pensoft.net) .
## Authentication/authorization
The Publisher will need to be authenticate at Phycobenk via HTTP-Basic authentication. Authorization at Phycobank is entablished on base of the OAuth 2.0 protocol.
## Initialization of the registration process triggered by the publisher:
Upon being authenticated the publisher can send the data of the nomenclatural act (Name, Types, Reference ) to a web service endpoint. The transport schema of the data (TCS, CDM, ...) is being discussed at the moment internally at Phycobank.
As response to the initial submission the publisher will recveive:
* An HTTP error code (400) with a detailed error message in case the subitted data was carating a problem in the phycobanksystem
* the preliminar persitend identifier (http://phycobank.org/{integer}) for the nomenclatural act. The identifier is not made public at this point.
## Receiving messages from pyhcobank during the edit and curation process
The submitted Registration record will undergo a manual curation process which may result in a notifications/annotation on the Registration record. notifications/annotation associated with Registration will be accessible via a nother websercice. This webservice expectes the local_identifier contained int the phycobankID being submitted:
Prospective service endpoint:
* http://api.cybertaxonomy.org/phycobank/registration/{local_identifier}/messages
* Response content type: json
* Resonse content: A list of all messages associated with the registration record sorted by time in ascending order.
* authorization required
## Requesting for the status of a registration record
HTTP-GET: http://api.cybertaxonomy.org/phycobank/registration/{local_identifier}/status
* authorization required
* The webservice responds with the current status which is one of:
* CURATION
* PREPARATION
* PUBLISHED
* READY
* REJECTED
## Publishing a registration identifier
A registration can only be published if the status is READY, otherwise any attempt to trigger the release stept will be rejected.
HTTP-POST: http://api.cybertaxonomy.org/phycobank/registration/{local_identifier}/status
Request body: 'PUBLISHED'
----