Project

General

Profile

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 Publishers 
 ============================================================== ==================================================== 

 Phycobank is a registration for algal names and types. Phycobank will actually create registration for whole nomenclatural acts which can encompass 0 - 1 new scientific 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 Isosyntype, Isotype, Lectotype, Neotype, Paralectotype, Paraneotype, Paratype, Second step lectotype, second Second step neotype & syntype. Syntype. 


 Phycobank aims in establishing a workflow with publishers. Phycobank aims in realizing The this interaction will for the first time be done with Pensoft Publishers. pensoft. 

 This document describes the basic principles of the interaction between Phycobank phycobank and Pensoft Publishers 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). preprint@pensoft.net) .  

 ## Authentication/authorization 

 The Publisher will need to be authenticate at Phycobank Phycobenk via HTTP-Basic authentication. Authorization at Phycobank is established 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 receive: recveive: 

 * An HTTP error code (400) with a detailed error message in case the submitted subitted data was causing carating a problem in the phycobank system. phycobanksystem 
 * the preliminary persistent preliminar persitend identifier (http://phycobank.org/{integer}) for the nomenclatural act. The identifier is not made public at this point. 

 In Phycobank the user that initiates a registration is called **submitter**. The **submitter** is the only user except of the *curator* who can change a registration. There is only one submitter per registration. Pensoft will therefore the    **submitter**    of all registrations created on behalf of the authors which submit publications at Pensoft with nomenclatural acts.  

 ## Receiving messages from pyhcobank during the edit and curation process 

 The submitted registration Registration record will undergo a manual curation process which may result in a notifications notifications/annotation on the registration Registration record. Notifications may report invalidity of the submitted data and thus may be requests for improving fixing problems in the submitted nomenclatural act.  

 Notifications notifications/annotation associated with a specific registration Registration will be accessible via another webservice. a nother websercice. This webservice expects expectes the local_identifier contained in int the    phycobankID (http://phycobank.org/{{local_identifier}}) 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 

 Once the curator accepts the submitted nomenclatural act the registration status will be set to `READY`. Now the submitter can release the registration by making use the following webservice  

 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`, 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' 

 ---- 
  

Back