data_bridges_client.IncubationApi

All URIs are relative to https://api.wfp.org/vam-data-bridges/5.0.0

Method	HTTP request	Description
aims_download_all_analysis_rounds_get	GET /Aims/DownloadAllAnalysisRounds	Each asset has a baseline and several rounds. Each round reflects the number of times the asset has been analysed over time. The number of total rounds changes according to the workstream: Asset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of Landscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only).
aims_download_polygon_files_get	GET /Aims/DownloadPolygonFiles	Polygon files are available for Landscape Impact Assessment (LIA) assets only. The file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only).
household_draft_internal_base_data_get	GET /Household/DraftInternalBaseData	Get data that includes the core household fields only by Survey ID. To access this data, please contact Wael ATTIA for authorization. This endpoint will send you only data you have access to, based on permissions assigned to your application profile. The "apiKey" can be found in the profile section of the DataBridges application.
household_full_data_get	GET /Household/FullData	Get a full dataset that includes all the fields included in the survey in addition to the core household fields by Survey ID. To access this data, please contact Wael ATTIA for authorization. This endpoint will send you only data you have access to, based on permissions assigned to your application profile. The "apiKey" can be found in the profile section of the DataBridges application.
household_official_use_base_data_get	GET /Household/OfficialUseBaseData	Get data that includes the core household fields only by Survey ID
household_public_base_data_get	GET /Household/PublicBaseData	Get data that includes the core household fields only by Survey ID
household_surveys_get	GET /Household/Surveys	Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all household surveys conducted in a country. A date of reference, SurveyDate, for the data collection is set by the officer responsible for the upload for each survey.
xls_forms_definition_get	GET /XlsForms/definition	Get a complete set of XLS Form definitions of a given XLS Form ID. This is the digital version of the questionnaire used during the data collection exercise.

aims_download_all_analysis_rounds_get

aims_download_all_analysis_rounds_get(adm0_code, env=env)

Each asset has a baseline and several rounds. Each round reflects the number of times the asset has been analysed over time. The number of total rounds changes according to the workstream: Asset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of Landscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only).

### This endpoint is restricted, it requires the scope: "vamdatabridges_aims-downloadallanalysisrounds_get" Data Controller - Wael ATTIA API Integration Pattern - This endpoint uses Hey Jude pattern

Example

OAuth Authentication (default):

