Schema for Stakeholder Commitment

This section provides an overview of the schemas related to the Stakeholder commitment (Stakeholder). Each schema details the structure and fields required for the stakeholderCommitment related requests and responses.

NOTE

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

The table below outlines the structure of the request body, including the fields, their types, and whether they are mandatory. Example values are provided for clarity.

Title	Field	Mandatory	Type	Example
	header		Header	{ "identifier": "CB51626B-CF45-2AA0-3A24-459669DDCC34", "schema": "stakeholderCommitment", "languages": [ "en" ] }
First Name	firstName	True	string	John
Last Name	lastName	True	string	Doe
Designation	designation	True	lstring	{ "en": "Software Engineer" }
Department	department	True	lstring	{ "en": "Division" }
Organization	organization	True	lstring	{ "en": "Test Organization" }
Organization acronym	organizationAcronym		lstring	{ "en": "CSBD" }
Type of Organization	organizationType	True	ETerm	{ "identifier": "86D464C3-B5BB-4B02-85E4-1AAD8D64CD27" }
Jurisdiction	jurisdiction	True	ETerm	{ "identifier": "86D464C3-B5BB-4B02-85E4-1AAD8D64CD27" }
Countries	jurisdictionCountries	True	ETerm[]	{ "identifier": "af" }
Regions	jurisdictionRegions	True	ETerm[]	[ { "identifier": "86D464C3-B5BB-4B02-85E4-1AAD8D64CD27" } ]
Title of commitment	title	True	lstring	{ "en": "example string" }
Description of commitment	description	True	lstring	{ "en": "example string" }
Start date	timelineStartDate	True	DateTime	2025-10-10
End date (if applicable)	timelineEndDate	True	DateTime	2025-10-10
Alternatively, indicate whether the commitment is open-ended	isOpenEnded	True	bool
Share information on plans for next steps	nextStepsInformation	True	lstring	{ "en": "example string" }
Key performance indicators...	performanceInformation		lstring	{ "en": "example string" }
CountryReviews...	endorsementsInformation		lstring	{ "en": "example string" }
Primary National Target	primaryGlobalAlignment	True	ETerm	{ "identifier": "86D464C3-B5BB-4B02-85E4-1AAD8D64CD27" }
Primary global target	primaryNationalTarget	True	EReference
Other Global Alignment(s)	otherGlobalAlignments		ETerm[]	[ { "identifier": "86D464C3-B5BB-4B02-85E4-1AAD8D64CD27" } ]
Other national target(s)	otherNationalTargets		EReference[]
Alignment Information	alignmentInformation		lstring	{ "en": "example string" }
Indicators	indicators		ETerm[]	[ { "identifier": "86D464C3-B5BB-4B02-85E4-1AAD8D64CD27" } ]
Elements of the Framework	implementingConsiderations		ETerm[]	[ { "identifier": "86D464C3-B5BB-4B02-85E4-1AAD8D64CD27" } ]
Coverage Countries	coverageCountries		ETerm[]	{ "identifier": "af" }
Coverage Regions	coverageRegions		ETerm[]	[ { "identifier": "86D464C3-B5BB-4B02-85E4-1AAD8D64CD27" } ]
Coverage Other	coverageOther		lstring[]
Funding to be used towards meeting the commitment	fundingSource		lstring	funding source
Is the funding sufficient for achieving the commitment?	isFundingSufficient	True	bool
International Frameworks	internationalFrameworks		lstring	{ "en": "example string" }
Partners	partners		lstring	{ "en": "example string" }
Is Linked To NBSAP	isLinkedToNbsap		bool
Linked To NBSAP Countries	linkedToNbsapCountries		ETerm[]	{ "identifier": "af" }
Will you report or provide information on Target 15 of the Framework?	isReportingOnTarget15	True	bool
Please provide details on what and how you will report or provide	target15Information	True	lstring	{ "en": "example string" }
Is progress towards the commitment tracked?	isProgressTracked	True	bool
What is the format...	progressInformation	True	lstring	{ "en": "example string" }
Provide a web address, if available	progressTrackingUrl		lstring	https://example.com
Potential ways to address challenges and opportunities...	implementationStrategies		lstring	{ "en": "example string" }
Provide any other relevant information...	additionalInformation		lstring	{ "en": "example string" }
Other relevant website address or attached documents	additionalDocuments		ELink[]	[ { "url": "https://example.com", "name": "Document" } ]
Linked Documents	linkedAttachments		ELink[]	[{ "url": "https://example.com", "name": "Attachment" }]
Notes	notes		string	Example notes