GET PlanList/GetFieldPlan?CustID={CustID}&FieldID={FieldID}&Location={Location}&StartDate={StartDate}&EndDate={EndDate}
Returns a list of field plans.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
CustID |
CustID of the field plan to return. |
string |
Required |
FieldID |
FieldID of the field plan to return. (optional) |
string |
Default value is string.Empty |
Location |
Location of the field plan to return. (optional) |
string |
Default value is ALL |
StartDate |
Include all field plans ordered on or after this date. Format MM-dd-yyyy (optional) |
string |
Default value is string.Empty |
EndDate |
Include all field plans ordered on or before this date. Format MM-dd-yyyy (optional) |
string |
Default value is string.Empty |
Body Parameters
Response Information
Resource Description
Returns a list of field plans.
AgvPlanListName | Description | Type | Additional Information |
---|---|---|---|
Status |
Status of the API call. |
string | |
Message |
Message of the API call. |
string | |
Count |
Count of how many Field Plan JSON dictionaries. |
string | |
PlanListItems |
JSON dictionary of Field Plan |
Collection of ClsFldPlanListItem |
Response Formats
application/json, text/json
Sample:
{ "Status": "sample string 1", "Message": "sample string 2", "Count": "2", "PlanListItems": [ { "UniqueID": 1, "GrowerID": "sample string 2", "FieldID": "sample string 3", "AreaID": "sample string 4", "PlanID": "sample string 5", "LocationID": "sample string 6", "OrderedDate": "2024-11-21T09:57:35.9388127+00:00", "GrowerApproved": true }, { "UniqueID": 1, "GrowerID": "sample string 2", "FieldID": "sample string 3", "AreaID": "sample string 4", "PlanID": "sample string 5", "LocationID": "sample string 6", "OrderedDate": "2024-11-21T09:57:35.9388127+00:00", "GrowerApproved": true } ] }
application/xml, text/xml
Sample:
<AgvPlanList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Plan"> <Message>sample string 2</Message> <PlanListItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.plbl"> <d2p1:ClsFldPlan.ClsFldPlanListItem> <d2p1:AreaID>sample string 4</d2p1:AreaID> <d2p1:FieldID>sample string 3</d2p1:FieldID> <d2p1:GrowerApproved>true</d2p1:GrowerApproved> <d2p1:GrowerID>sample string 2</d2p1:GrowerID> <d2p1:LocationID>sample string 6</d2p1:LocationID> <d2p1:OrderedDate>2024-11-21T09:57:35.9388127+00:00</d2p1:OrderedDate> <d2p1:PlanID>sample string 5</d2p1:PlanID> <d2p1:UniqueID>1</d2p1:UniqueID> </d2p1:ClsFldPlan.ClsFldPlanListItem> <d2p1:ClsFldPlan.ClsFldPlanListItem> <d2p1:AreaID>sample string 4</d2p1:AreaID> <d2p1:FieldID>sample string 3</d2p1:FieldID> <d2p1:GrowerApproved>true</d2p1:GrowerApproved> <d2p1:GrowerID>sample string 2</d2p1:GrowerID> <d2p1:LocationID>sample string 6</d2p1:LocationID> <d2p1:OrderedDate>2024-11-21T09:57:35.9388127+00:00</d2p1:OrderedDate> <d2p1:PlanID>sample string 5</d2p1:PlanID> <d2p1:UniqueID>1</d2p1:UniqueID> </d2p1:ClsFldPlan.ClsFldPlanListItem> </PlanListItems> <Status>sample string 1</Status> </AgvPlanList>