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.
Title | Field | Mandatory | Type | Example |
---|---|---|---|---|
header | Eheader | { "identifier": "C7907DF4-C69A-A586-6C15-D95E3E703FFC", "schema": "organization", "languages": [ "en" ] } | ||
Acronym | acronym | lstring | { "en": "TestINFO" } | |
Name of the organization | name | True | lstring | { "en": "Test Info" } |
Contact person(s) | contacts | Ereference[] | [ { "identifier": "SIMP-A1D0D0A8-65B1-B8D5-FF9F-B7B6B95CDDEB@1" } ] | |
Linked organizations | linkedOrganizations | Ereference[] | [ { "identifier": "1767A775-F4F9-B597-41AC-CE56536F28F5@2" } ] | |
Address | address | lstring | { "en": "Test Info" } | |
City | city | True | lstring | { "en": "Test Info" } |
State or Province | state | lstring | { "en": "Test Info" } | |
Postal Code or Zip | postalCode | lstring | { "en": "TestINFO" } | |
Country | country | True | Eterm | { "identifier": "af" } |
Phone number(s) | phones | True | string[] | [ "1234561234" ] |
Fax number(s) | faxes | string[] | [ "1234561234" ] | |
Email(s) | emails | True | string[] | [ "test@email.com" ] |
Website address(es) | websites | Elink[] | [ { "url": "https://www.google.com", "name": "Google", "language": "en" } ] | |
libraries | Eterm[] | |||
Type of organization | organizationType | True | Eterm | { "identifier": "86D464C3-B5BB-4B02-85E4-1AAD8D64CD27" } |
thematicAreas | Eterm[] | |||
absThematicAreas | Eterm[] | |||
Areas of work | areasOfWork | lstring[] | [ { "en": "Test Info" } ] | |
gbfTargets | Eterm[] | |||
aichiTargets | Eterm[] | |||
coordinates | EmapLocation | |||
establishmentGooglePlaceId | string[] | |||
operationalLanguages | Eterm[] | |||
Regional area(s) of operations or political/economic group(s) | operationalRegions | Eterm[] | [ { "identifier": "CCA4B662-8EF4-418D-B327-0D6F418AA703" } ] | |
Organization’s profile | profile | lstring | { "en": " | |
profileLink | Elink[] | |||
Any other relevant information | relevantInformation | lstring | { "en": " | |
Any other relevant documents | relevantDocuments | Elink[] | [ { "url": "https://www.google.com", "name": "Google", "language": "en" } ] |