Schema for NDB
This section provides an overview of the schemas related to the National Websites or Databases (NDB). Each schema details the structure and fields required for the NDB-related requests and responses.
NOTE
When making an API request using the National Websites or Databases (NDB) schema, it is crucial to include the correct schema identifier. The schema parameter must be set to "database" 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 | { "identifier": "A48DBA58-485D-F2EB-1EB7-D5FF950BDD26", "schema": "database", "languages": [ "en" ] } | ||
| Country | government | True | Eterm | { "identifier": "af" } |
| Website or database name | title | True | lstring | { "en": "Test Info" } |
| Description | description | True | lstring | { "en": "<div><!--block-->Test Description</div>" } |
| Website address | websites | True | Elink[] | [ { "url": "https://www.google.com", "name": "Google", "language": "en" } ] |
| Any other relevant information | relevantInformation | lstring | { "en": "<div><!--block-->Test Info</div>" } | |
| Any other relevant documents | relevantDocuments | Elink[] | [ { "url": "https://www.google.com", "name": "Google", "language": "en" } ] |