import data_bridges_client
from data_bridges_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = data_bridges_client.Configuration(
    host = "https://api.wfp.org/vam-data-bridges/5.0.0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with data_bridges_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = data_bridges_client.IncubationApi(api_client)
    adm0_code = 56 # int | The country adm0Code
    env = 'env_example' # str | Environment.   * `prod` - api.vam.wfp.org   * `dev` - dev.api.vam.wfp.org (optional)

    try:
        # Each asset has a baseline and several rounds. Each round reflects the number of times the asset   has been analysed over time. The number of total rounds changes according to the workstream:   Asset Detection (AD) assets can have a total of 5 rounds, while there is no limit to the monitoring of   Landscape Impact Assessment (LIA) assets. Assets considered for Site Prioritization (SP) have one round only.   Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only).
        api_instance.aims_download_all_analysis_rounds_get(adm0_code, env=env)
    except Exception as e:
        print("Exception when calling IncubationApi->aims_download_all_analysis_rounds_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
adm0_code	int	The country adm0Code
env	str	Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org	[optional]

Return type

void (empty response body)

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aims_download_polygon_files_get

aims_download_polygon_files_get(adm0_code, env=env)

Polygon files are available for Landscape Impact Assessment (LIA) assets only. The file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only).

### This endpoint is restricted, it requires the scope: "vamdatabridges_aims-downloadpolygonfiles_get" Data Controller - Wael ATTIA API Integration Pattern - This endpoint uses Hey Jude pattern

Example

OAuth Authentication (default):

import data_bridges_client
from data_bridges_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = data_bridges_client.Configuration(
    host = "https://api.wfp.org/vam-data-bridges/5.0.0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with data_bridges_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = data_bridges_client.IncubationApi(api_client)
    adm0_code = 56 # int | The country adm0Code
    env = 'env_example' # str | Environment.   * `prod` - api.vam.wfp.org   * `dev` - dev.api.vam.wfp.org (optional)

    try:
        # Polygon files are available for Landscape Impact Assessment (LIA) assets only.   The file name corresponds to the “Geotrace” name. Please note that adm0code can be obtained   from https://api.vam.wfp.org/geodata/swagger/index.html (VPN access only).
        api_instance.aims_download_polygon_files_get(adm0_code, env=env)
    except Exception as e:
        print("Exception when calling IncubationApi->aims_download_polygon_files_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
adm0_code	int	The country adm0Code
env	str	Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org	[optional]

Return type

void (empty response body)

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

household_draft_internal_base_data_get

PagedSurveyResponsesDTO household_draft_internal_base_data_get(api_key, survey_id=survey_id, page=page, page_size=page_size, env=env)

Get data that includes the core household fields only by Survey ID. To access this data, please contact Wael ATTIA for authorization. This endpoint will send you only data you have access to, based on permissions assigned to your application profile. The "apiKey" can be found in the profile section of the DataBridges application.

### This endpoint is restricted, it requires the scope: "vamdatabridges_household-draftinternalbasedata_get" Data Controller - Wael ATTIA API Integration Pattern - This endpoint uses Hey Jude pattern

Example

OAuth Authentication (default):

import data_bridges_client
from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyResponsesDTO
from data_bridges_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = data_bridges_client.Configuration(
    host = "https://api.wfp.org/vam-data-bridges/5.0.0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with data_bridges_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = data_bridges_client.IncubationApi(api_client)
    api_key = 'api_key_example' # str | 
    survey_id = 56 # int | unique identifier for the collected data, as retrieved from /Surveys API. (optional)
    page = 1 # int | page number for paged results (optional) (default to 1)
    page_size = 20 # int | page size for paged results, default value is 20. (optional) (default to 20)
    env = 'env_example' # str | Environment.   * `prod` - api.vam.wfp.org   * `dev` - dev.api.vam.wfp.org (optional)

    try:
        # Get data that includes the core household fields only by Survey ID.  To access this data, please contact Wael ATTIA for authorization.   This endpoint will send you only data you have access to, based on permissions assigned to your application profile.   The \"apiKey\" can be found in the profile section of the DataBridges application.
        api_response = api_instance.household_draft_internal_base_data_get(api_key, survey_id=survey_id, page=page, page_size=page_size, env=env)
        print("The response of IncubationApi->household_draft_internal_base_data_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IncubationApi->household_draft_internal_base_data_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
api_key	str
survey_id	int	unique identifier for the collected data, as retrieved from /Surveys API.	[optional]
page	int	page number for paged results	[optional] [default to 1]
page_size	int	page size for paged results, default value is 20.	[optional] [default to 20]
env	str	Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org	[optional]

Return type

PagedSurveyResponsesDTO

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

household_full_data_get

PagedSurveyResponsesDTO household_full_data_get(api_key, survey_id=survey_id, format=format, page=page, page_size=page_size, env=env)

Get a full dataset that includes all the fields included in the survey in addition to the core household fields by Survey ID. To access this data, please contact Wael ATTIA for authorization. This endpoint will send you only data you have access to, based on permissions assigned to your application profile. The "apiKey" can be found in the profile section of the DataBridges application.

### This endpoint is restricted, it requires the scope: "vamdatabridges_household-fulldata_get" Data Controller - Wael ATTIA API Integration Pattern - This endpoint uses Hey Jude pattern

Example

OAuth Authentication (default):

import data_bridges_client
from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyResponsesDTO
from data_bridges_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = data_bridges_client.Configuration(
    host = "https://api.wfp.org/vam-data-bridges/5.0.0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with data_bridges_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = data_bridges_client.IncubationApi(api_client)
    api_key = 'api_key_example' # str | 
    survey_id = 56 # int | unique identifier for the collected data, as retrieved from /Surveys API. (optional)
    format = 'json' # str | Output format: [JSON|CSV] Json is the default value (optional) (default to 'json')
    page = 1 # int | page number for paged results (optional) (default to 1)
    page_size = 20 # int | page size for paged results, default value is 20. (optional) (default to 20)
    env = 'env_example' # str | Environment.   * `prod` - api.vam.wfp.org   * `dev` - dev.api.vam.wfp.org (optional)

    try:
        # Get a full dataset that includes all the fields included in the survey in addition to the core household fields by Survey ID.  To access this data, please contact Wael ATTIA for authorization.   This endpoint will send you only data you have access to, based on permissions assigned to your application profile.   The \"apiKey\" can be found in the profile section of the DataBridges application.
        api_response = api_instance.household_full_data_get(api_key, survey_id=survey_id, format=format, page=page, page_size=page_size, env=env)
        print("The response of IncubationApi->household_full_data_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IncubationApi->household_full_data_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
api_key	str
survey_id	int	unique identifier for the collected data, as retrieved from /Surveys API.	[optional]
format	str	Output format: [JSON	CSV] Json is the default value
page	int	page number for paged results	[optional] [default to 1]
page_size	int	page size for paged results, default value is 20.	[optional] [default to 20]
env	str	Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org	[optional]

Return type

PagedSurveyResponsesDTO

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

household_official_use_base_data_get

PagedSurveyResponsesDTO household_official_use_base_data_get(survey_id=survey_id, page=page, page_size=page_size, env=env)

Get data that includes the core household fields only by Survey ID

### This endpoint is restricted, it requires the scope: "vamdatabridges_household-officialusebasedata_get" Data Controller - Wael ATTIA API Integration Pattern - This endpoint uses Hey Jude pattern

Example

OAuth Authentication (default):

import data_bridges_client
from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyResponsesDTO
from data_bridges_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = data_bridges_client.Configuration(
    host = "https://api.wfp.org/vam-data-bridges/5.0.0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with data_bridges_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = data_bridges_client.IncubationApi(api_client)
    survey_id = 56 # int | unique identifier for the collected data, as retrieved from /Surveys API. (optional)
    page = 1 # int | page number for paged results (optional) (default to 1)
    page_size = 20 # int | page size for paged results, default value is 20. (optional) (default to 20)
    env = 'env_example' # str | Environment.   * `prod` - api.vam.wfp.org   * `dev` - dev.api.vam.wfp.org (optional)

    try:
        # Get data that includes the core household fields only by Survey ID
        api_response = api_instance.household_official_use_base_data_get(survey_id=survey_id, page=page, page_size=page_size, env=env)
        print("The response of IncubationApi->household_official_use_base_data_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IncubationApi->household_official_use_base_data_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
survey_id	int	unique identifier for the collected data, as retrieved from /Surveys API.	[optional]
page	int	page number for paged results	[optional] [default to 1]
page_size	int	page size for paged results, default value is 20.	[optional] [default to 20]
env	str	Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org	[optional]

Return type

PagedSurveyResponsesDTO

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

household_public_base_data_get

PagedSurveyResponsesDTO household_public_base_data_get(survey_id=survey_id, page=page, page_size=page_size, env=env)

Get data that includes the core household fields only by Survey ID

### This endpoint is restricted, it requires the scope: "vamdatabridges_household-publicbasedata_get" Data Controller - Wael ATTIA API Integration Pattern - This endpoint uses Hey Jude pattern

Example

OAuth Authentication (default):

import data_bridges_client
from data_bridges_client.models.paged_survey_responses_dto import PagedSurveyResponsesDTO
from data_bridges_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = data_bridges_client.Configuration(
    host = "https://api.wfp.org/vam-data-bridges/5.0.0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with data_bridges_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = data_bridges_client.IncubationApi(api_client)
    survey_id = 56 # int | unique identifier for the collected data, as retrieved from /Surveys API. (optional)
    page = 1 # int | page number for paged results (optional) (default to 1)
    page_size = 20 # int | page size for paged results, default value is 20. (optional) (default to 20)
    env = 'env_example' # str | Environment.   * `prod` - api.vam.wfp.org   * `dev` - dev.api.vam.wfp.org (optional)

    try:
        # Get data that includes the core household fields only by Survey ID
        api_response = api_instance.household_public_base_data_get(survey_id=survey_id, page=page, page_size=page_size, env=env)
        print("The response of IncubationApi->household_public_base_data_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IncubationApi->household_public_base_data_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
survey_id	int	unique identifier for the collected data, as retrieved from /Surveys API.	[optional]
page	int	page number for paged results	[optional] [default to 1]
page_size	int	page size for paged results, default value is 20.	[optional] [default to 20]
env	str	Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org	[optional]

Return type

PagedSurveyResponsesDTO

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

household_surveys_get

HouseholdSurveyListDTOPagedResult household_surveys_get(adm0_code=adm0_code, page=page, start_date=start_date, end_date=end_date, survey_id=survey_id, env=env)

Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all household surveys conducted in a country. A date of reference, SurveyDate, for the data collection is set by the officer responsible for the upload for each survey.

### This endpoint is restricted, it requires the scope: "vamdatabridges_household-surveys_get" Data Controller - Wael ATTIA API Integration Pattern - This endpoint uses Hey Jude pattern

Example

OAuth Authentication (default):

import data_bridges_client
from data_bridges_client.models.household_survey_list_dto_paged_result import HouseholdSurveyListDTOPagedResult
from data_bridges_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = data_bridges_client.Configuration(
    host = "https://api.wfp.org/vam-data-bridges/5.0.0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with data_bridges_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = data_bridges_client.IncubationApi(api_client)
    adm0_code = 0 # int | code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion (optional) (default to 0)
    page = 1 # int | page number for paged results (optional) (default to 1)
    start_date = '2013-10-20T19:20:30+01:00' # datetime | starting date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24) (optional)
    end_date = '2013-10-20T19:20:30+01:00' # datetime | ending date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year \"-\" month \"-\" day (e.g. 2020/06/24) (optional)
    survey_id = 56 # int |  (optional)
    env = 'env_example' # str | Environment.   * `prod` - api.vam.wfp.org   * `dev` - dev.api.vam.wfp.org (optional)

    try:
        # Retrieve 1) Survey IDs, 2) their corresponding XLS Form IDs, and 3) Base XLS Form of all household surveys conducted in a country.   A date of reference, SurveyDate, for the data collection is set by the officer responsible for the upload for each survey.
        api_response = api_instance.household_surveys_get(adm0_code=adm0_code, page=page, start_date=start_date, end_date=end_date, survey_id=survey_id, env=env)
        print("The response of IncubationApi->household_surveys_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IncubationApi->household_surveys_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
adm0_code	int	code for the country as retrieved from https://api.vam.wfp.org/geodata/CountriesInRegion	[optional] [default to 0]
page	int	page number for paged results	[optional] [default to 1]
start_date	datetime	starting date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year "-" month "-" day (e.g. 2020/06/24)	[optional]
end_date	datetime	ending date for the range in which data was collected. Use the date formats defined by RFC 3339 ; use strings matching year "-" month "-" day (e.g. 2020/06/24)	[optional]
survey_id	int		[optional]
env	str	Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org	[optional]

Return type

HouseholdSurveyListDTOPagedResult

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

xls_forms_definition_get

List[XlsFormDefinitionNewSchemaDTO] xls_forms_definition_get(xls_form_id=xls_form_id, env=env)

Get a complete set of XLS Form definitions of a given XLS Form ID. This is the digital version of the questionnaire used during the data collection exercise.

### This endpoint is restricted, it requires the scope: "vamdatabridges_xlsforms-definition_get" Data Controller - Wael ATTIA API Integration Pattern - This endpoint uses Hey Jude pattern

Example

OAuth Authentication (default):

import data_bridges_client
from data_bridges_client.models.xls_form_definition_new_schema_dto import XlsFormDefinitionNewSchemaDTO
from data_bridges_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wfp.org/vam-data-bridges/5.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = data_bridges_client.Configuration(
    host = "https://api.wfp.org/vam-data-bridges/5.0.0"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with data_bridges_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = data_bridges_client.IncubationApi(api_client)
    xls_form_id = 56 # int | unique identifier for the XLS Form, as retrieved from /XLSForms (optional)
    env = 'env_example' # str | Environment.   * `prod` - api.vam.wfp.org   * `dev` - dev.api.vam.wfp.org (optional)

    try:
        # Get a complete set of XLS Form definitions of a given XLS Form ID. This is the digital version of the questionnaire used during the data collection exercise.
        api_response = api_instance.xls_forms_definition_get(xls_form_id=xls_form_id, env=env)
        print("The response of IncubationApi->xls_forms_definition_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IncubationApi->xls_forms_definition_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
xls_form_id	int	unique identifier for the XLS Form, as retrieved from /XLSForms	[optional]
env	str	Environment. * `prod` - api.vam.wfp.org * `dev` - dev.api.vam.wfp.org	[optional]

Return type

List[XlsFormDefinitionNewSchemaDTO]

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

IncubationApi.md

Latest commit

History

IncubationApi.md

File metadata and controls

data_bridges_client.IncubationApi

aims_download_all_analysis_rounds_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

aims_download_polygon_files_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

household_draft_internal_base_data_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

household_full_data_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

household_official_use_base_data_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

household_public_base_data_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

household_surveys_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

xls_forms_definition_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details