Schema for NBSap
This section provides an overview of the schemas related to the NBSap. Each schema details the structure and fields required for the related requests and responses.
NOTE
When making an API request using the NBSap schema, it is crucial to include the correct schema identifier. The schema parameter must be set to "nbsap" to ensure that the request is processed correctly and targets the appropriate data structure. Failure to provide the correct schema may result in an error or unexpected behavior in the response.
| Title | Field | Mandatory | Type | Example |
|---|---|---|---|---|
| header | Eheader | { "schema": "nbsap", "identifier": "B3BE683C-81B0-91D4-35A4-F5A21935017D", "languages": [ "en", "ab" ] } | ||
| Government | government | True | Eterm | { "identifier": "af" } |
| Enter NBSAP title | title | True | lstring | { "en": "Test Info" } |
| Summary | summary | lstring | { "en": "<p>Test Info</p>" } | |
| Level of application | jurisdiction | True | Eterm | { "identifier": "7437F880-7B12-4F26-AA91-CED37250DD0A" } |
| Additional Information (Level of application) | jurisdictionInfo | lstring | ||
| Is the submission in alignment with the Kunming-Montreal Global Biodiversity Framework? | isGbfAligned | True | bool | True |
| From | startDate | True | Datetime | 2024-11-01 |
| To | endDate | True | Datetime | 2024-11-20 |
| Status | status | True | Eterm | { "identifier": "9D17F3A2-EC92-4D31-81EF-A12521873D7F" } |
| completionYear | string | |||
| Date of completion and adoption | adoptionDate | string | 2024-11-01 | |
| Status of approved document | approvedStatus | Eterm | { "identifier": "EE6F3AAE-E365-46C3-B73F-ED5FE3DFAACA" } | |
| Approving body | approvingBody | Eterm | { "identifier": "EFAF31F0-1E48-4165-B60B-B55F132DB932" } | |
| Please select approving body | approvingBodyInfo | lstring | { "en": "<p>Test Info</p>" } | |
| documentText | lstring | |||
| NBSAP document(s) and websites, links or other relevant document(s) | documentLinks | True | Elink[] | [ { "url": "https://www.google.comm", "name": "Google", "language": "en" } ] |
| Please use this field to provide any other relevant information that may not have been addressed elsewhere in the record. | relevantInformation | lstring | { "en": "<p>Test Info</p>" } | |
| relevantDocuments | Elink[] |