KDW API¶
KDW offer a complete REST API, as described below. Note that the endpoints and methods available will depend on user permissions.
-
GET/api/country/¶ Dojo-compatible API endpoint that allows Countries to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
iso3166a2 (string) – iso3166a2
iso3166a3 (string) – iso3166a3
iso3166n3 (string) – iso3166n3
fips104 (string) – fips104
iso_en_name (string) – iso_en_name
iso_en_proper (string) – iso_en_proper
iso_en_ro_name (string) – iso_en_ro_name
iso_en_ro_proper (string) – iso_en_ro_proper
iso_fr_name (string) – iso_fr_name
iso_fr_proper (string) – iso_fr_proper
iso_es_name (string) – iso_es_name
ungegn_en_name (string) – ungegn_en_name
ungegn_en_longname (string) – ungegn_en_longname
ungegn_fr_name (string) – ungegn_fr_name
ungegn_fr_longname (string) – ungegn_fr_longname
ungegn_es_name (string) – ungegn_es_name
ungegn_es_longname (string) – ungegn_es_longname
ungegn_ru_name (string) – ungegn_ru_name
ungegn_ru_longname (string) – ungegn_ru_longname
ungegn_lc_ro_name (string) – ungegn_lc_ro_name
ungegn_lc_ro_longname (string) – ungegn_lc_ro_longname
bgn_name (string) – bgn_name
bgn_proper (string) – bgn_proper
bgn_longname (string) – bgn_longname
bgn_lc_longname (string) – bgn_lc_longname
bgn_lc_name (string) – bgn_lc_name
pcgn_name (string) – pcgn_name
pcgn_proper (string) – pcgn_proper
pcgn_longname (string) – pcgn_longname
fao_it_name (string) – fao_it_name
fao_it_proper (string) – fao_it_proper
fao_it_longname (string) – fao_it_longname
eki_name (string) – eki_name
eki_longname (string) – eki_longname
conabbr (string) – conabbr
has_capital (string) – has_capital
bgn_capital (string) – bgn_capital
ungegn_lc_capital (string) – ungegn_lc_capital
un_en_capital (string) – un_en_capital
un_fr_capital (string) – un_fr_capital
un_es_capital (string) – un_es_capital
un_ru_capital (string) – un_ru_capital
eki_capital (string) – eki_capital
bgn_c_latitude (string) – bgn_c_latitude
bgn_c_longitude (string) – bgn_c_longitude
un_c_latitude (string) – un_c_latitude
un_c_longitude (string) – un_c_longitude
continent (string) – continent
subcontinent (string) – subcontinent
iso_region (string) – iso_region
iso_subregion (string) – iso_subregion
language (string) – language
population (string) – population
year (string) – year
bgn_demonym (string) – bgn_demonym
bgn_demomyn_adj (string) – bgn_demomyn_adj
itu (string) – itu
ivc (string) – ivc
land (string) – land
water (string) – water
land_total (string) – land_total
latitude (string) – latitude
longitude (string) – longitude
max_latitude (string) – max_latitude
min_latitude (string) – min_latitude
max_longitude (string) – max_longitude
min_longitude (string) – min_longitude
url_gov (string) – url_gov
url_stats (string) – url_stats
url_gis (string) – url_gis
url_post (string) – url_post
admin_1_name (string) – admin_1_name
admin_2_name (string) – admin_2_name
used_for (string) – used_for
- Status Codes
200 OK –
-
GET/api/country/{iso3166a2}/¶ Dojo-compatible API endpoint that allows Countries to be viewed or edited.
- Parameters
iso3166a2 (string) – A unique value identifying this country.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
iso3166a2 (string) – iso3166a2
iso3166a3 (string) – iso3166a3
iso3166n3 (string) – iso3166n3
fips104 (string) – fips104
iso_en_name (string) – iso_en_name
iso_en_proper (string) – iso_en_proper
iso_en_ro_name (string) – iso_en_ro_name
iso_en_ro_proper (string) – iso_en_ro_proper
iso_fr_name (string) – iso_fr_name
iso_fr_proper (string) – iso_fr_proper
iso_es_name (string) – iso_es_name
ungegn_en_name (string) – ungegn_en_name
ungegn_en_longname (string) – ungegn_en_longname
ungegn_fr_name (string) – ungegn_fr_name
ungegn_fr_longname (string) – ungegn_fr_longname
ungegn_es_name (string) – ungegn_es_name
ungegn_es_longname (string) – ungegn_es_longname
ungegn_ru_name (string) – ungegn_ru_name
ungegn_ru_longname (string) – ungegn_ru_longname
ungegn_lc_ro_name (string) – ungegn_lc_ro_name
ungegn_lc_ro_longname (string) – ungegn_lc_ro_longname
bgn_name (string) – bgn_name
bgn_proper (string) – bgn_proper
bgn_longname (string) – bgn_longname
bgn_lc_longname (string) – bgn_lc_longname
bgn_lc_name (string) – bgn_lc_name
pcgn_name (string) – pcgn_name
pcgn_proper (string) – pcgn_proper
pcgn_longname (string) – pcgn_longname
fao_it_name (string) – fao_it_name
fao_it_proper (string) – fao_it_proper
fao_it_longname (string) – fao_it_longname
eki_name (string) – eki_name
eki_longname (string) – eki_longname
conabbr (string) – conabbr
has_capital (string) – has_capital
bgn_capital (string) – bgn_capital
ungegn_lc_capital (string) – ungegn_lc_capital
un_en_capital (string) – un_en_capital
un_fr_capital (string) – un_fr_capital
un_es_capital (string) – un_es_capital
un_ru_capital (string) – un_ru_capital
eki_capital (string) – eki_capital
bgn_c_latitude (string) – bgn_c_latitude
bgn_c_longitude (string) – bgn_c_longitude
un_c_latitude (string) – un_c_latitude
un_c_longitude (string) – un_c_longitude
continent (string) – continent
subcontinent (string) – subcontinent
iso_region (string) – iso_region
iso_subregion (string) – iso_subregion
language (string) – language
population (string) – population
year (string) – year
bgn_demonym (string) – bgn_demonym
bgn_demomyn_adj (string) – bgn_demomyn_adj
itu (string) – itu
ivc (string) – ivc
land (string) – land
water (string) – water
land_total (string) – land_total
latitude (string) – latitude
longitude (string) – longitude
max_latitude (string) – max_latitude
min_latitude (string) – min_latitude
max_longitude (string) – max_longitude
min_longitude (string) – min_longitude
url_gov (string) – url_gov
url_stats (string) – url_stats
url_gis (string) – url_gis
url_post (string) – url_post
admin_1_name (string) – admin_1_name
admin_2_name (string) – admin_2_name
used_for (string) – used_for
- Status Codes
200 OK –
-
GET/api/currency/¶ Dojo-compatible API endpoint that allows Currencies to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
- Status Codes
200 OK –
-
GET/api/currency/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/currency/{iso4217a3}/¶ Dojo-compatible API endpoint that allows Currencies to be viewed or edited.
- Parameters
iso4217a3 (string) – A unique value identifying this currency.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
- Status Codes
200 OK –
-
GET/api/classifiedproduct/¶ Dojo-compatible API endpoint that allows Classified Products to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
used_for (string) – used_for
- Status Codes
200 OK –
-
GET/api/classifiedproduct/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/classifiedproduct/{cpcv2}/¶ Dojo-compatible API endpoint that allows Classified Products to be viewed or edited.
- Parameters
cpcv2 (string) – A unique value identifying this classified product.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
used_for (string) – used_for
- Status Codes
200 OK –
-
GET/api/unitofmeasure/¶ Dojo-compatible API endpoint that allows Units of Measure to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
abbreviation (string) – abbreviation
unit_type (string) – unit_type
description (string) – description
aliases (string) – aliases
- Status Codes
200 OK –
-
GET/api/unitofmeasure/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/unitofmeasure/{abbreviation}/¶ Dojo-compatible API endpoint that allows Units of Measure to be viewed or edited.
- Parameters
abbreviation (string) – A unique value identifying this unit of measure.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
abbreviation (string) – abbreviation
unit_type (string) – unit_type
description (string) – description
aliases (string) – aliases
- Status Codes
200 OK –
-
GET/api/user/¶ Dojo-compatible API endpoint that allows users to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
- Status Codes
200 OK –
-
GET/api/user/{id}/¶ Dojo-compatible API endpoint that allows users to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this user.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
- Status Codes
200 OK –
-
GET/api/user/{id}/current/¶ Dojo-compatible API endpoint that allows users to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this user.
- Status Codes
200 OK –
-
GET/api/scenario/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
purpose (string) – purpose
- Status Codes
200 OK –
-
GET/api/scenario/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/scenario/{code}/¶ - Parameters
code (string) – A unique value identifying this scenario.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
purpose (string) – purpose
- Status Codes
200 OK –
-
GET/api/ipcclassification/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
geographic_unit (string) – geographic_unit
geographic_unit_name (string) – Geographic unit name
classification_scale (string) – classification_scale
scenario (string) – scenario
datasourcedocument (string) – Data source document
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
date (string) – date
geographic_group (string) – Geographic group
- Status Codes
200 OK –
-
GET/api/ipcclassification/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/ipcclassification/{id}/¶ - Parameters
id (string) – A unique integer value identifying this IPC Classification.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
geographic_unit (string) – geographic_unit
geographic_unit_name (string) – Geographic unit name
classification_scale (string) – classification_scale
scenario (string) – scenario
datasourcedocument (string) – Data source document
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
date (string) – date
geographic_group (string) – Geographic group
- Status Codes
200 OK –
-
GET/api/ipcpopulation/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
geographic_unit (string) – geographic_unit
geographic_unit_name (string) – Geographic unit name
phase (string) – phase
scenario (string) – scenario
datasourcedocument (string) – Data source document
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
date (string) – date
geographic_group (string) – Geographic group
- Status Codes
200 OK –
-
GET/api/ipcpopulation/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/ipcpopulation/{id}/¶ - Parameters
id (string) – A unique integer value identifying this IPC Population.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
geographic_unit (string) – geographic_unit
geographic_unit_name (string) – Geographic unit name
phase (string) – phase
scenario (string) – scenario
datasourcedocument (string) – Data source document
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
date (string) – date
geographic_group (string) – Geographic group
- Status Codes
200 OK –
-
GET/api/ipcphase/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
geographic_unit (string) – geographic_unit
classification_scale (string) – classification_scale
country (string) – Country
scenario (string) – scenario
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
dataseries (string) – dataseries
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
geographic_unit_code (string) – geographic_unit_code
fnid (string) – fnid
geographic_unit_name (string) – Geographic unit name
- Status Codes
200 OK –
-
GET/api/ipcphase/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/ipcpopulationsize/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
geographic_unit (string) – geographic_unit
country (string) – Country
phase (string) – phase
scenario (string) – scenario
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
dataseries (string) – dataseries
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
geographic_unit_name (string) – Geographic unit name
geographic_unit_code (string) – geographic_unit_code
fnid (string) – fnid
- Status Codes
200 OK –
-
GET/api/ipcpopulationsize/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/ipcclassificationdataset/¶ Dojo-compatible API endpoint that allows IPC Classification DataSets to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/ipcclassificationdataset/{id}/¶ Dojo-compatible API endpoint that allows IPC Classification DataSets to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this ipc classification dataset.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/ipcpopulationdataset/¶ Dojo-compatible API endpoint that allows IPC Population DataSets to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/ipcpopulationdataset/{id}/¶ Dojo-compatible API endpoint that allows IPC Population DataSets to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this ipc population dataset.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/datasourcedocument/¶ Dojo-compatible API endpoint that allows Data Source Documents to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
used_for (string) – used_for
- Status Codes
200 OK –
-
GET/api/datasourcedocument/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/datasourcedocument/{id}/¶ Dojo-compatible API endpoint that allows Data Source Documents to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this source document.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
used_for (string) – used_for
- Status Codes
200 OK –
-
GET/api/datacollection/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
datasourcedocument (string) – datasourcedocument
datasourcedocument__datasourceorganization (string) – datasourcedocument__datasourceorganization
status (string) – status
- Status Codes
200 OK –
-
GET/api/datacollection/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/datacollection/{id}/¶ - Parameters
id (string) – A unique integer value identifying this data collection.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
datasourcedocument (string) – datasourcedocument
datasourcedocument__datasourceorganization (string) – datasourcedocument__datasourceorganization
status (string) – status
- Status Codes
200 OK –
-
GET/api/datacollectionperiod/¶ - Query Parameters
page (integer) – A page number within the paginated result set.
page_size (integer) – Number of results to return per page.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
datasourcedocument (string) – datasourcedocument
datacollection (string) – datacollection
period_date (string) – period_date
start_date (string) – start_date
schedule (string) – schedule
notes (string) – notes
end_date (string) – end_date
- Status Codes
200 OK –
-
GET/api/datacollectionperiod/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/datacollectionperiod/{id}/¶ - Parameters
id (string) – A unique integer value identifying this collection period.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
datasourcedocument (string) – datasourcedocument
datacollection (string) – datacollection
period_date (string) – period_date
start_date (string) – start_date
schedule (string) – schedule
notes (string) – notes
end_date (string) – end_date
- Status Codes
200 OK –
-
GET/api/datapoint/¶ Dojo-compatible API endpoint that allows Data Points to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
datacollectionperiod (string) – datacollectionperiod
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
dataseries (string) – dataseries
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
- Status Codes
200 OK –
-
GET/api/datapoint/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/datapointfacts/¶ Dojo-compatible API endpoint that allows data points to be viewed with associated statistics.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
dataseries (string) – dataseries
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
- Status Codes
200 OK –
-
GET/api/datapointfacts/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/indicatorgroup/¶ - Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
- Status Codes
200 OK –
-
GET/api/indicatorgroup/{abbreviation}/¶ - Parameters
abbreviation (string) – A unique value identifying this indicator group.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
- Status Codes
200 OK –
-
GET/api/indicator/¶ - Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
data_domain (string) – Data domain
- Status Codes
200 OK –
-
GET/api/indicator/{abbreviation}/¶ - Parameters
abbreviation (string) – A unique value identifying this indicator.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
data_domain (string) – Data domain
- Status Codes
200 OK –
-
GET/api/dataseries/¶ Dojo-compatible API endpoint that allows DataSeries to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
id (string) – id
specialization_type (string) – specialization_type
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
datasourcedocument (string) – Data source document
date (string) – date
geographic_group (string) – Geographic group
- Status Codes
200 OK –
-
GET/api/dataseries/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/dataseries/{id}/¶ Dojo-compatible API endpoint that allows DataSeries to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this data series.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
id (string) – id
specialization_type (string) – specialization_type
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
datasourcedocument (string) – Data source document
date (string) – date
geographic_group (string) – Geographic group
- Status Codes
200 OK –
-
GET/api/geographicunit/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
layer (string) – layer
country (string) – Country
unit_type (string) – Geographic Unit Type
name (string) – name
code (string) – code
full_name (string) – full_name
es_name (string) – es_name
fr_name (string) – fr_name
pt_name (string) – pt_name
ar_name (string) – ar_name
aliases (string) – aliases
description (string) – description
unit_set (string) – Geographic Unit Set
unit_set_version (string) – unit_set_version
as_of_date (string) – as_of_date
used_for (string) – used_for
- Status Codes
200 OK –
-
GET/api/geographicunit/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/geographicunit/{id}/¶ - Parameters
id (string) – A unique integer value identifying this geographic unit.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
layer (string) – layer
country (string) – Country
unit_type (string) – Geographic Unit Type
name (string) – name
code (string) – code
full_name (string) – full_name
es_name (string) – es_name
fr_name (string) – fr_name
pt_name (string) – pt_name
ar_name (string) – ar_name
aliases (string) – aliases
description (string) – description
unit_set (string) – Geographic Unit Set
unit_set_version (string) – unit_set_version
as_of_date (string) – as_of_date
used_for (string) – used_for
- Status Codes
200 OK –
-
GET/api/geographicunittree/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
layer (string) – layer
country (string) – Country
unit_type (string) – Geographic Unit Type
name (string) – name
code (string) – code
full_name (string) – full_name
es_name (string) – es_name
fr_name (string) – fr_name
pt_name (string) – pt_name
ar_name (string) – ar_name
aliases (string) – aliases
description (string) – description
unit_set (string) – Geographic Unit Set
unit_set_version (string) – unit_set_version
as_of_date (string) – as_of_date
used_for (string) – used_for
- Status Codes
200 OK –
-
GET/api/geographicunittree/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/geographicunittree/{id}/¶ - Parameters
id (string) – A unique integer value identifying this geographic unit.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
layer (string) – layer
country (string) – Country
unit_type (string) – Geographic Unit Type
name (string) – name
code (string) – code
full_name (string) – full_name
es_name (string) – es_name
fr_name (string) – fr_name
pt_name (string) – pt_name
ar_name (string) – ar_name
aliases (string) – aliases
description (string) – description
unit_set (string) – Geographic Unit Set
unit_set_version (string) – unit_set_version
as_of_date (string) – as_of_date
used_for (string) – used_for
- Status Codes
200 OK –
-
GET/api/geographicunitset/¶ Dojo-compatible API endpoint that allows Geographic Unit Set to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
name (string) – name
country (string) – Country
datasourcedocument (string) – Data source document
description (string) – description
- Status Codes
200 OK –
-
GET/api/geographicunitset/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/geographicunitset/{id}/¶ Dojo-compatible API endpoint that allows Geographic Unit Set to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this geographic unit set.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
name (string) – name
country (string) – Country
datasourcedocument (string) – Data source document
description (string) – description
- Status Codes
200 OK –
-
GET/api/geographicunittype/¶ Dojo-compatible API endpoint that allows Geographic Unit Type to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
code (string) – code
name (string) – name
is_admin_unit (string) – is_admin_unit
- Status Codes
200 OK –
-
GET/api/geographicunittype/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/geographicunittype/{code}/¶ Dojo-compatible API endpoint that allows Geographic Unit Type to be viewed or edited.
- Parameters
code (string) – A unique value identifying this geographic unit type.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
code (string) – code
name (string) – name
is_admin_unit (string) – is_admin_unit
- Status Codes
200 OK –
-
GET/api/feature/¶ Geo based API endpoint that allows Features to be viewed or edited.
- Query Parameters
page (integer) – A page number within the paginated result set.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
layer (string) – layer
country (string) – Country
unit_type (string) – Geographic Unit Type
name (string) – name
code (string) – code
full_name (string) – full_name
es_name (string) – es_name
fr_name (string) – fr_name
pt_name (string) – pt_name
ar_name (string) – ar_name
aliases (string) – aliases
description (string) – description
fid (string) – fid
unit_set (string) – Geographic Unit Set
unit_set_version (string) – unit_set_version
as_of_date (string) – as_of_date
id (string) – id
- Status Codes
200 OK –
-
GET/api/feature/{id}/¶ Geo based API endpoint that allows Features to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this feature.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
layer (string) – layer
country (string) – Country
unit_type (string) – Geographic Unit Type
name (string) – name
code (string) – code
full_name (string) – full_name
es_name (string) – es_name
fr_name (string) – fr_name
pt_name (string) – pt_name
ar_name (string) – ar_name
aliases (string) – aliases
description (string) – description
fid (string) – fid
unit_set (string) – Geographic Unit Set
unit_set_version (string) – unit_set_version
as_of_date (string) – as_of_date
id (string) – id
- Status Codes
200 OK –
-
GET/api/market/¶ Dojo-compatible API endpoint that allows Markets to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
used_for (string) – used_for
country (string) – Country
unit_set (string) – Geographic Unit Set
unit_type (string) – Geographic Unit Type
unit_set_version (string) – unit_set_version
as_of_date (string) – as_of_date
- Status Codes
200 OK –
-
GET/api/market/{id}/¶ Dojo-compatible API endpoint that allows Markets to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this market.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
used_for (string) – used_for
country (string) – Country
unit_set (string) – Geographic Unit Set
unit_type (string) – Geographic Unit Type
unit_set_version (string) – unit_set_version
as_of_date (string) – as_of_date
- Status Codes
200 OK –
-
GET/api/geographicunitsetversion/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
start (string) – start
end (string) – end
geographicunitset (string) – geographicunitset
description (string) – description
file (string) – file
metadata (string) – metadata
country (string) – Country
layer (string) – Layer name
unit_type (string) – Unit type
as_of_date (string) – as_of_date
- Status Codes
200 OK –
-
GET/api/geographicunitsetversion/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/geographicunitsetversion/{id}/¶ - Parameters
id (string) – A unique integer value identifying this geographic unit set version.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
start (string) – start
end (string) – end
geographicunitset (string) – geographicunitset
description (string) – description
file (string) – file
metadata (string) – metadata
country (string) – Country
layer (string) – Layer name
unit_type (string) – Unit type
as_of_date (string) – as_of_date
- Status Codes
200 OK –
-
GET/api/layer/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
country (string) – Country
unit_type (string) – Unit type name
- Status Codes
200 OK –
-
GET/api/layer/{id}/¶ - Parameters
id (string) – A unique integer value identifying this layer.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
country (string) – Country
unit_type (string) – Unit type name
- Status Codes
200 OK –
-
GET/api/geographicunitrelationship/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
country (string) – Country
from_unit (string) – From unit
to_unit (string) – To unit
relationship_type (string) – Relationship type
- Status Codes
200 OK –
-
GET/api/geographicunitrelationship/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/geographicunitrelationship/{id}/¶ - Parameters
id (string) – A unique integer value identifying this geographic unit relationship.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
country (string) – Country
from_unit (string) – From unit
to_unit (string) – To unit
relationship_type (string) – Relationship type
- Status Codes
200 OK –
-
GET/api/pricedataset/¶ Dojo-compatible API endpoint that allows Price Data Sets to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/pricedataset/{id}/¶ Dojo-compatible API endpoint that allows Price Data Sets to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this price data set.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/marketproduct/¶ Dojo-compatible API endpoint that allows Markets Products to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
datasourcedocument (string) – Data source document
date (string) – date
geographic_group (string) – Geographic group
market_name (string) – market_name
price_type (string) – price_type
market (string) – market
cpcv2 (string) – Product Code
product (string) – Product
product_source (string) – product_source
- Status Codes
200 OK –
-
GET/api/marketproduct/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/marketproduct/{id}/¶ Dojo-compatible API endpoint that allows Markets Products to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this market product.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
datasourcedocument (string) – Data source document
date (string) – date
geographic_group (string) – Geographic group
market_name (string) – market_name
price_type (string) – price_type
market (string) – market
cpcv2 (string) – Product Code
product (string) – Product
product_source (string) – product_source
- Status Codes
200 OK –
-
GET/api/marketprice/¶ Dojo-compatible API endpoint that allows market prices to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
dataseries (string) – dataseries
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
market_name (string) – market_name
price_type (string) – price_type
market (string) – market
cpcv2 (string) – Product Code
product (string) – Product
product_source (string) – product_source
- Status Codes
200 OK –
-
GET/api/marketprice/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/marketpricefacts/¶ Dojo-compatible API endpoint that allows market prices to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
dataseries (string) – dataseries
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
market_name (string) – market_name
price_type (string) – price_type
market (string) – market
cpcv2 (string) – Product Code
product (string) – Product
product_source (string) – product_source
- Status Codes
200 OK –
-
GET/api/marketpricefacts/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/priceindexvalue/¶ Dojo-compatible API endpoint that allows Price Index Values to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
dataseries (string) – dataseries
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
index_name (string) – index_name
- Status Codes
200 OK –
-
GET/api/priceindexvalue/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/exchangeratevalue/¶ Dojo-compatible API endpoint that enables to view and edit exchange rates
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
dataseries (string) – dataseries
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
from_currency (string) – from_currency
to_currency (string) – to_currency
market (string) – market
- Status Codes
200 OK –
-
GET/api/exchangeratevalue/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/exchangerate/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
start (string) – start
end (string) – end
specialization_type (string) – specialization_type
name (string) – name
description (string) – description
datasourcedocument (string) – Data source document
datasets (string) – datasets
is_calculated (string) – is_calculated
_country (string) – _country
datausagepolicy (string) – datausagepolicy
from_currency (string) – from_currency
to_currency (string) – to_currency
rate_type (string) – rate_type
market (string) – market
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
subtype (string) – subtype
date (string) – date
geographic_group (string) – Geographic group
- Status Codes
200 OK –
-
GET/api/exchangerate/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/exchangerate/{id}/¶ - Parameters
id (string) – A unique integer value identifying this exchange rate.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
start (string) – start
end (string) – end
specialization_type (string) – specialization_type
name (string) – name
description (string) – description
datasourcedocument (string) – Data source document
datasets (string) – datasets
is_calculated (string) – is_calculated
_country (string) – _country
datausagepolicy (string) – datausagepolicy
from_currency (string) – from_currency
to_currency (string) – to_currency
rate_type (string) – rate_type
market (string) – market
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
subtype (string) – subtype
date (string) – date
geographic_group (string) – Geographic group
- Status Codes
200 OK –
-
GET/api/tradeflowquantity/¶ Dojo-compatible API endpoint that allows Trade Flows Quantities to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
start (string) – start
end (string) – end
specialization_type (string) – specialization_type
name (string) – name
description (string) – description
datasourcedocument (string) – Data source document
datasets (string) – datasets
is_calculated (string) – is_calculated
_country (string) – _country
datausagepolicy (string) – datausagepolicy
reporting_country (string) – Reporting Country
border_point (string) – border_point
source (string) – Source
destination (string) – Destination
product (string) – Product
unit (string) – unit
flow_type (string) – flow_type
trade_type (string) – trade_type
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
subtype (string) – subtype
date (string) – date
geographic_group (string) – Geographic group
cpcv2 (string) – Product Code
- Status Codes
200 OK –
-
GET/api/tradeflowquantity/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/tradeflowquantity/{id}/¶ Dojo-compatible API endpoint that allows Trade Flows Quantities to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this trade flow quantity.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
start (string) – start
end (string) – end
specialization_type (string) – specialization_type
name (string) – name
description (string) – description
datasourcedocument (string) – Data source document
datasets (string) – datasets
is_calculated (string) – is_calculated
_country (string) – _country
datausagepolicy (string) – datausagepolicy
reporting_country (string) – Reporting Country
border_point (string) – border_point
source (string) – Source
destination (string) – Destination
product (string) – Product
unit (string) – unit
flow_type (string) – flow_type
trade_type (string) – trade_type
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
subtype (string) – subtype
date (string) – date
geographic_group (string) – Geographic group
cpcv2 (string) – Product Code
- Status Codes
200 OK –
-
GET/api/tradeflowdataset/¶ Dojo-compatible API endpoint that allows TradeFlow DataSets to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/tradeflowdataset/{id}/¶ Dojo-compatible API endpoint that allows TradeFlow DataSets to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this trade flow data set.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/tradeflowquantityvalue/¶ Dojo-compatible API endpoint that allows trade flow quantity values to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
dataseries (string) – dataseries
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
reporting_country (string) – Reporting Country
source (string) – Source
destination (string) – Destination
flow_type (string) – flow_type
trade_type (string) – trade_type
cpcv2 (string) – Product Code
product (string) – Product
border_point (string) – border_point
- Status Codes
200 OK –
-
GET/api/tradeflowquantityvalue/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/locality/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
- Status Codes
200 OK –
-
GET/api/locality/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/locality/{id}/¶ - Parameters
id (string) – A unique integer value identifying this locality.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
- Status Codes
200 OK –
-
GET/api/documenttype/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
- Status Codes
200 OK –
-
GET/api/documenttype/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/documenttype/{code}/¶ - Parameters
code (string) – A unique value identifying this document type.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
- Status Codes
200 OK –
-
GET/api/survey/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
- Status Codes
200 OK –
-
GET/api/survey/{id}/¶ - Parameters
id (string) – A unique integer value identifying this survey.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
- Status Codes
200 OK –
-
GET/api/surveypopulation/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
survey (string) – survey
locality (string) – locality
locality__geographic_unit (string) – locality__geographic_unit
- Status Codes
200 OK –
-
GET/api/surveypopulation/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/surveypopulation/{id}/¶ - Parameters
id (string) – A unique integer value identifying this survey population.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
survey (string) – survey
locality (string) – locality
locality__geographic_unit (string) – locality__geographic_unit
- Status Codes
200 OK –
-
GET/api/surveyindicator/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
survey (string) – survey
indicator (string) – indicator
indicator__indicator_group (string) – indicator__indicator_group
- Status Codes
200 OK –
-
GET/api/surveyindicator/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/surveyindicator/{id}/¶ - Parameters
id (string) – A unique integer value identifying this survey indicator.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
survey (string) – survey
indicator (string) – indicator
indicator__indicator_group (string) – indicator__indicator_group
- Status Codes
200 OK –
-
GET/api/surveyperiodpopulation/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
survey_population (string) – survey_population
survey (string) – Survey
survey_period (string) – survey_period
- Status Codes
200 OK –
-
GET/api/surveyperiodpopulation/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/surveyperiodpopulation/{id}/¶ - Parameters
id (string) – A unique integer value identifying this survey period population.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
survey_population (string) – survey_population
survey (string) – Survey
survey_period (string) – survey_period
- Status Codes
200 OK –
-
GET/api/surveypopulationindicator/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
survey_population (string) – survey_population
survey (string) – Survey
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
datasourcedocument (string) – Data source document
date (string) – date
geographic_group (string) – Geographic group
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
data_domain (string) – Data domain
indicator (string) – indicator
- Status Codes
200 OK –
-
GET/api/surveypopulationindicator/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/surveypopulationindicator/{id}/¶ - Parameters
id (string) – A unique integer value identifying this survey population indicator.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
survey_population (string) – survey_population
survey (string) – Survey
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
datasourcedocument (string) – Data source document
date (string) – date
geographic_group (string) – Geographic group
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
data_domain (string) – Data domain
indicator (string) – indicator
- Status Codes
200 OK –
-
GET/api/populationindicator/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
datasourcedocument (string) – Data source document
date (string) – date
geographic_group (string) – Geographic group
survey (string) – Survey
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
data_domain (string) – Data domain
indicator (string) – indicator
- Status Codes
200 OK –
-
GET/api/populationindicator/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/populationindicator/{id}/¶ - Parameters
id (string) – A unique integer value identifying this population indicator.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
datasourcedocument (string) – Data source document
date (string) – date
geographic_group (string) – Geographic group
survey (string) – Survey
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
data_domain (string) – Data domain
indicator (string) – indicator
- Status Codes
200 OK –
-
GET/api/surveyindicatorvalue/¶ Dojo-compatible API endpoint that allows survey indicator values to be viewed.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
status (string) – status
status_changed (string) – status_changed
specialization_type (string) – specialization_type
datacollectionperiod (string) – datacollectionperiod
datacollection (string) – datacollection
dataseries (string) – dataseries
description (string) – description
value (string) – value
high_value (string) – high_value
ci95_low (string) – ci95_low
ci95_high (string) – ci95_high
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
data_domain (string) – Data domain
survey (string) – Survey
document_type (string) – Document type
admin_level (string) – Admin level
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
geographic_unit_code (string) – geographic_unit_code
fnid (string) – fnid
locality (string) – Locality
indicator_group (string) – Indicator Group
indicator (string) – indicator
surveypopulation (string) – Survey population
surveyindicator (string) – Survey indicator
- Status Codes
200 OK –
-
GET/api/surveyindicatorvalue/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/nutritionindicator/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
start (string) – start
end (string) – end
specialization_type (string) – specialization_type
name (string) – name
description (string) – description
datasourcedocument (string) – Data source document
datasets (string) – datasets
is_calculated (string) – is_calculated
_country (string) – _country
datausagepolicy (string) – datausagepolicy
survey_population (string) – survey_population
survey_indicator (string) – survey_indicator
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
subtype (string) – subtype
date (string) – date
geographic_group (string) – Geographic group
survey (string) – Survey
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
data_domain (string) – Data domain
indicator (string) – indicator
- Status Codes
200 OK –
-
GET/api/nutritionindicator/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/nutritionindicator/{id}/¶ - Parameters
id (string) – A unique integer value identifying this nutrition indicator.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
start (string) – start
end (string) – end
specialization_type (string) – specialization_type
name (string) – name
description (string) – description
datasourcedocument (string) – Data source document
datasets (string) – datasets
is_calculated (string) – is_calculated
_country (string) – _country
datausagepolicy (string) – datausagepolicy
survey_population (string) – survey_population
survey_indicator (string) – survey_indicator
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
subtype (string) – subtype
date (string) – date
geographic_group (string) – Geographic group
survey (string) – Survey
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
data_domain (string) – Data domain
indicator (string) – indicator
- Status Codes
200 OK –
-
GET/api/nutritionindicatorvalue/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
dataseries (string) – dataseries
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
data_domain (string) – Data domain
survey (string) – Survey
document_type (string) – Document type
admin_level (string) – Admin level
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
geographic_unit_code (string) – geographic_unit_code
fnid (string) – fnid
locality (string) – Locality
indicator_group (string) – Indicator Group
indicator (string) – indicator
surveypopulation (string) – Survey population
surveyindicator (string) – Survey indicator
- Status Codes
200 OK –
-
GET/api/nutritionindicatorvalue/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/populationindicatorvalue/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
dataseries (string) – dataseries
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
data_domain (string) – Data domain
survey (string) – Survey
document_type (string) – Document type
admin_level (string) – Admin level
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
geographic_unit_code (string) – geographic_unit_code
fnid (string) – fnid
locality (string) – Locality
indicator_group (string) – Indicator Group
indicator (string) – indicator
surveypopulation (string) – Survey population
surveyindicator (string) – Survey indicator
- Status Codes
200 OK –
-
GET/api/populationindicatorvalue/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/populationdataset/¶ Dojo-compatible API endpoint that allows Survey Population Data Sets with population data domain to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/populationdataset/{id}/¶ Dojo-compatible API endpoint that allows Survey Population Data Sets with population data domain to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this population dataset.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/nutritiondataset/¶ Dojo-compatible API endpoint that allows Survey Population Data Sets with nutrition data domain to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/nutritiondataset/{id}/¶ Dojo-compatible API endpoint that allows Survey Population Data Sets with nutrition data domain to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this nutrition dataset.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/cropproductionindicator/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
datasourcedocument (string) – Data source document
date (string) – date
geographic_group (string) – Geographic group
survey (string) – Survey
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
data_domain (string) – Data domain
indicator (string) – indicator
cpcv2 (string) – Product Code
product (string) – Product
season (string) – Season
season_type (string) – Season type
- Status Codes
200 OK –
-
GET/api/cropproductionindicator/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/cropproductionindicator/{id}/¶ - Parameters
id (string) – A unique integer value identifying this crop production indicator.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
name (string) – name
subtype (string) – subtype
datasourcedocument (string) – Data source document
date (string) – date
geographic_group (string) – Geographic group
survey (string) – Survey
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
data_domain (string) – Data domain
indicator (string) – indicator
cpcv2 (string) – Product Code
product (string) – Product
season (string) – Season
season_type (string) – Season type
- Status Codes
200 OK –
-
GET/api/cropproductionindicatorvalue/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
dataseries (string) – dataseries
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
data_domain (string) – Data domain
survey (string) – Survey
document_type (string) – Document type
admin_level (string) – Admin level
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
geographic_unit_code (string) – geographic_unit_code
fnid (string) – fnid
locality (string) – Locality
indicator_group (string) – Indicator Group
indicator (string) – indicator
surveypopulation (string) – Survey population
surveyindicator (string) – Survey indicator
cpcv2 (string) – Product Code
product (string) – Product
season (string) – Season
season_type (string) – Season type
- Status Codes
200 OK –
-
GET/api/cropproductionindicatorvalue/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/cropproductionfacts/¶ - Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
dataseries (string) – dataseries
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
data_domain (string) – Data domain
survey (string) – Survey
document_type (string) – Document type
admin_level (string) – Admin level
geographic_unit_name (string) – Geographic unit name
geographic_unit (string) – geographic_unit
geographic_unit_code (string) – geographic_unit_code
fnid (string) – fnid
locality (string) – Locality
indicator_group (string) – Indicator Group
indicator (string) – indicator
surveypopulation (string) – Survey population
surveyindicator (string) – Survey indicator
cpcv2 (string) – Product Code
product (string) – Product
season (string) – Season
season_type (string) – Season type
- Status Codes
200 OK –
-
GET/api/cropproductionfacts/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/cropproductiondataset/¶ Dojo-compatible API endpoint that allows Crop Production Data Sets to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/cropproductiondataset/{id}/¶ Dojo-compatible API endpoint that allows Crop Production Data Sets to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this crop production dataset.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/response/¶ Dojo-compatible API endpoint that allows response data series to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
start (string) – start
end (string) – end
specialization_type (string) – specialization_type
name (string) – name
description (string) – description
datasourcedocument (string) – Data source document
datasets (string) – datasets
is_calculated (string) – is_calculated
_country (string) – _country
datausagepolicy (string) – datausagepolicy
geographic_unit (string) – geographic_unit
operator (string) – operator
operation_type (string) – operation_type
fund_type (string) – fund_type
operation_id (string) – operation_id
assistance_type (string) – assistance_type
indicator (string) – indicator
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
subtype (string) – subtype
date (string) – date
geographic_group (string) – Geographic group
geographic_unit_code (string) – geographic_unit_code
fnid (string) – fnid
geographic_unit_name (string) – Geographic unit name
- Status Codes
200 OK –
-
GET/api/response/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/response/{id}/¶ Dojo-compatible API endpoint that allows response data series to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this response.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
created (string) – created
modified (string) – modified
start (string) – start
end (string) – end
specialization_type (string) – specialization_type
name (string) – name
description (string) – description
datasourcedocument (string) – Data source document
datasets (string) – datasets
is_calculated (string) – is_calculated
_country (string) – _country
datausagepolicy (string) – datausagepolicy
geographic_unit (string) – geographic_unit
operator (string) – operator
operation_type (string) – operation_type
fund_type (string) – fund_type
operation_id (string) – operation_id
assistance_type (string) – assistance_type
indicator (string) – indicator
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
subtype (string) – subtype
date (string) – date
geographic_group (string) – Geographic group
geographic_unit_code (string) – geographic_unit_code
fnid (string) – fnid
geographic_unit_name (string) – Geographic unit name
- Status Codes
200 OK –
-
GET/api/responsevalue/¶ Dojo-compatible API endpoint that allows response values to be viewed or edited.
aggregates is a dict of fields that should be aggregated if the reporting schedule is less frequent than the collection schedule, and the aggregation method for that field. The aggregation method for response values depends on the indicator but all the ones we have currently either measure value or tonnage or number of benefeciaries of aid delivered. Such being the case, we have defaulted the value’s aggregation method to sum but if we add other indicators in the future we will have to consider whether to add specialized aggregation for their values.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
dataseries (string) – dataseries
subtype (string) – subtype
date (string) – date
name (string) – name
geographic_group (string) – Geographic group
country_code (string) – Country ISO 3166-1 alpha-2 Code
country (string) – Country
status (string) – status
start_date (string) – start_date
end_date (string) – end_date
period_date (string) – period_date
datacollectionperiod__period_date (string) – datacollectionperiod__period_date
datacollectionperiod__datacollection__status (string) – datacollectionperiod__datacollection__status
collection_status (string) – collection_status
datacollectionperiod__schedule (string) – datacollectionperiod__schedule
collection_schedule (string) – collection_schedule
datasourcedocument (string) – Data source document
geographic_unit (string) – geographic_unit
geographic_unit_code (string) – geographic_unit_code
fnid (string) – fnid
geographic_unit_name (string) – geographic_unit_name
operator (string) – operator
operation_type (string) – operation_type
fund_type (string) – fund_type
indicator (string) – indicator
- Status Codes
200 OK –
-
GET/api/responsevalue/xmlschema/¶ Return an XML Schema Definition for XML requests
- Status Codes
200 OK –
-
GET/api/responsedataset/¶ Dojo-compatible API endpoint that allows Response Data Sets to be viewed or edited.
- Query Parameters
page_size (integer) – Number of results to return per page.
offset (integer) – The initial index from which to return the results.
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –
-
GET/api/responsedataset/{id}/¶ Dojo-compatible API endpoint that allows Response Data Sets to be viewed or edited.
- Parameters
id (string) – A unique integer value identifying this response dataset.
- Query Parameters
ordering (string) – Which field to use when ordering the results.
search (string) – A search term.
visibility (string) – visibility
- Status Codes
200 OK –