Final Report data API V1.0

  • All data is returned in a JSON format
  • API requests are limited to 1 request per second
  • Required parameters can use the URL/{ID} syntax
  • Optional paramaters use the paramater name syntax URL/?project_number=x&contact_id=y

Error codes

status detail
400 Bad Request Unknown method or element
400 Bad Request Invalid parameter, integer required
400 Bad Request Missing required parameter
400 Bad Request Could not invoke method
404 Not Found No result found
429 Too Many Requests Request limit exceeded

get_report_list
https://grdcfinalreports.cerdi.edu.au/api/v1/report/list


Returns a list of all published final reports and basic metadata for each report.
Returned reports can be filtered using the provided parameters.

Related functions
get_report

  • query Optional
  • project_number Optional
  • commence_date_after Optional
  • commence_date_before Optional
  • complete_date_after Optional
  • complete_date_before Optional
  • organisation_id Optional
  • region_id Optional
  • report_type Optional
  • publish_date_after Optional
  • publish_date_before Optional

get_report
https://grdcfinalreports.cerdi.edu.au/api/v1/report/{REPORT_ID}


Return details for the specified report
Always attribute GRDC and host/lead research organisation when displaying a report

Related functions
get_report_status
get_report_attachment_list
get_report_attachment
get_report_category_list

  • report_id Required

get_report_status
https://grdcfinalreports.cerdi.edu.au/api/v1/report_status/{REPORT_ID}


Return publish status of the specified report
Always attribute GRDC and host/lead research organisation when displaying a report

Report status:
Y - Report available
N - Report not available

  • report_id Required

get_region_list
https://grdcfinalreports.cerdi.edu.au/api/v1/region/list


Returns a list of all regions

Related functions
get_region

    get_region
    https://grdcfinalreports.cerdi.edu.au/api/v1/region/{REGION_ID}


    Returns details for the specified region

    • region_id Required

    get_report_attachment
    https://grdcfinalreports.cerdi.edu.au/api/v1/report_attachment/{REPORT_ID}


    Returns a list of publicly designated attachments for a report
    Call get_report_attachment to download binary content of the file

    Related functions
    get_report_attachment

    • report_id Required

    get_report_attachment_content
    https://grdcfinalreports.cerdi.edu.au/api/v1/report_attachment_content/{ATTACHMENT_ID}


    Gets binary content for the specified attachment

    • attachment_id Required

    get_issue_list
    https://grdcfinalreports.cerdi.edu.au/api/v1/issue/list


    Returns a list of all key issue categories used for the classification of reports
    A project category is the key issue the research was designed to test
    eg: Rotations, water usage, herbicide rate, weed management

    • category_id Optional

    get_theme_list
    https://grdcfinalreports.cerdi.edu.au/api/v1/theme/list


    Returns a list of all key research theme categories used for the classification of reports

    • category_id Optional

    get_report_category
    https://grdcfinalreports.cerdi.edu.au/api/v1/report_category/{REPORT_ID}


    Returns a list of issue and theme categories used to classify a specific report

    • report_id Required