Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

Table of Contents

OpenSpecimen v2.0 exposes REST APIs that can be consumed to developed custom interfaces and and for integration with other databases. The REST APIs will be consumed by the OpenSpecimen v2.0 User Interface.

Common Characteristics of REST Resources

...

codeApplies toStatus Message
200All resources 
201All POST/PUT requestsResource created/updated successfully
400All requestsInvalid parameters, this will also includes application specific error messages
401All requestsAuthorization failed
403All requests 
404All requestsResource not found, also includes specified resource id/name/title
500All requestsInternal server error

On this page, when a portion of a URL, path, or parameter value is shown in italics, it indicates that you should replace the italicized value with a particular value appropriate to your request.

Authentication

OpenSpecimen REST API's are signed requests, accessible to all the users who has access to OpenSpecimen application. To access the REST API's user need to pass their OpenSpecimen credentials by setting them in request Authorization header. The username/password should be encoded in base 64 encoding scheme.

Unauthenticated APIs

Given below is list of APIs that do not require user authentication

...

Child pages (Children Display)