To access the Tree-to-Me Public Farm Event Data API, you need to receive an invitation from a Tree-to-Me farm owner. The system will send you an email containing the API Key ID and API Key Secret. Follow these steps to authenticate and use the API:
\nfarm_events Farm Event Data API.Method: GET
Auth: Requires JWT generated by the OAuth API to pass the authentication.
\nDescription:
\nRetrieve a list of pest, disease, and weed assessments Event Data based on the provided query parameters.
\nQuery Parameters:
\nfarm_gln (required): The Global Location Number (GLN) of the farm.
Must be a non-empty string with a maximum length of 13 digits.
\nMust be numeric.
\ngln_extension (required): The GLN extension of the farm feature.
Ensure the GLN extension is properly URL-encoded according to standard URL encoding practices.
\nMust be a non-empty string with a maximum length of 20 characters.
\nstart_time (required): The start time for the assessments.
Must be a non-empty string in ISO8601 format.
\nTime zone info is needed:
Examples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
end_time (required): The end time for the assessments.
Must be a non-empty string in ISO8601 format.
\nTime zone info is needed:
Examples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
time_order (optional): The order of the results by time.
ASC or DESC.limit (optional): The maximum number of results to return.
offset (optional): The number of results to skip before starting to collect the result set.
Response:
\nStatus Code: 200 OK
Content-Type: application/json
Description: The response will include an array of pest, disease, and weed assessments, each containing the following fields:
\n[\n {\n \"created_at\": \"string (ISO8601 date)\",\n \"species\": \"string\",\n \"population_density\": \"string or null\",\n \"population_density_unit\": \"string (enum: 'Percentage')\",\n \"symptoms\": \"string\",\n \"damage_assessment\": \"string\",\n \"control_measures_applied\": \"string (enum: 'cultural', 'biological', 'mechanical', 'chemical')\",\n \"notes\": \"string or null\",\n \"assessor\": \"string\"\n }\n]\n\nNeed URL Encode
\n","type":"text/plain"},"key":"gln_extension","value":"MRng3J27Vn%3Bsx%2Az9b%2F9%3D"},{"description":{"content":"Time zone info is needed:\nExamples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
\n","type":"text/plain"},"key":"start_time","value":"2024-05-10T00:00:00Z"},{"description":{"content":"Time zone info is needed:\nExamples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
\n","type":"text/plain"},"key":"end_time","value":"2024-06-21T20:00:00Z"},{"key":"limit","value":"5"},{"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Optional ASC or DESC
\n","type":"text/plain"},"key":"time_order","value":"ASC"}],"variable":[]}},"response":[{"id":"79b5b6c3-b847-4d3b-bea3-f906b3934815","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://4nkg802y99.execute-api.ap-southeast-2.amazonaws.com/dev/public/data_api/farm_events/pest_disease_weed_assessments?farm_gln=5936403145983&gln_extension=C7Nue4i6xJ*%28xZluvfWr&start_time=2024-05-10T00:00:00Z&end_time=2024-06-06T00:00:00Z&limit=5&offset=0","protocol":"https","host":["4nkg802y99","execute-api","ap-southeast-2","amazonaws","com"],"path":["dev","public","data_api","farm_events","pest_disease_weed_assessments"],"query":[{"key":"farm_gln","value":"5936403145983"},{"key":"gln_extension","value":"C7Nue4i6xJ*%28xZluvfWr","description":"URL encoded"},{"key":"start_time","value":"2024-05-10T00:00:00Z"},{"key":"end_time","value":"2024-06-06T00:00:00Z"},{"key":"time_order","value":"","description":"Optional ASC or DESC","type":"text","disabled":true},{"key":"limit","value":"5","description":"optional for pagination"},{"key":"offset","value":"0","description":"optional for pagination"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1185"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 06 Jun 2024 03:37:33 GMT"},{"key":"x-amzn-RequestId","value":"5b6b2dfb-be38-4cea-890d-1e470da1b049"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-headers","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"1185"},{"key":"x-amzn-Remapped-connection","value":"close"},{"key":"x-amz-apigw-id","value":"Y7RHbFEYywMEmTw="},{"key":"etag","value":"W/\"4a1-xxnpAYm71rQpKRYusDJ4kEm3b20\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-66612efc-1c093d110d00870318e9dcb3;Parent=52fdd97343a96a0e;Sampled=0;lineage=c1da79a7:0"},{"key":"x-amzn-Remapped-date","value":"Thu, 06 Jun 2024 03:37:33 GMT"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 fd52efac0e72eb0d0b1148d8f877dd9e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD62-P3"},{"key":"X-Amz-Cf-Id","value":"prDFI1ziOntn2WPSzx0qha8z5qcfpsF6KuxEDTUFqcSrGeFQE0_OaA=="}],"cookie":[],"responseTime":null,"body":"[\n {\n \"created_at\": \"2024-05-14T07:34:24.000Z\",\n \"species\": \"d\",\n \"population_density\": null,\n \"population_density_unit\": \"Percentage\",\n \"symptoms\": \"d\",\n \"damage_assessment\": \"d\",\n \"control_measures_applied\": \"biological\",\n \"notes\": null,\n \"assessor\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-14T09:23:06.000Z\",\n \"species\": \"g\",\n \"population_density\": \"2.78\",\n \"population_density_unit\": \"Percentage\",\n \"symptoms\": \"g\",\n \"damage_assessment\": \"r\",\n \"control_measures_applied\": \"cultural\",\n \"notes\": null,\n \"assessor\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-14T09:35:55.000Z\",\n \"species\": \"d\",\n \"population_density\": \"1.78\",\n \"population_density_unit\": \"Percentage\",\n \"symptoms\": \"dd\",\n \"damage_assessment\": \"ww\",\n \"control_measures_applied\": \"chemical\",\n \"notes\": null,\n \"assessor\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-14T10:27:19.000Z\",\n \"species\": \"e\",\n \"population_density\": null,\n \"population_density_unit\": \"Percentage\",\n \"symptoms\": \"e\",\n \"damage_assessment\": \"ddddd\",\n \"control_measures_applied\": \"cultural\",\n \"notes\": null,\n \"assessor\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-14T10:27:52.000Z\",\n \"species\": \"d\",\n \"population_density\": \"1.66\",\n \"population_density_unit\": \"Percentage\",\n \"symptoms\": \"d\",\n \"damage_assessment\": \"w\",\n \"control_measures_applied\": \"cultural\",\n \"notes\": null,\n \"assessor\": \"Tobby Hal\"\n }\n]"},{"id":"5f72b7ac-53ee-42b8-9110-aed8e4da4513","name":"403","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BASE_URL}}/{{ENV}}/public/data_api/farm_events/pest_disease_weed_assessments?farm_gln=5936403145983&gln_extension=sssfgasdfgasdfgasdfg&start_time=2024-05-10T00:00:00Z&end_time=2024-06-06T00:00:00Z&limit=5&offset=0","host":["{{BASE_URL}}"],"path":["{{ENV}}","public","data_api","farm_events","pest_disease_weed_assessments"],"query":[{"key":"farm_gln","value":"5936403145983"},{"key":"gln_extension","value":"sssfgasdfgasdfgasdfg"},{"key":"start_time","value":"2024-05-10T00:00:00Z"},{"key":"end_time","value":"2024-06-06T00:00:00Z"},{"key":"time_order","value":"","description":"Optional ASC or DESC","type":"text","disabled":true},{"key":"limit","value":"5","description":"optional for pagination"},{"key":"offset","value":"0","description":"optional for pagination"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"208"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 11 Jun 2024 10:42:58 GMT"},{"key":"x-amzn-RequestId","value":"0e815895-9f29-4e22-b85b-6ebe4baaa172"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-ratelimit-reset","value":"1718102878"},{"key":"access-control-allow-headers","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"208"},{"key":"x-amzn-Remapped-connection","value":"close"},{"key":"x-ratelimit-remaining","value":"255"},{"key":"x-amz-apigw-id","value":"ZMuH0G3NywMErXQ="},{"key":"x-ratelimit-limit","value":"256"},{"key":"etag","value":"W/\"d0-HXtqsQoJ5KuGNMyWDowNIuxvJCY\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-66682a31-75fdea1d7e059614185db40a;Parent=2e38cc5a508e66f4;Sampled=0;lineage=c1da79a7:0"},{"key":"x-amzn-Remapped-date","value":"Tue, 11 Jun 2024 10:42:57 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 efb8a232eeb70ecdf19fbd8538dcbf5e.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"MEL52-P2"},{"key":"X-Amz-Cf-Id","value":"VtrMRHF1mPd8VZKgn_bfbYQCmG_GXq8mgJy_t1M-_kyD5cQztM33bw=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"0e815895-9f29-4e22-b85b-6ebe4baaa172\",\n \"code\": 403,\n \"detail\": \"This api key is not allowed to access this farm\",\n \"message\": \"This api key is not allowed to access this farm\",\n \"source\": \"Internal error source\"\n}"}],"_postman_id":"70b568ba-e88c-40ba-b5c1-7a18e0a70a30"},{"name":"get_fruit_quality_events","id":"da066afa-82d1-4826-aa64-7ebe99665654","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Method: GET
\nAuth: Requires JWT generated by the OAuth API to pass the authentication.
\nDescription:
Retrieve a list of fruit quality assessments Event Data based on the provided query parameters.
Query Parameters:
\nfarm_gln (required): The Global Location Number (GLN) of the farm.
Must be a non-empty string with a maximum length of 13 digits.
\nMust be numeric.
\ngln_extension (required): The GLN extension of the farm feature.
Ensure the GLN extension is properly URL-encoded according to standard URL encoding practices.
\nMust be a non-empty string with a maximum length of 20 characters.
\nstart_time (required): The start time for the assessments.
Must be a non-empty string in ISO8601 format.
\nTime zone info is needed:
Examples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
end_time (required): The end time for the assessments.
Must be a non-empty string in ISO8601 format.
\nTime zone info is needed:
Examples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
time_order (optional): The order of the results by time.
ASC or DESC.limit (optional): The maximum number of results to return.
offset (optional): The number of results to skip before starting to collect the result set.
Response:
\nStatus Code: 200 OK
Content-Type: application/json
Description: The response will include an array of fruit quality assessments, each containing the following fields:
\n[\n {\n \"created_at\": \"string (ISO8601 date)\",\n \"assessment_type\": \"string (enum: 'Destructive', 'Handheld Device', 'Mechanical Grader')\",\n \"sweetness\": \"string number\",\n \"sweetness_unit\": \"string (enum: '°Bx')\",\n \"colour\": \"string\",\n \"diameter\": \"string number\",\n \"diameter_unit\": \"string (enum: 'cm')\",\n \"weight\": \"string number\",\n \"weight_unit\": \"string (enum: 'g')\",\n \"outlook\": [\n \"string (enum: 'Blemish', 'Rot', 'Discoloration', 'None')\"\n ],\n \"firmness\": \"string number\",\n \"firmness_unit\": \"string (enum: 'kgf', 'N')\",\n \"notes\": \"string or null\",\n \"assessor\": \"string\"\n }\n]\n\nNeed URL Encode
\n","type":"text/plain"},"key":"gln_extension","value":"C7Nue4i6xJ*%28xZluvfWr"},{"description":{"content":"Time zone info is needed:\nExamples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
\n","type":"text/plain"},"key":"start_time","value":"2024-05-10T00:00:00Z"},{"description":{"content":"Time zone info is needed:\nExamples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
\n","type":"text/plain"},"key":"end_time","value":"2024-06-21T00:00:00Z"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Optional ASC or DESC
\n","type":"text/plain"},"key":"time_order","value":"ASC"}],"variable":[]}},"response":[{"id":"04e27076-ac42-4f0b-8e82-5d07bea51688","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://4nkg802y99.execute-api.ap-southeast-2.amazonaws.com/dev/public/data_api/farm_events/fruit_quality_assessments?farm_gln=5936403145983&gln_extension=C7Nue4i6xJ*%28xZluvfWr&start_time=2024-05-10T00:00:00Z&end_time=2024-06-06T00:00:00Z&limit=5&offset=0","protocol":"https","host":["4nkg802y99","execute-api","ap-southeast-2","amazonaws","com"],"path":["dev","public","data_api","farm_events","fruit_quality_assessments"],"query":[{"key":"farm_gln","value":"5936403145983"},{"key":"gln_extension","value":"C7Nue4i6xJ*%28xZluvfWr","description":"URL encoded"},{"key":"start_time","value":"2024-05-10T00:00:00Z"},{"key":"end_time","value":"2024-06-06T00:00:00Z"},{"key":"limit","value":"5"},{"key":"offset","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1469"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 06 Jun 2024 05:03:38 GMT"},{"key":"x-amzn-RequestId","value":"70630031-fa24-4859-96ad-7bffd019dc8d"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-headers","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"1469"},{"key":"x-amzn-Remapped-connection","value":"close"},{"key":"x-amz-apigw-id","value":"Y7duaFW0SwMEitQ="},{"key":"etag","value":"W/\"5bd-6oWEsHyvMElFrx+vFkkvY7pSFho\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-66614328-1e20e043524b18ad1e487cc2;Parent=79b4fc3ac6a66ae4;Sampled=0;lineage=c1da79a7:0"},{"key":"x-amzn-Remapped-date","value":"Thu, 06 Jun 2024 05:03:38 GMT"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 dd92061892eeccf2295e6eb3a8dfc954.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD62-P3"},{"key":"X-Amz-Cf-Id","value":"20sJ77U9rG8Q28Yi7XYYmoGOJc9p6A6GGl0L_jJm1vin1fqScjVk8A=="}],"cookie":[],"responseTime":null,"body":"[\n {\n \"created_at\": \"2024-05-14T10:57:27.000Z\",\n \"assessment_type\": \"Handheld Device\",\n \"sweetness\": \"4\",\n \"sweetness_unit\": \"°Bx\",\n \"colour\": \"dd\",\n \"diameter\": \"3\",\n \"diameter_unit\": \"cm\",\n \"weight\": \"33\",\n \"weight_unit\": \"g\",\n \"outlook\": [\n \"Discoloration\"\n ],\n \"firmness\": \"3\",\n \"firmness_unit\": \"kgf\",\n \"notes\": null,\n \"assessor\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-15T01:12:01.000Z\",\n \"assessment_type\": \"Destructive\",\n \"sweetness\": \"2\",\n \"sweetness_unit\": \"°Bx\",\n \"colour\": \"ed\",\n \"diameter\": \"2\",\n \"diameter_unit\": \"cm\",\n \"weight\": \"33\",\n \"weight_unit\": \"g\",\n \"outlook\": [\n \"Discoloration\"\n ],\n \"firmness\": \"3\",\n \"firmness_unit\": \"kgf\",\n \"notes\": null,\n \"assessor\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-15T01:46:23.000Z\",\n \"assessment_type\": \"Destructive\",\n \"sweetness\": \"3\",\n \"sweetness_unit\": \"°Bx\",\n \"colour\": \"f\",\n \"diameter\": \"-1\",\n \"diameter_unit\": \"cm\",\n \"weight\": \"33\",\n \"weight_unit\": \"g\",\n \"outlook\": [\n \"Blemish\"\n ],\n \"firmness\": \"-2\",\n \"firmness_unit\": \"kgf\",\n \"notes\": null,\n \"assessor\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-15T01:58:30.000Z\",\n \"assessment_type\": \"Destructive\",\n \"sweetness\": \"3\",\n \"sweetness_unit\": \"°Bx\",\n \"colour\": \"3\",\n \"diameter\": \"2\",\n \"diameter_unit\": \"cm\",\n \"weight\": \"0\",\n \"weight_unit\": \"g\",\n \"outlook\": [\n \"Rot\"\n ],\n \"firmness\": \"445\",\n \"firmness_unit\": \"kgf\",\n \"notes\": null,\n \"assessor\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-15T04:10:42.000Z\",\n \"assessment_type\": \"Mechanical Grader\",\n \"sweetness\": \"3\",\n \"sweetness_unit\": \"°Bx\",\n \"colour\": \"d\",\n \"diameter\": \"3\",\n \"diameter_unit\": \"cm\",\n \"weight\": \"3\",\n \"weight_unit\": \"g\",\n \"outlook\": [\n \"Rot\"\n ],\n \"firmness\": \"3\",\n \"firmness_unit\": \"kgf\",\n \"notes\": null,\n \"assessor\": \"Tobby Hal\"\n }\n]"},{"id":"2e72f3e0-3447-4929-8c11-5c0c414f638b","name":"403","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{BASE_URL}}/{{ENV}}/public/data_api/farm_events/fruit_quality_assessments?farm_gln=5936403145983&gln_extension=sssfgasdfgasdfgasdfg&start_time=2024-05-10T00:00:00Z&end_time=2024-06-06T00:00:00Z&limit=5&offset=0","host":["{{BASE_URL}}"],"path":["{{ENV}}","public","data_api","farm_events","fruit_quality_assessments"],"query":[{"key":"farm_gln","value":"5936403145983"},{"key":"gln_extension","value":"sssfgasdfgasdfgasdfg"},{"key":"start_time","value":"2024-05-10T00:00:00Z"},{"key":"end_time","value":"2024-06-06T00:00:00Z"},{"key":"limit","value":"5","description":"Optional"},{"key":"offset","value":"0","description":"Optional"},{"key":"time_order","value":"ASC","description":"Optional ASC or DESC","type":"text","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"220"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 13 Jun 2024 06:34:46 GMT"},{"key":"x-amzn-RequestId","value":"8de3a06e-439f-4339-8194-6a5ad047f913"},{"key":"access-control-allow-origin","value":"*"},{"key":"x-ratelimit-reset","value":"1718260777"},{"key":"access-control-allow-headers","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"220"},{"key":"x-amzn-Remapped-connection","value":"close"},{"key":"x-ratelimit-remaining","value":"510"},{"key":"x-amz-apigw-id","value":"ZSvo9E-TSwMEf0g="},{"key":"x-ratelimit-limit","value":"512"},{"key":"etag","value":"W/\"dc-eRuNZv6KzzsCAlDGCW9i94mVbd8\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-666a9305-6ca7b741626222126f2e75d9;Parent=163de38299abe070;Sampled=0;lineage=c1da79a7:0"},{"key":"x-amzn-Remapped-date","value":"Thu, 13 Jun 2024 06:34:45 GMT"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 55995d846c30878fb2be24f27b355ccc.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD1-C1"},{"key":"X-Amz-Cf-Id","value":"yW8Y-y8rfP3Fnp3Ngi0QEyd7H-zAymenw1XoKZQ5lZuW-KH-amsQnA=="}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"8de3a06e-439f-4339-8194-6a5ad047f913\",\n \"code\": 403,\n \"detail\": \"This api key is not allowed to access this event type\",\n \"message\": \"This api key is not allowed to access this event type\",\n \"source\": \"Internal error source\"\n}"}],"_postman_id":"da066afa-82d1-4826-aa64-7ebe99665654"},{"name":"get_chemical_nutrient_events","id":"2fc20845-cbdc-4927-a094-70092a5f9438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Method: GET
\nAuth: Requires JWT generated by the OAuth API to pass the authentication.
\nDescription:
Retrieve a list of chemical nutrient applications Event Data based on the provided query parameters.
Query Parameters:
\nfarm_gln (required): The Global Location Number (GLN) of the farm.
Must be a non-empty string with a maximum length of 13 digits.
\nMust be numeric.
\ngln_extension (required): The GLN extension of the farm feature.
Ensure the GLN extension is properly URL-encoded according to standard URL encoding practices.
\nMust be a non-empty string with a maximum length of 20 characters.
\nstart_time (required): The start time for the applications.
Must be a non-empty string in ISO8601 format.
\nTime zone info is needed:
Examples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
end_time (required): The end time for the applications.
Must be a non-empty string in ISO8601 format.
\nTime zone info is needed:
Examples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
time_order (optional): The order of the results by time.
ASC or DESC.limit (optional): The maximum number of results to return.
offset (optional): The number of results to skip before starting to collect the result set.
Response:
\nStatus Code: 200 OK
Content-Type: application/json
Description: The response will include an array of chemical nutrient applications, each containing the following fields:
\n[\n {\n \"created_at\": \"string (ISO8601 date)\",\n \"name\": \"string\",\n \"application_type\": \"string (enum: 'Organic', 'Synthetic', 'Natural Mineral', 'Biofertiliser', 'Sustainable')\",\n \"dilution_rate\": \"string\",\n \"dilution_rate_unit\": \"string (enum: 'mL/L', 'mg/Kg')\",\n \"application_rate\": \"string\",\n \"application_rate_unit\": \"string (enum: 'L/Ha', 'Kg/Ha')\",\n \"application_method\": \"string (enum: 'Spraying', 'Dusting', 'Drenching', 'Fogging', 'Injection', 'Fertigation')\",\n \"reason_for_application\": \"string\",\n \"cover_crop\": \"string or null\",\n \"wind_speed\": \"string or null\",\n \"wind_speed_unit\": \"string (enum: 'km/h')\",\n \"wind_direction\": \"string or null (enum: 'N', 'NE', 'E', 'SE', 'S', 'SW', 'W', 'NW')\",\n \"temperature\": \"string or null\",\n \"temperature_unit\": \"string (enum: '°C')\",\n \"batch_lot_no\": \"string or null\",\n \"gtin\": \"string or null\",\n \"chemical_production_date\": \"string (ISO8601 date) or null\",\n \"notes\": \"string or null\",\n \"applicator\": \"string\"\n }\n]\n\nNeed URL Encode
\n","type":"text/plain"},"key":"gln_extension","value":"C7Nue4i6xJ*%28xZluvfWr"},{"description":{"content":"Time zone info is needed:\nExamples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
\n","type":"text/plain"},"key":"start_time","value":"2024-05-10T00:00:00Z"},{"description":{"content":"Time zone info is needed:\nExamples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
\n","type":"text/plain"},"key":"end_time","value":"2024-06-06T00:00:00Z"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Optional ASC or DESC
\n","type":"text/plain"},"key":"time_order","value":"ASC"}],"variable":[]}},"response":[{"id":"83c017f4-061d-4f7b-971c-7819ef687128","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://4nkg802y99.execute-api.ap-southeast-2.amazonaws.com/dev/public/data_api/farm_events/chemical_nutrient_applications?farm_gln=5936403145983&gln_extension=C7Nue4i6xJ*%28xZluvfWr&start_time=2024-05-10T00:00:00Z&end_time=2024-06-06T00:00:00Z&limit=5&offset=0","protocol":"https","host":["4nkg802y99","execute-api","ap-southeast-2","amazonaws","com"],"path":["dev","public","data_api","farm_events","chemical_nutrient_applications"],"query":[{"key":"farm_gln","value":"5936403145983"},{"key":"gln_extension","value":"C7Nue4i6xJ*%28xZluvfWr","description":"URL encoded"},{"key":"start_time","value":"2024-05-10T00:00:00Z"},{"key":"end_time","value":"2024-06-06T00:00:00Z"},{"key":"limit","value":"5"},{"key":"offset","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1580"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 06 Jun 2024 05:03:57 GMT"},{"key":"x-amzn-RequestId","value":"e9019998-3065-4910-abf0-81f277b9da4e"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-headers","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"1580"},{"key":"x-amzn-Remapped-connection","value":"close"},{"key":"x-amz-apigw-id","value":"Y7dxYEDBSwMEUSQ="},{"key":"etag","value":"W/\"62c-LuYd1Y1p+SZjTpsDgpjRz3iMBLQ\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6661433b-5548509c0e56ee0029537834;Parent=052df31c4eaf9ee5;Sampled=0;lineage=c1da79a7:0"},{"key":"x-amzn-Remapped-date","value":"Thu, 06 Jun 2024 05:03:57 GMT"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 dd92061892eeccf2295e6eb3a8dfc954.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD62-P3"},{"key":"X-Amz-Cf-Id","value":"Dk2a0KcRlPelGPUFtvPmWZkIOWnbBuMRec2SfbBRMA7_1m2IHHWzhQ=="}],"cookie":[],"responseTime":null,"body":"[\n {\n \"created_at\": \"2024-05-14T10:27:30.000Z\",\n \"name\": \"dd\",\n \"application_type\": \"Organic\",\n \"dilution_rate\": \"2\",\n \"dilution_rate_unit\": \"mL/L\",\n \"application_rate\": \"2.9968\",\n \"application_rate_unit\": \"L/Ha\",\n \"application_method\": \"Dusting\",\n \"reason_for_application\": \"dd\",\n \"cover_crop\": null,\n \"wind_speed\": null,\n \"wind_speed_unit\": \"km/h\",\n \"wind_direction\": null,\n \"temperature\": null,\n \"temperature_unit\": \"°C\",\n \"batch_lot_no\": null,\n \"gtin\": null,\n \"chemical_production_date\": null,\n \"notes\": null,\n \"applicator\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-15T01:16:36.000Z\",\n \"name\": \"r\",\n \"application_type\": \"Natural Mineral\",\n \"dilution_rate\": \"5\",\n \"dilution_rate_unit\": \"mL/L\",\n \"application_rate\": \"8\",\n \"application_rate_unit\": \"L/Ha\",\n \"application_method\": \"Fogging\",\n \"reason_for_application\": \"sh\",\n \"cover_crop\": null,\n \"wind_speed\": null,\n \"wind_speed_unit\": \"km/h\",\n \"wind_direction\": null,\n \"temperature\": null,\n \"temperature_unit\": \"°C\",\n \"batch_lot_no\": null,\n \"gtin\": null,\n \"chemical_production_date\": null,\n \"notes\": null,\n \"applicator\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-22T05:19:58.000Z\",\n \"name\": \"gdtrge\",\n \"application_type\": \"Biofertiliser\",\n \"dilution_rate\": \"33\",\n \"dilution_rate_unit\": \"mL/L\",\n \"application_rate\": \"2.9988\",\n \"application_rate_unit\": \"L/Ha\",\n \"application_method\": \"Fertigation\",\n \"reason_for_application\": \"frefwef\",\n \"cover_crop\": \"fr\",\n \"wind_speed\": \"3\",\n \"wind_speed_unit\": \"km/h\",\n \"wind_direction\": \"SW\",\n \"temperature\": \"4\",\n \"temperature_unit\": \"°C\",\n \"batch_lot_no\": \"234234 \",\n \"gtin\": \"312312312312 \",\n \"chemical_production_date\": \"2024-05-22T05:19:00.000Z\",\n \"notes\": \"few\",\n \"applicator\": \"Tobby Hal\"\n }\n]"}],"_postman_id":"2fc20845-cbdc-4927-a094-70092a5f9438"},{"name":"get_irrigation_events","id":"4c57ec59-f85f-456d-9692-dd667f688421","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Method: GET
\nAuth: Requires JWT generated by the OAuth API to pass the authentication.
\nDescription:
Retrieve a list of irrigation applications Event Data based on the provided query parameters.
Query Parameters:
\nfarm_gln (required): The Global Location Number (GLN) of the farm.
Must be a non-empty string with a maximum length of 13 digits.
\nMust be numeric.
\ngln_extension (required): The GLN extension of the farm feature.
Ensure the GLN extension is properly URL-encoded according to standard URL encoding practices.
\nMust be a non-empty string with a maximum length of 20 characters.
\nstart_time (required): The start time for the applications.
Must be a non-empty string in ISO8601 format.
\nTime zone info is needed:
Examples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
end_time (required): The end time for the applications.
Must be a non-empty string in ISO8601 format.
\nTime zone info is needed:
Examples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
time_order (optional): The order of the results by time.
ASC or DESC.limit (optional): The maximum number of results to return.
offset (optional): The number of results to skip before starting to collect the result set.
Response:
\nStatus Code: 200 OK
Content-Type: application/json
Description: The response will include an array of irrigation applications, each containing the following fields:
\n[\n {\n \"created_at\": \"string (ISO8601 date)\",\n \"irrigation_type\": \"string (enum: 'sprinkler', 'drip', 'flood', 'bay', 'non irrigated')\",\n \"irrigation_district\": \"string\",\n \"water_source\": \"string (enum: 'Pumped', 'Dam')\",\n \"application_rate\": \"string\",\n \"application_rate_unit\": \"string (enum: 'MgL/Ha')\",\n \"irrigator_energy\": \"string (enum: 'pressure', 'solar', 'diesel', 'electric')\",\n \"notes\": \"string or null\",\n \"irrigator\": \"string\"\n }\n]\n\nNeed URL Encode
\n","type":"text/plain"},"key":"gln_extension","value":"C7Nue4i6xJ*%28xZluvfWr"},{"description":{"content":"Time zone info is needed:\nExamples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
\n","type":"text/plain"},"key":"start_time","value":"2024-05-10T00:00:00Z"},{"description":{"content":"Time zone info is needed:\nExamples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
\n","type":"text/plain"},"key":"end_time","value":"2024-06-22T00:00:00Z"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Optional ASC or DESC
\n","type":"text/plain"},"key":"time_order","value":"ASC"}],"variable":[]}},"response":[{"id":"a01919bb-0c2b-4c25-b16e-88c0cad1af8b","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://4nkg802y99.execute-api.ap-southeast-2.amazonaws.com/dev/public/data_api/farm_events/irrigation?farm_gln=5936403145983&gln_extension=C7Nue4i6xJ*%28xZluvfWr&start_time=2024-05-10T00:00:00Z&end_time=2024-06-06T00:00:00Z&limit=5&offset=0","protocol":"https","host":["4nkg802y99","execute-api","ap-southeast-2","amazonaws","com"],"path":["dev","public","data_api","farm_events","irrigation"],"query":[{"key":"farm_gln","value":"5936403145983"},{"key":"gln_extension","value":"C7Nue4i6xJ*%28xZluvfWr","description":"URL encoded"},{"key":"start_time","value":"2024-05-10T00:00:00Z"},{"key":"end_time","value":"2024-06-06T00:00:00Z"},{"key":"limit","value":"5"},{"key":"offset","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"970"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 06 Jun 2024 05:03:28 GMT"},{"key":"x-amzn-RequestId","value":"b63a29f6-d278-46fb-ae74-45f4cf533a41"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-headers","value":"*"},{"key":"x-amzn-Remapped-content-length","value":"970"},{"key":"x-amzn-Remapped-connection","value":"close"},{"key":"x-amz-apigw-id","value":"Y7ds2GaVywMEGCw="},{"key":"etag","value":"W/\"3ca-9AlIUidR8bbnRbKMBCbfYyJq130\""},{"key":"x-powered-by","value":"Express"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6661431e-60ac5d3308e25f44204a5c51;Parent=5117470ccecc0796;Sampled=0;lineage=c1da79a7:0"},{"key":"x-amzn-Remapped-date","value":"Thu, 06 Jun 2024 05:03:28 GMT"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 dd92061892eeccf2295e6eb3a8dfc954.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SYD62-P3"},{"key":"X-Amz-Cf-Id","value":"mYbHs21Qq_SnE2DoiaKE7mtJvwDbwP7xXI2h8wCnVoLbRkkuBn2c7Q=="}],"cookie":[],"responseTime":null,"body":"[\n {\n \"created_at\": \"2024-05-14T23:30:48.000Z\",\n \"irrigation_type\": \"non irrigated\",\n \"irrigation_district\": \"ss\",\n \"water_source\": \"Pumped\",\n \"application_rate\": \"1.9986\",\n \"application_rate_unit\": \"MgL/Ha\",\n \"irrigator_energy\": \"diesel\",\n \"notes\": null,\n \"irrigator\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-15T04:28:56.000Z\",\n \"irrigation_type\": \"drip\",\n \"irrigation_district\": \"e\",\n \"water_source\": \"Dam\",\n \"application_rate\": \"8\",\n \"application_rate_unit\": \"MgL/Ha\",\n \"irrigator_energy\": \"diesel\",\n \"notes\": null,\n \"irrigator\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-16T23:44:00.000Z\",\n \"irrigation_type\": \"bay\",\n \"irrigation_district\": \"s\",\n \"water_source\": \"Dam\",\n \"application_rate\": \"2\",\n \"application_rate_unit\": \"MgL/Ha\",\n \"irrigator_energy\": \"electric\",\n \"notes\": null,\n \"irrigator\": \"Tobby Hal\"\n },\n {\n \"created_at\": \"2024-05-17T01:24:18.000Z\",\n \"irrigation_type\": \"sprinkler\",\n \"irrigation_district\": \"t\",\n \"water_source\": \"Pumped\",\n \"application_rate\": \"2\",\n \"application_rate_unit\": \"MgL/Ha\",\n \"irrigator_energy\": \"electric\",\n \"notes\": null,\n \"irrigator\": \"Tobby Hal\"\n }\n]"}],"_postman_id":"4c57ec59-f85f-456d-9692-dd667f688421"},{"name":"create_pest_disease_weed_event","id":"abe662ea-fc36-44f5-97a2-e917f579c931","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Method: POST
\nAuth: Requires JWT generated by the OAuth API to pass the authentication.
\nDescription:
Create a new pest, disease, and weed assessment with the provided data.
Body Parameters:
\nfarm_gln (required): The Global Location Number (GLN) of the farm.
Must be a non-empty string with a maximum length of 13 digits.
\nMust be numeric.
\ngln_extension (required): The GLN extension of the farm feature.
No need to URL encode the string in the POST body field.
\nMust be a non-empty string with a maximum length of 20 characters.
\nevent_data (required): An object containing the event data.
event_data.notes (optional): Notes for the event.
event_data.created_at (required): The creation date of the event.
Must be a non-empty string in ISO8601 format.
\nTime zone info is needed:
Examples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
event_data.species (required): The species involved in the event.
event_data.population_density (optional): The population density.
event_data.symptoms (required): Symptoms observed.
event_data.damage_assessment (required): The damage assessment.
event_data.control_measures_applied (required): Control measures applied.
cultural, biological, mechanical, chemical.event_data.population_density_unit (optional): The unit for population density.
Percentage.Response:
\nStatus Code: 200 Created
Content-Type: application/json
Description: The response will include the details of the newly created pest, disease, and weed assessment.
\nMethod: POST
\nAuth: Requires JWT generated by the OAuth API to pass the authentication.
\nDescription:
Create a new fruit quality assessment with the provided data.
Body Parameters:
\nfarm_gln (required): The Global Location Number (GLN) of the farm.
Must be a non-empty string with a maximum length of 13 digits.
\nMust be numeric.
\ngln_extension (required): The GLN extension of the farm feature.
No need to URL encode the string in the POST body field.
\nMust be a non-empty string with a maximum length of 20 characters.
\nevent_data (required): An object containing the event data.
event_data.notes (optional): Notes for the event.
event_data.created_at (required): The creation date of the event.
Must be a non-empty string in ISO8601 format.
\nTime zone info is needed:
Examples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
event_data.assessment_type (required): The type of assessment.
Destructive, Handheld Device, Mechanical Grader.event_data.sweetness (required): The sweetness measurement.
event_data.sweetness_unit (required): The unit for sweetness.
°Bx.event_data.weight (required): The weight measurement.
event_data.weight_unit (required): The unit for weight.
g.event_data.diameter (required): The diameter measurement.
event_data.diameter_unit (required): The unit for diameter.
cm.event_data.firmness (required): The firmness measurement.
event_data.firmness_unit (required): The unit for firmness.
kgf, N.event_data.outlook (required): The outlook of the fruit.
Must be an array.
\nMust contain at least one of the specified enum values: Blemish, Rot, Discoloration, None.
event_data.colour (required): The colour of the fruit.
Response:
\nStatus Code: 200 Created
Content-Type: application/json
Description: The response will include the details of the newly created fruit quality assessment.
\nMethod: POST
\nAuth: Requires JWT generated by the OAuth API to pass the authentication.
\nDescription:
Create a new chemical nutrient application with the provided data.
Body Parameters:
\nfarm_gln (required): The Global Location Number (GLN) of the farm.
Must be a non-empty string with a maximum length of 13 digits.
\nMust be numeric.
\ngln_extension (required): The GLN extension of the farm feature.
No need to URL encode the string in the POST body field.
\nMust be a non-empty string with a maximum length of 20 characters.
\nevent_data (required): An object containing the event data.
event_data.notes (optional): Notes for the event.
event_data.created_at (required): The creation date of the event.
Must be a non-empty string in ISO8601 format.
\nTime zone info is needed:
Examples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
event_data.application_type (required): The type of application.
Organic, Synthetic, Natural Mineral, Biofertiliser, Sustainable.event_data.application_method (required): The method of application.
Spraying, Dusting, Drenching, Fogging, Injection, Fertigation.event_data.wind_speed (optional): The wind speed during application.
event_data.wind_speed_unit (optional): The unit for wind speed.
km/h.event_data.wind_direction (optional): The wind direction during application.
N, NE, E, SE, S, SW, W, NW.event_data.temperature (optional): The temperature during application.
event_data.temperature_unit (optional): The unit for temperature.
°C.event_data.dilution_rate (required): The dilution rate of the chemical.
event_data.dilution_rate_unit (required): The unit for dilution rate.
mL/L, mg/Kg.event_data.application_rate (required): The application rate of the chemical.
event_data.application_rate_unit (required): The unit for application rate.
L/Ha, Kg/Ha.event_data.name (required): The name of the chemical.
event_data.batch_lot_no (required): The batch or lot number of the chemical.
event_data.gtin (required): The Global Trade Item Number (GTIN) of the chemical.
event_data.chemical_production_date (optional): The production date of the chemical.
event_data.reason_for_application (required): The reason for applying the chemical.
event_data.cover_crop (optional): The cover crop used during the application.
Response:
\nStatus Code: 200 Created
Content-Type: application/json
Description: The response will include the details of the newly created chemical nutrient application.
\nMethod: POST
\nAuth: Requires JWT generated by the OAuth API to pass the authentication.
\nDescription:
Create a new irrigation application with the provided data.
Body Parameters:
\nfarm_gln (required): The Global Location Number (GLN) of the farm.
Must be a non-empty string with a maximum length of 13 digits.
\nMust be numeric.
\ngln_extension (required): The GLN extension of the farm feature.
No need to URL encode the string in the POST body field.
\nMust be a non-empty string with a maximum length of 20 characters.
\nevent_data (required): An object containing the event data.
event_data.notes (optional): Notes for the event.
event_data.created_at (required): The creation date of the event.
Must be a non-empty string in ISO8601 format.
\nTime zone info is needed:
Examples: 2024-06-27T17:00:00+10:00 for Melbourne time, or 2024-06-27T07:00:00Z for UTC time.
event_data.irrigation_type (required): The type of irrigation.
sprinkler, drip, flood, bay, non irrigated.event_data.irrigation_district (required): The irrigation district.
event_data.water_source (required): The source of water used for irrigation.
Pumped, Dam.event_data.application_rate (required): The application rate of the irrigation.
event_data.irrigator_energy (required): The energy source for the irrigator.
pressure, solar, diesel, electric.event_data.application_rate_unit (required): The unit for application rate.
MgL/Ha.Response:
\nStatus Code: 200 Created
Content-Type: application/json
Description: The response will include the details of the newly created irrigation application.
\nPublic Event API for third-party users to access to event data.
\nPublic user need to perform oauth with client id and secret to access public event APIs with JWT token
\n","_postman_id":"e4241a8d-1cd4-4974-a069-2cc184d0b099"},{"name":"oauth","item":[{"name":"token","id":"7e999642-eced-4419-9ece-9ebc2860dbfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"key_id\": \"2cda12b1-0e83-494d-a297-39f5a1ecf82d\",\n \"key_secret\": \"9f975516a5c8f9db6cfb72a7bb043c78b93ed9aa6358fccd7c0d967eda5dbc21\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.tree2me.com.au/public/data_api/v1/oauth/token","description":"Method: POST
Description:
\nUsed by Public Users to exchange JWT access token to public data API by key id and key secret.
\nBody Parameters:
\nkey_id (required): The Key Id, is attached in the Email sent to key userskey_secret (required): The key secret, is attached in the email sent to key usersResponse:
\n200 OKapplication/jsonAPIs for get/refresh access JWT token for the public data API.
\nBased on oauth2 client password
\n","_postman_id":"5b76f955-10cc-4ca8-aa19-1dbc23bd2a35"}],"id":"5ef18918-a64f-42c3-a49a-aac1a0f616e9","description":"version 1 API
\n","_postman_id":"5ef18918-a64f-42c3-a49a-aac1a0f616e9"}]}