CLARISA

General List API Reference

General List

Summary

The list of REST-API services below contains some of the most important general control lists identified by the Management Information Systems during the Annual Reporting process and that can also be used to standardize and provide interoperability across any other CGIAR platforms.

Methods

/cgiar-entities

Functionality

This list contains the official list of CGIAR Centers, CGIAR Research Programs (CRPs), and CGIAR Platforms (PTFs). It also contains the list of Entities that are no longer active now.

Parameters

Name Description
typeId
integer($int64)
CGIAR entity type Code

Request URL:

/cgiar-entities

State code: 200: OK


[
  {
    "acronym" : "string",
    "cgiarEntityTypeDTO":  {
      "code" : 0,
      "name" : "string"
    }  ,
    "code" : 0,
    "name" : "string"
  }
]
                            

State code: 400


Bad Request
                            

State code: 401


Unauthorized
                          

State code: 403


Forbidden
                          

State code: 404


Not Found
                          
/cgiar-entity-types

Functionality

This list contains the types of entities we have currently in the CGIAR. So far, we have the CGIAR Research Programs, platforms, and Centers.

Parameters

No parameters

Request URL:

/cgiar-entity-types

State code: 200: OK


[
  {
    "code" : 0,
    "name" : "string"
  }
]
                            

State code: 400


Bad Request
                            

State code: 401


Unauthorized
                          

State code: 403


Forbidden
                          

State code: 404


Not Found
                          
/countries

Functionality

This list contains all the countries and is following the ISO-3166 standard. The data includes the country names in English, alpha-2 code, and the associated Region according to the UN49 standard.

Parameters

No parameters

Request URL:

/countries

State code: 200: OK


[
  {
    "code" : 0,
    "isoAlpha2" : "string",
    "name" : "string",
    "regionDTO" : {
      "um49Code" : 0,
      "name" : "string",
      "parentRegion" : {
	      "um49Code" : 0,
	      "name" : "string"
      } 
    } 
  }
]
                            

State code: 400


Bad Request
                            

State code: 401


Unauthorized
                          

State code: 403


Forbidden
                          

State code: 404


Not Found
                          
/un-regions

Functionality

Although there are several standards for the list of regions, we decided to adopt the UN49 standard.

Parameters

No parameters

Request URL:

/un-regions

State code: 200: OK


[
  {
    "um49Code" : 0,
    "name" : "string",
    "parentRegion" : {
      "um49Code" : 0,
      "name" : "string"
    } 
  }
]
                            

State code: 400


Bad Request
                            

State code: 401


Unauthorized
                          

State code: 403


Forbidden
                          

State code: 404


Not Found
                          

Institutions

Summary

methods

/institutions

Functionality

This is a worldwide list of institutions that have been related to CGIAR activities as funders, leaders, partners, and/or contributors. This list reflects the information consolidated by some of the CGIAR Management Information Systems and external sources (i.e. MARLO and MEL).

Parameters

No parameters

Request URL:

/institutions

State code: 200: OK


[
  {
    "acronym" : "string",
    "added" : "2020-10-09",
    "code" : 0,
    "countryOfficeDTO": [
        "countryOfficeDTO": {
        "code" : 0,
        "isHeadquarter" : "string",
        "isoAlpha2" : "string",
        "name" : "string",
        "regionDTO" : {
          "um49Code" : 0,
          "name" : "string",
          "parentRegion" : {
            "um49Code" : 0,
            "name" : "string"
          } 
        } 
      }
    ],
     "institutionType": {
        "code" : 0,
        "name" : "string"
     },
     "name" : "string",
     "websiteLink" : "string"
  }
]
                            

State code: 400


Bad Request
                            

State code: 401


Unauthorized
                          

State code: 403


Forbidden
                          

State code: 404


Not Found
                          

Institutions Management

Coming Soon

Office location

Coming Soon