Overview
This API is to enable submission and review GUIs to communicate with the allocations database
to create, update, view, and delete requests and reviews.
The API specification is RESTful in that it uses HTTP methods (GET, POST, PUT, and DELETE)
to interact with the allocations database. The HTTP responses are always in JSON format.
The API supports multiple allocations processes, where allocations processes are different clients.
The allocations process is specified using HTTP request headers
assumes at least the following:
- Requests are prepared for, and submitted to, a specific submission opportunity (e.g., Startup, or XRAC).
- Requests will have a PI, possibly a list of CO-PIs, a submitter, a title, a type, supporting documents
(e.g., PI vita), etc.
- Requests contain a list of requested resources.
- Resources have requested amounts. The amount that can be requested may have limits
- Not all resources may be available for all submission opportunities and request types,
and may vary across submission windows.
- A resource may have supplementary set of questions and answers to support the review of the request.
- People at the allocations process have a unique username