POST MapInterface/ValidateMapInterfaceFieldPostModel
Validates the model for an add of an Agvance field; checking for duplicates and requirements for save.
Request Information
URI Parameters
Body Parameters
The model for the validation of an Agvance field add.
ClsFieldPost| Name | Description | Type | Additional Information |
|---|---|---|---|
| MappingCustomerGuid |
The Mapping Customer GUID to add the Agvance field for |
globally unique identifier |
Required (Hexadecimal 8-4-4-4-12) |
| MappingGuid |
The Mapping Field GUID to cross reference to the new Agvance Field |
globally unique identifier |
Required (Hexadecimal 8-4-4-4-12) |
| AgvanceCustomerGuid |
The Agvance GUID of the customer to assign the field to - if provided, the field will only be added for this customer and not all Agvance customers that are linked to the MappingCustomerGUID. If the AgvanceCustomerGUID is Null, add the field to all customers linked to the MappingCustomerGUID. |
globally unique identifier |
(Hexadecimal 8-4-4-4-12) |
| Name |
Description of the field |
string |
Required Max length: 30 |
| Acres |
Number of acres for the field |
decimal number | |
| FarmName |
Description for the farm |
string |
Max length: 50 |
| 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 the field |
decimal number |
Max of 6 decimal places Range: inclusive between -90 and 90 |
| GeoCodedLongitude |
Geocoded longitude of the field |
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
{
"MappingCustomerGuid": "e8bcc8b9-1503-4a2f-98d7-e9616db8cc3b",
"MappingGuid": "b09e5857-6a6f-495d-9212-b5d16901a406",
"AgvanceCustomerGuid": "40aa7ad4-fed4-4539-b48c-13f5f5b5a39d",
"Name": "sample string 3",
"Acres": 4.1,
"FarmName": "sample string 5",
"State": "sample string 6",
"County": "sample string 7",
"Township": "sample string 8",
"Range": "sample string 9",
"Section": "sample string 10",
"GeoCodedLatitude": 11.1,
"GeoCodedLongitude": 12.1,
"Directions": "sample string 13",
"Comments": "sample string 14",
"PolygonWktList": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
<ClsFieldPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Interfaces.HAAS.Model">
<Acres>4.1</Acres>
<AgvanceCustomerGuid>40aa7ad4-fed4-4539-b48c-13f5f5b5a39d</AgvanceCustomerGuid>
<Comments>sample string 14</Comments>
<County>sample string 7</County>
<Directions>sample string 13</Directions>
<FarmName>sample string 5</FarmName>
<GeoCodedLatitude>11.1</GeoCodedLatitude>
<GeoCodedLongitude>12.1</GeoCodedLongitude>
<MappingCustomerGuid>e8bcc8b9-1503-4a2f-98d7-e9616db8cc3b</MappingCustomerGuid>
<MappingGuid>b09e5857-6a6f-495d-9212-b5d16901a406</MappingGuid>
<Name>sample string 3</Name>
<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 9</Range>
<Section>sample string 10</Section>
<State>sample string 6</State>
<Township>sample string 8</Township>
</ClsFieldPost>
application/x-www-form-urlencoded
Response Information
Resource Description
Validates the model for an add of an Agvance field; checking for duplicates and requirements for save.
AgvMapInterfaceField| Name | 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": "f7cdd5b5-e46f-4a7a-8fc4-8ca9efadcf86",
"AgvanceGrowerGuid": "65462653-b3de-4b8d-8458-9c5c7ec9656e",
"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": "696edf2f-17e2-4788-bcd9-43ce128abc92",
"Inactive": true,
"FarmId": "sample string 11",
"FarmName": "sample string 12",
"FieldBoundaryWkt": "sample string 13",
"Directions": "sample string 14",
"Comments": "sample string 15"
},
{
"AgvanceGuid": "f7cdd5b5-e46f-4a7a-8fc4-8ca9efadcf86",
"AgvanceGrowerGuid": "65462653-b3de-4b8d-8458-9c5c7ec9656e",
"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": "696edf2f-17e2-4788-bcd9-43ce128abc92",
"Inactive": true,
"FarmId": "sample string 11",
"FarmName": "sample string 12",
"FieldBoundaryWkt": "sample string 13",
"Directions": "sample string 14",
"Comments": "sample string 15"
}
]
}