Constructor
new GrowingMethodController()
Source
Methods
create(siteId, createData) → {Promise.<GrowingMethodModel>}
Create a Growing Method [POST /packhouse/sites/{siteId}/growing-methods]
Parameters
-
siteId
numberThe Site ID
-
createData
GrowingMethodController.CreateDataThe Growing Method Create Data
Returns
-
Promise.<GrowingMethodModel>
Source
delete(siteId, id) → {Promise.<boolean>}
Delete a Growing Method [DELETE /packhouse/sites/{siteId}/growing-methods/{id}]
Parameters
-
siteId
numberThe Site ID
-
id
stringThe Growing Method ID
Returns
-
Promise.<boolean>
Source
getAll(siteId, queryParametersopt) → {Promise.<Array.<GrowingMethodModel>>}
List all Growing Methods [GET /packhouse/sites/{siteId}/growing-methods]
Parameters
-
siteId
numberThe Site ID
-
queryParameters
GrowingMethodController.GetAllQueryParameters<optional>
The Optional Query Parameters
Returns
-
Promise.<Array.<GrowingMethodModel>>
Source
getOne(siteId, id) → {Promise.<GrowingMethodModel>}
Retrieve a Growing Method [GET /packhouse/sites/{siteId}/growing-methods/{id}]
Parameters
-
siteId
numberThe Site ID
-
id
stringThe Growing Method ID
Returns
-
Promise.<GrowingMethodModel>
Source
update(siteId, id, updateData) → {Promise.<GrowingMethodModel>}
Update a Growing Method [PATCH /packhouse/sites/{siteId}/growing-methods/{id}]
Parameters
-
siteId
numberThe Site ID
-
id
stringThe Growing Method ID
-
updateData
GrowingMethodController.UpdateDataThe Growing Method Update Data
Returns
-
Promise.<GrowingMethodModel>
Source
Type Definitions
CreateData
The Create Data for a Growing Method
Type
-
Object
Properties
-
code
string<optional>
The Growing Method Code
-
name
stringThe Growing Method Name
-
description
stringThe Growing Method Description
Source
GetAllQueryParameters
The Optional Query Parameters for the getAll Function
Type
-
Object
Properties
-
code
string<optional>
The Growing Method Code
-
name
string<optional>
The Growing Method Name
Source
UpdateData
The Update Data for a Growing Method
Type
-
Object
Properties
-
name
string<optional>
The Growing Method Name
-
description
string<optional>
The Growing Method Description