WQM-03: Pesticide Product List (PestProdList) SERVICE-33518

WQM-03: Pesticide Product List (PestProdList)

This service returns a list of pesticide products, their names, EPA numbers, product types, active ingredients and percentages.
The data source is the NRCS pesticide database kept current on an annual basis.

This version of WQM-03 adds functionality and new parameter types. It also requires an updated version of the WQM Pesticides database.

Input Specifications

The input to this service requires a maximum products count, a JSON Array of filter elements, composed of a filter name, a filter value, and a logical search operator. The input request may contain as many elements as are necessary to perform a search. Only one element is required to be present.

{
"name":"max_products",
"value": <integer value>
},
{
"name": "filters",
"value": [<filter array element structure>...]
}

[
   {
   "name": "pp_filter_name",
   "value": <filter name>,
   },
   {
   "name": "pp_filter_value",
   "value": <filter value>,
   },
   {
   "name": <logical operator>,
   "value": true,
   }
]

Filter Names	Detail
"reg_no"	This column of the database contains the 11 digit registration number, zero padded. Example: 241-74 is stored as '00024100074'.
"prod_name"	This column of the database contains the product name that was registered. An EPA registration number may be associated with many product names
"company_code"	This column of the database contains the company code of the corporation, to whom the EPA registration number belongs. It is stored as an integer. Example: 241
"product_code"	This column of the database contains the product code of the EPA registration number. As noted above, the product_code portion of an EPA registration number may be associated with many product names

Logical Search Operators	Detail
"begins_with"	This operator when set requires that the filter value be found at the beginning of the information stored in the filter name database column. It is equivalent in SQL to using "LIKE 'filter_value%'
"ends_with"	This operator when set requires that the filter value be found at the end of the information stored in the filter name database column. It is equivalent in SQL to using "LIKE '%filter_value'
"contains"	This operator when set requires that the filter value be found somewhere in the information stored in the filter name database column. It is equivalent in SQL to using "LIKE '%filter_value%'
"is_exactly"	This operator when set requires that the filter value be found exactly in the information stored in the filter name database column. It is equivalent in SQL to using "=filter_value" [Note: This operator is not case dependent, and will match text without using a case-wise comparison. Thus, "abc" is the same as "ABC"]
Note	Operators (begins_with, ends_with, contains) make no sense for filter names product_code and company_code as these columns are integer values. Consequently, they should not be used for those filter names.


{
    "metainfo": {},
    "parameter": [
        {
            "name":"max_products",
            "value": 40

        },
	{
	    "name": "filters",
	    "value": [
                [
		    {
			"name": "pp_filter_name",
			"value": "company_code",
		    },
		    {
			"name": "pp_filter_value",
			"value": 241,
		    },
		    {
			"name": "is_exactly",
			"value": true,
		    }
                ],
                [
		    {
			"name": "pp_filter_name",
			"value": "product_code",
		    },
		    {
			"name": "pp_filter_value",
			"value": 74,
		    },
		    {
			"name": "is_exactly",
			"value": true,
		    }
                ]
	    ]
	}
    ]
}

{
  "result": [
    {
      "name": "result_count",
      "value": "1",
      "description": "Quantifies how many results were found for this search.  May be different than return_count if result_count exceeded the input variable for max_products"
    },
    {
      "name": "return_count",
      "value": 1,
      "description": "Actual count of products returned for this search.  May be smaller than the actual result size found, if max_products input value was set to a value less than the actual result size."
    },
    {
      "name": "pesticide_list",
      "value": [
        [
          {
            "name": "reg_no",
            "value": "00024100074",
            "description": "EPA product registration number (EPA Reg. No.) in padded form"
          },
          {
            "name": "app_area_id",
            "value": "1",
            "description": "Application Area String database Id"
          },
          {
            "name": "epa_code",
            "value": "241-74",
            "description": "EPA product registration number (EPA Reg. No.)"
          },
          {
            "name": "app_method_id",
            "value": "1",
            "description": "Application Method String database Id"
          },
          {
            "name": "pesticide_list",
            "value": [
              [
                {
                  "name": "product_id",
                  "value": "1874",
                  "description": "Database Id of the product name"
                },
                {
                  "name": "product_name",
                  "value": "CYCOCEL PLANT GROWTH REGULANT",
                  "description": "EPA product name"
                }
              ]
            ]
          },
          {
            "name": "active_ingredient_list",
            "value": [
              [
                {
                  "name": "ai_pct",
                  "value": "11.800",
                  "unit": "Percent",
                  "description": "Active ingredient percent"
                },
                {
                  "name": "ai_name",
                  "value": "Chlormequat chloride",
                  "description": "Active ingredient name"
                },
                {
                  "name": "default_app_rate_id",
                  "value": "1",
                  "description": "Default application rate database id"
                },
                {
                  "name": "ai_id",
                  "value": "553",
                  "description": "Active ingredient database Id"
                }
              ]
            ]
          }
        ]
      ],
      "description": "List of products found in the database matching the search criteria"
    }
  ]
}

Tracker:	Services	Priority:	Normal	Status:	Deployed
Submitted by:	casespMay 09 2017 10:39	Modified by:	rumpalJun 20 2018 10:32	Type:	Data
Path:	m/wqm/pestprodlist/2.0	Context:	csip-wqm	Version:	2.0
Endpoints:	http://csip.engr.colostate.edu:8092/csip-wqm/m/wqm/pestprodlist/2.0
Maintainers:	casesp
Website:	--	Apps:	--
Test Status:	--	Last Tested:	--	Test Count:	--
Test Success Rate:	--	Failed Tests:	--

New	May 09 2017 10:39
Submit	by casesp

Completed	May 09 2017 10:40
Complete	by casesp

Deployed	Jun 20 2018 10:32
	by rumpal

WQM-03: Pesticide Product List (PestProdList)[SERVICE-33518]

WQM-03: Pesticide Product List (PestProdList)

Input Specifications