Skip to content

Schema for National Target Mapping

This section provides an overview of the schemas related to the National Target Mapping. Each schema details the structure and fields required for the related requests and responses.

NOTE

When making an API request using the National Target Mapping schema, it is crucial to include the correct schema identifier. The schema parameter must be set to "nationalTarget7Mapping" 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.

TitleFieldMandatoryTypeExample
headerEheader{ "schema": "nationalTarget7Mapping", "identifier": "CEA6211F-DCA8-9403-E98F-51B4DD28ADAB", "languages": [ "en", "ab" ] }
GovernmentgovernmentTrueEterm{ "identifier": "af" }
globalGoalOrTargetEterm
Elements of the global targets addressed by national targets (Please also include which aspects of the global targets have not been covered by the national targets)elementOfGlobalTargetsInfoTruelstring{ "en": "

Test Info

" }
Reference PeriodreferencePeriod[ { "headlineIndicator": { "identifier": "GBF-INDICATOR-1.1" }, "hasReferencePeriod": True, "referencePeriodInfo": { "en": "

TEst Info

" } } ]
headlineIndicatorEreference
Is there a reference period which relates to the headline indicator?hasReferencePeriodboolTrue
referencePeriodInfolstring
additionalInformationlstring
additionalDocumentsElink[]