POST v3/ranches.{ext}

Creates a new ranch

Request Information

URI Parameters

None.

Body Parameters

RanchUpdateParams
NameDescriptionTypeAdditional information
Name

Ranch name. Must be no more than 255 characters in length

string

Required

Coordinates

Ranch coordinates. E.g. "34.813328, -113.541914"

string

Required

Acres

Optional field, used for usage statistics

decimal number

Range: inclusive between 0 and 2147483647

Request Formats

application/json, text/json, text/html

Sample:
{
  "Name": "sample string 1",
  "Coordinates": "sample string 2",
  "Acres": 1.0
}

application/xml, text/xml

Sample:
<RanchUpdateParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 1</Name>
  <Coordinates>sample string 2</Coordinates>
  <Acres>1</Acres>
</RanchUpdateParams>

Response Information

Resource Description

RanchCreateResponse
NameDescriptionTypeAdditional information
Id

Ranch ID

integer

None.

Guid

Ranch GUID

globally unique identifier

None.

WeatherAPI_Id

Weather Service Id

integer

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "Id": 1,
  "Guid": "487ab110-f3b2-4a74-89d6-7eac90b271f9",
  "WeatherAPI_Id": 1
}

application/xml, text/xml

Sample:
<RanchCreateResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <Guid>487ab110-f3b2-4a74-89d6-7eac90b271f9</Guid>
  <WeatherAPI_Id>1</WeatherAPI_Id>
</RanchCreateResponse>