GET v2/ranches.{ext}

Returns a list of ranches that the user has access to

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of UserRanchesViewModel

Name	Description	Type	Additional information
Id	ranch ID	integer	None.
Ranch_External_GUID	ranch GUID	string	None.
Name	ranch name	string	None.
ActivePlantings	number of active plantings	integer	None.
UserIsRanchOwner	true if current user is ranch owner	boolean	None.
UserCanEditRanch	true if user has ranch edit permission	boolean	None.
UserCanEditPlanting	true if user has planting edit permission	boolean	None.
UserCanExportData	true if user has ranch export permission	boolean	None.
CreatedByUserId	ID of the user who created the ranch	string	None.
CreatedByFullName	full name of the user who created the ranch	string	None.
RanchOwnerId	ranch owner ID	string	None.
RanchOwnerFullName	full name of the ranch owner	string	None.

Response Formats

application/json, text/json, text/html

Sample:

[
  {
    "Id": 1,
    "Ranch_External_GUID": "sample string 2",
    "Name": "sample string 3",
    "ActivePlantings": 4,
    "UserIsRanchOwner": true,
    "UserCanEditRanch": true,
    "UserCanEditPlanting": true,
    "UserCanExportData": true,
    "CreatedByUserId": "sample string 9",
    "CreatedByFullName": "sample string 10",
    "RanchOwnerId": "sample string 11",
    "RanchOwnerFullName": "sample string 12"
  },
  {
    "Id": 1,
    "Ranch_External_GUID": "sample string 2",
    "Name": "sample string 3",
    "ActivePlantings": 4,
    "UserIsRanchOwner": true,
    "UserCanEditRanch": true,
    "UserCanEditPlanting": true,
    "UserCanExportData": true,
    "CreatedByUserId": "sample string 9",
    "CreatedByFullName": "sample string 10",
    "RanchOwnerId": "sample string 11",
    "RanchOwnerFullName": "sample string 12"
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserRanchesViewModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UserRanchesViewModel>
    <Id>1</Id>
    <Ranch_External_GUID>sample string 2</Ranch_External_GUID>
    <Name>sample string 3</Name>
    <ActivePlantings>4</ActivePlantings>
    <UserIsRanchOwner>true</UserIsRanchOwner>
    <UserCanEditRanch>true</UserCanEditRanch>
    <UserCanEditPlanting>true</UserCanEditPlanting>
    <UserCanExportData>true</UserCanExportData>
    <CreatedByUserId>sample string 9</CreatedByUserId>
    <CreatedByFullName>sample string 10</CreatedByFullName>
    <RanchOwnerId>sample string 11</RanchOwnerId>
    <RanchOwnerFullName>sample string 12</RanchOwnerFullName>
  </UserRanchesViewModel>
  <UserRanchesViewModel>
    <Id>1</Id>
    <Ranch_External_GUID>sample string 2</Ranch_External_GUID>
    <Name>sample string 3</Name>
    <ActivePlantings>4</ActivePlantings>
    <UserIsRanchOwner>true</UserIsRanchOwner>
    <UserCanEditRanch>true</UserCanEditRanch>
    <UserCanEditPlanting>true</UserCanEditPlanting>
    <UserCanExportData>true</UserCanExportData>
    <CreatedByUserId>sample string 9</CreatedByUserId>
    <CreatedByFullName>sample string 10</CreatedByFullName>
    <RanchOwnerId>sample string 11</RanchOwnerId>
    <RanchOwnerFullName>sample string 12</RanchOwnerFullName>
  </UserRanchesViewModel>
</ArrayOfUserRanchesViewModel>