Issue 11950

Update Webservice API wiki

Reporter: mdoering
Type: Task
Summary: Update Webservice API wiki
Priority: Critical
Resolution: Fixed
Status: Closed
Created: 2012-09-26 14:36:27.485
Updated: 2013-09-26 22:43:43.736
Resolved: 2013-09-26 22:43:43.702
Description: is missing:
 - occurrence search
 - cube metrics ws
 - crawling metrics ws

Also we will unify the webservices and group them behing a single base url, e.g.
The wiki should therefore document this unified setup, merge all methods into a single table and an indication which webapp serves which part of the api.]]>

Created: 2013-01-09 12:34:32.332
Updated: 2013-01-09 12:34:32.332

To our API wiki, I have recently added:

Occurrence Services: Search Service
Checklist Bank Services: Metrics
Cube Metrics Services: Occurrence Service
Cube Metrics Services: Taxon Occurrence Service

Still outstanding, is crawling metrics ws. [] Are the crawling metrics ws still undergoing a lot of changes, or do you think it's fine for me to add them to our API wiki? Thanks.


Comment: They will probably change still but hopefully only minor changes so please go ahead. Thank you!
Created: 2013-01-09 12:37:09.926
Updated: 2013-01-09 12:37:09.926

Comment: I dont think we need to document the crawler ws now. Is it of interest to the public now?
Created: 2013-01-09 12:37:43.333
Updated: 2013-01-09 12:37:43.333

Created: 2013-01-09 13:50:57.457
Updated: 2013-01-09 13:50:57.457
For consistency across webservices, it's helpful to have them all listed in one place. For example, reviewing whether they all use the same parameter name format. It's also helpful as a reference point of what is currently working, and what is not.

Furthermore, since all webservices are being unified behind it's also nice to ensure our public API mapping is being maintained, despite whether there is public interest now or not. 

Created: 2013-01-11 19:04:12.437
Updated: 2013-01-11 19:04:12.437
I have added what I could for the crawler service. Please see here:

Please note the crawler service is has not been mapped in our public API yet, e.g. Shall I create an issue for this?

If there are edits needed to the API document, please just let me know. Thanks.

Created: 2013-01-18 15:57:36.007
Updated: 2013-01-18 15:57:36.007
Additional services added to occurrence download:

Also added: an indication of which webapp consumes which service, see Current consumer(s) sub section of each service.

Created: 2013-01-23 17:11:20.774
Updated: 2013-01-23 17:11:20.774
Outstanding, is to merge all methods into a single table but I prefer to keep the different web services separated.

The majority of web services have been mapped to the public API, and available behind a single base url, e.g.

The following web services are working on staging, but not on (see issue: )

Should I create a general issue to map all these, or an issue per service?

Created: 2013-01-24 11:21:25.92
Updated: 2013-01-24 11:21:25.92
Please create a new issue, assign it to me and relate it to POR-427.
Just to see how we name resources and use singular/plural a single table for the entire API would be helpful.

Created: 2013-01-24 16:49:08.709
Updated: 2013-01-24 16:49:08.709
Done as you wished [], see POR-492

I have since added summary tables for general web services, and search web services. Please see: 

Created: 2013-08-21 10:44:56.794
Updated: 2013-08-21 10:44:56.794
Following the release of registry2, I updated the API wiki's registry web services, excluding the registry search services.

I also removed the summary tables, since we agreed it cluttered the page duplicating the services in 2 places.

Comment: this will be deprecated in favour of the portal api pages
Created: 2013-09-26 22:43:43.734
Updated: 2013-09-26 22:43:43.734