NBSAP - Get
Overview
This documentation describes the API endpoint for retrieving a specific NBSAP record using the GET method. This endpoint allows clients to fetch detailed information about a record from the system using its unique identifier (uid). It is used to retrieve and view the details of an existing record.
Endpoint
GET /api/v2013/documents/:uid
Headers
The request must include the following headers:
| Field | Type | Description |
|---|---|---|
| Content-Type | String | Indicates the format of the data being sent in the request body. This header specifies the media type and encoding of the request payload. The allowed value is application/json, meaning that the request body is formatted as JSON. This helps the server understand how to parse and interpret the incoming data. |
| Realm | String | Defines the specific context or domain within which the Clearing-House request is being made. This header determines the environment or operational scope for the request. Allowed values include abs (Access and Benefit-sharing Clearing-House), chm (Central Clearing-House Mechanism), and bch (Biosafety Clearing-House). Each value represents a different area of functionality or service. |
| Accept | String | Specifies the format in which the client prefers to receive the response data. This header informs the server of the desired response format to ensure compatibility with the client’s data processing. The allowed value is application/json, indicating that the client expects the response to be formatted in JSON. This ensures the response data is structured in a way that the client can properly handle and interpret. |
Realm Values:
| Applications | Development Realm | Production Realm |
|---|---|---|
| Online Reporting Tool | ort-dev | ort |
URL Parameters
The following URL parameter is required:
| Field | Type | Description |
|---|---|---|
| uid | String | A unique identifier for the record. This value is case-sensitive and must conform to the regular expression /^[A-Za-z0-9\-_]{11,128}$/. This pattern allows for a combination of uppercase and lowercase letters, numbers, hyphens, and underscores, with a length ranging from 11 to 128 characters. The uid is crucial for uniquely identifying and retrieving the record within the system, ensuring that each record can be distinctly referenced and managed. It plays a key role in operations such as fetching, updating, or deleting the record, as well as in maintaining the integrity of record management processes. |
Playground
Swagger playground is loading, please wait...