Skip to content

Schema for ORG

This section provides an overview of the schemas related to the Organization (ORG). Each schema details the structure and fields required for the ORG-related requests and responses.

NOTE

When making an API request using the Organization (ORG) schema, it is crucial to include the correct schema identifier. The schema parameter must be set to "organization" 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{ "identifier": "C7907DF4-C69A-A586-6C15-D95E3E703FFC", "schema": "organization", "languages": [ "en" ] }
Acronymacronymlstring{ "en": "TestINFO" }
Name of the organizationnameTruelstring{ "en": "Test Info" }
Contact person(s)contactsEreference[][ { "identifier": "SIMP-A1D0D0A8-65B1-B8D5-FF9F-B7B6B95CDDEB@1" } ]
Linked organizationslinkedOrganizationsEreference[][ { "identifier": "1767A775-F4F9-B597-41AC-CE56536F28F5@2" } ]
Addressaddresslstring{ "en": "Test Info" }
CitycityTruelstring{ "en": "Test Info" }
State or Provincestatelstring{ "en": "Test Info" }
Postal Code or ZippostalCodelstring{ "en": "TestINFO" }
CountrycountryTrueEterm{ "identifier": "af" }
Phone number(s)phonesTruestring[][ "1234561234" ]
Fax number(s)faxesstring[][ "1234561234" ]
Email(s)emailsTruestring[][ "test@email.com" ]
Website address(es)websitesElink[][ { "url": "https://www.google.com", "name": "Google", "language": "en" } ]
librariesEterm[]
Type of organizationorganizationTypeTrueEterm{ "identifier": "86D464C3-B5BB-4B02-85E4-1AAD8D64CD27" }
thematicAreasEterm[]
absThematicAreasEterm[]
Areas of workareasOfWorklstring[][ { "en": "Test Info" } ]
gbfTargetsEterm[]
aichiTargetsEterm[]
coordinatesEmapLocation
establishmentGooglePlaceIdstring[]
operationalLanguagesEterm[]
Regional area(s) of operations or political/economic group(s)operationalRegionsEterm[][ { "identifier": "CCA4B662-8EF4-418D-B327-0D6F418AA703" } ]
Organization’s profileprofilelstring{ "en": "
Test Info
" }
profileLinkElink[]
Any other relevant informationrelevantInformationlstring{ "en": "
Test Info
" }
Any other relevant documentsrelevantDocumentsElink[][ { "url": "https://www.google.com", "name": "Google", "language": "en" } ]