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.

Name	Description	Type	Additional Information
AgvanceGuid	The Agvance GUID of the field to update - if provided, the AgvanceGUID will be used to find the field. AKA dbo.FIELDS.MPSGUID	globally unique identifier	Required (Hexadecimal 8-4-4-4-12)
MappingGuid	The Mapping GUID of the field to cross reference to the Agvance field. AKA HaasMaster.dbo.Field.FieldGuid	globally unique identifier	(Hexadecimal 8-4-4-4-12)
NewAgvanceCustomerGuid	The Agvance GUID of the customer to move this field to. AKA dbo.GROWER.MPSGUID	globally unique identifier	(Hexadecimal 8-4-4-4-12)
Name	The Mapping Field Name that is used to update the Agvance field description AKA dbo.FIELDS.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. AKA dbo.Farm.Description	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
LocationId	LocationId assigned to the field	string	Max length: 6
Split2Name	Split2Name assigned to the field	string	Max length: 10
Split3Name	Split3Name assigned to the field	string	Max length: 10
BillingSplits	BillingSplits assigned to the field	Collection of ClsBillingSplit	Maximum of 8 allowed

Request Formats

application/json, text/json

Sample:

{
  "AgvanceGuid": "004b30cb-1c60-4793-ba6c-0ca42a0833a3",
  "MappingGuid": "492ff015-37c1-4d80-906d-7a1c3fa3ebce",
  "NewAgvanceCustomerGuid": "387a3f41-f259-41a2-8290-5dddacaeb9ff",
  "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"
  ],
  "LocationId": "sample string 16",
  "Split2Name": "sample string 17",
  "Split3Name": "sample string 18",
  "BillingSplits": [
    {
      "SplitGrowerId": "sample string 1",
      "PercentS1": 2.1,
      "PercentS2": 3.1,
      "PercentS3": 4.1
    },
    {
      "SplitGrowerId": "sample string 1",
      "PercentS1": 2.1,
      "PercentS2": 3.1,
      "PercentS3": 4.1
    }
  ]
}

application/xml, text/xml

Sample:

<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>004b30cb-1c60-4793-ba6c-0ca42a0833a3</AgvanceGuid>
  <BillingSplits>
    <ClsBillingSplit>
      <PercentS1>2.1</PercentS1>
      <PercentS2>3.1</PercentS2>
      <PercentS3>4.1</PercentS3>
      <SplitGrowerId>sample string 1</SplitGrowerId>
    </ClsBillingSplit>
    <ClsBillingSplit>
      <PercentS1>2.1</PercentS1>
      <PercentS2>3.1</PercentS2>
      <PercentS3>4.1</PercentS3>
      <SplitGrowerId>sample string 1</SplitGrowerId>
    </ClsBillingSplit>
  </BillingSplits>
  <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>
  <LocationId>sample string 16</LocationId>
  <MappingGuid>492ff015-37c1-4d80-906d-7a1c3fa3ebce</MappingGuid>
  <Name>sample string 2</Name>
  <NewAgvanceCustomerGuid>387a3f41-f259-41a2-8290-5dddacaeb9ff</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>
  <Split2Name>sample string 17</Split2Name>
  <Split3Name>sample string 18</Split3Name>
  <State>sample string 7</State>
  <Township>sample string 9</Township>
</ClsFieldPut>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsFieldPut'.

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.

AgvMapInterfaceField

Name	Description	Type
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

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "FieldList": [
    {
      "AgvanceGuid": "6603cad0-7a6f-4823-bc75-83819d9d5def",
      "AgvanceGrowerGuid": "3698a717-c622-41a6-b520-49d6957f813c",
      "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": "25dcfeab-8261-4954-951c-6cc52ab6bb3a",
      "Inactive": true,
      "FarmId": "sample string 11",
      "FarmName": "sample string 12",
      "FieldBoundaryWkt": "sample string 13",
      "Directions": "sample string 14",
      "Comments": "sample string 15"
    },
    {
      "AgvanceGuid": "6603cad0-7a6f-4823-bc75-83819d9d5def",
      "AgvanceGrowerGuid": "3698a717-c622-41a6-b520-49d6957f813c",
      "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": "25dcfeab-8261-4954-951c-6cc52ab6bb3a",
      "Inactive": true,
      "FarmId": "sample string 11",
      "FarmName": "sample string 12",
      "FieldBoundaryWkt": "sample string 13",
      "Directions": "sample string 14",
      "Comments": "sample string 15"
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: No set method for property 'GrowerFullName' in type 'SKY.Core.Interfaces.HAAS.Model.ClsFieldGet'.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: No set method for property 'GrowerFullName' in type 'SKY.Core.Interfaces.HAAS.Model.ClsFieldGet'.