POST MapInterface/ValidateMapInterfaceFieldPutModel
Validates the model for an update of an Agvance field; checking for active status and an ownership change of the field.
Request Information
URI Parameters
Body Parameters
The model for the validation of an Agvance field update.
ClsFieldPutName | Description | Type | Additional Information |
---|---|---|---|
AgvanceGuid |
The Agvance GUID of the field to update - if provided, the AgvanceGUID will be used to find the field |
globally unique identifier |
Required (Hexadecimal 8-4-4-4-12) |
MappingGuid |
The Mapping GUID of the field to cross reference to the Agvance field |
globally unique identifier |
(Hexadecimal 8-4-4-4-12) |
NewAgvanceCustomerGuid |
The Agvance GUID of the customer to move this field to |
globally unique identifier |
(Hexadecimal 8-4-4-4-12) |
Name |
The Mapping Field Name that is used to update the Agvance field description |
string |
Max length: 30 |
Inactive |
Indicates what the active status of the field should be set to |
boolean |
Must be 0, 1, True, or False |
FarmName |
The Mapping Farm Name that is used to update the Agvance farm description for the field being updated |
string |
Max length: 50 |
Acres |
Number of acres for the field - update only if the existing field has a zero value for acres or OverrideBillableAcres is set to true |
decimal number | |
OverrideBillableAcres |
Override that will force the Acres into the billable acres of the field |
boolean |
Must be 0, 1, True, or False |
State |
State assigned to the field |
string |
Max length: 2 |
County |
County assigned to the field |
string |
Max length: 20 |
Township |
Township assigned to the field |
string |
Max length: 15 |
Range |
Range assigned to the field |
string |
Max length: 10 |
Section |
Section assigned to the field |
string |
Max length: 10 |
GeoCodedLatitude |
Geocoded latitude of field - update only if the existing field has a zero value for latitude |
decimal number |
Max of 6 decimal places Range: inclusive between -90 and 90 |
GeoCodedLongitude |
Geocoded longitude of field - update only if the existing field has a zero value for longitude |
decimal number |
Max of 6 decimal places Range: inclusive between -180 and 180 |
Directions |
Directions to the field |
string | |
Comments |
Notes about the field |
string | |
PolygonWktList |
List of boundary polygons to save into the Agvance field boundary |
Collection of string |
Request Formats
application/json, text/json
{ "AgvanceGuid": "fbc5ac2c-71ee-49dd-880b-c0e8c2a37bcb", "MappingGuid": "072c0136-fabc-4121-9067-2d080ba1a928", "NewAgvanceCustomerGuid": "fb4866b5-1c71-45ee-98ca-24e574eb103c", "Name": "sample string 2", "Inactive": true, "FarmName": "sample string 4", "Acres": 5.1, "OverrideBillableAcres": true, "State": "sample string 7", "County": "sample string 8", "Township": "sample string 9", "Range": "sample string 10", "Section": "sample string 11", "GeoCodedLatitude": 12.1, "GeoCodedLongitude": 13.1, "Directions": "sample string 14", "Comments": "sample string 15", "PolygonWktList": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
<ClsFieldPut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Interfaces.HAAS.Model"> <Acres>5.1</Acres> <AgvanceGuid>fbc5ac2c-71ee-49dd-880b-c0e8c2a37bcb</AgvanceGuid> <Comments>sample string 15</Comments> <County>sample string 8</County> <Directions>sample string 14</Directions> <FarmName>sample string 4</FarmName> <GeoCodedLatitude>12.1</GeoCodedLatitude> <GeoCodedLongitude>13.1</GeoCodedLongitude> <Inactive>true</Inactive> <MappingGuid>072c0136-fabc-4121-9067-2d080ba1a928</MappingGuid> <Name>sample string 2</Name> <NewAgvanceCustomerGuid>fb4866b5-1c71-45ee-98ca-24e574eb103c</NewAgvanceCustomerGuid> <OverrideBillableAcres>true</OverrideBillableAcres> <PolygonWktList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </PolygonWktList> <Range>sample string 10</Range> <Section>sample string 11</Section> <State>sample string 7</State> <Township>sample string 9</Township> </ClsFieldPut>
application/x-www-form-urlencoded
Response Information
Resource Description
Validates the model for an update of an Agvance field; checking for active status and an ownership change of the field.
AgvMapInterfaceFieldName | Description | Type | Additional Information |
---|---|---|---|
Status |
0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful. |
string | |
Message |
Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know. |
string | |
Count |
Number of results returned. |
string | |
FieldList |
List of Properties and Values returned for each Agvance Field |
Collection of ClsFieldGet |
Response Formats
application/json, text/json
{ "Status": "sample string 1", "Message": "sample string 2", "Count": "2", "FieldList": [ { "AgvanceGuid": "2c64f3c4-ae2c-49ad-8432-ad8ad032aeaf", "AgvanceGrowerGuid": "ba1dc497-0334-404f-a7fd-7d57d6ec1cac", "GrowerId": "sample string 3", "GrowerFirstName": "sample string 4", "GrowerLastName": "sample string 5", "GrowerFullName": "sample string 4 sample string 5", "GrowerOracleId": "sample string 6", "FieldId": "sample string 7", "Name": "sample string 8", "Acres": 9.1, "MappingGuid": "9d323243-898a-4bd8-bb51-12b95b079bfa", "Inactive": true, "FarmId": "sample string 11", "FarmName": "sample string 12", "FieldBoundaryWkt": "sample string 13", "Directions": "sample string 14", "Comments": "sample string 15" }, { "AgvanceGuid": "2c64f3c4-ae2c-49ad-8432-ad8ad032aeaf", "AgvanceGrowerGuid": "ba1dc497-0334-404f-a7fd-7d57d6ec1cac", "GrowerId": "sample string 3", "GrowerFirstName": "sample string 4", "GrowerLastName": "sample string 5", "GrowerFullName": "sample string 4 sample string 5", "GrowerOracleId": "sample string 6", "FieldId": "sample string 7", "Name": "sample string 8", "Acres": 9.1, "MappingGuid": "9d323243-898a-4bd8-bb51-12b95b079bfa", "Inactive": true, "FarmId": "sample string 11", "FarmName": "sample string 12", "FieldBoundaryWkt": "sample string 13", "Directions": "sample string 14", "Comments": "sample string 15" } ] }