SESAR API’s and documentation

[ramdeensarah]

Dev testing

http://grg-doc-dev.ldeo.columbia.edu:8082/swagger-ui.html
Testing completed on 'Samples' and 'Group Samples'

Relates to the following GitHub issue https://github.com/earthchem/sesar/issues/76

Screenshots of all tests -- Dev Testing_SESAR_REST_API.pptx

Samples

• /v1/igsns/field_program
  Tested name parameter successfully using “Dry Valley Drilling Project” (pulled from database). Results match results from Sample Search tool in MySESAR. Tested limit and pagenum, both successful.

NOTE: List of parameters include hideprivate. This field is not described (later entry includes the following description “If hideprivate is set to 1, only IGSNs with public metadata will be returned.“

Error encountered when testing hideprivate. Private results displayed when hideprivate is left blank. When enter 1, error message is returned (instead of a message listing data private -- 401 or 403 might be more appropriate than 404?)

• /v1/igsns/geopass
  Tested successfully with my geopass ID (sarah.ramdeen@gmail.com). Test included limit and pagenum.

• /v1/igsns/geopassnum/{geopassnum}
  Tested successfully with my Geopass Number 3914 from database (sso_acount_id on sesar_user table). Test included limit and pagenum.
  NOTE: GeoPass number is only known to people with access to the database.

• /v1/igsns/total/geopassnum
  Tested successfully with my Geopass Number 3914 from database (sso_acount_id on sesar_user table).
  NOTE: GeoPass number is only known to people with access to the database.

• /v1/igsns/total/username
  Tested successfully with my geopass ID (sarah.ramdeen@gmail.com). Phrasing for the parameter description not consistent with listing above.
  NOTE: “Get total number of IGSN from SESAR according to geopass username” vs. “Get a list IGSNs from SESAR according to the user GeoPass login name” listed for /v1/igsns/geopass.

• /v1/igsns/usercode/{usercode}
  Tested successfully with my user code (ieser). Tested hideprivate -- only displays two public samples from total of 3 samples. Test included limit and pagenum.
  NOTE: all previous testing has shown all three of my samples. One is listed as private. Should it have been hidden? /v1/igsns/geopass, /v1/igsns/geopassnum/{geopassnum} and /v1/igsns/field_program.

• /v1/sample/id/{id}
  Tested successfully using ID from database (88409). Compared results with IGSN landing page for result (ODP003948) and with entry in database. All three match.
  NOTE: Sample ID number is only known to people with access to the database.

• /v1/sample/igsn/{igsn}
  Tested successfully using ODP003948.

• /v1/samples
  Tested successfully with Test API (private sample) and TestSampleUPDATED (public sample). Public sample displays full metadata record.

• /v1/vocabularies/collectionmethods
  Results from REST API (324) do not match the contents of Database (269). See example below.
  

• /v1/vocabularies/collectors
  Test successful. Results are 23261 records. Uncertain of best method to check results against database.
  Note: Is there an issue with fields which should be private?

• /v1/vocabularies/cruisefieldprograms
  Test successful. Results are 3590 records. Uncertain of best method to check results against database.

• /v1/vocabularies/physiogeographicfeatures
  Test successful. Uncertain of best method to check results against database.
  Note: Is there an issue with fields which should be private?

• /v1/vocabularies/platformnames
  Test successful. Uncertain of best method to check results against database.
  Note: Is there an issue with fields which should be private?

• /v1/vocabularies/platformtypes
  Test successful. Uncertain of best method to check results against database.

GroupSamples

• /v1/samples/downloadcsv/group
  Test successful using NSF:0727013 (example pulled from database).
  When no samples in group, returns an empty template. Tested using the following groups: TEST and SESAR 5 SAMPLES.
  

• /v1/samples/group
  Test successful using NSF:0727013. Test included limit and pagenum.

• /v1/samples/group/id/{id}
  Test successful. Used ID 8, for NSF:0727013. Checked first sample ID (3618459), verified in database it belongs to group 8. Servers down at Lamont, verified against SESAR Dev.
  Test of limit failed -- used 1, results not truncated.

• /v1/samples/group/id/{id}/limit/{limit}
  Test successful. Tested using Group ID 8, limit 1 and 2.

• /v1/samples/group/id/{id}/limit/{limit}/pagenum/{pagenum}
  Tested with group ID 8, limit 10, pagenum 1. Uncertain that pagenum does anything in combination with limit. Tested with group ID 1, changing limit changed results, changing pagenum does not change results. Both parameters are required.

• /v1/samples/group/id/{id}/pagenum/{pagenum}
  Tested successfully using Group 8. Test using group 1 fails.

• /v1/samples/total/group
  Test successful using group name NSF:0727013

• /v1/samples/total/group/id/{id}
  Test successful using group ID 8.