Pecuario.Backend

GetDashboard

The following routes are available for this service:
GET	/api/v1/dashboard

**GetDashboard** Parameters:
Name	Parameter	Data Type	Required
CountryId	query	int?	No
MaxAnimals	query	int?	No
MaxLands	query	int?	No

**GetDashboardResponse** Parameters:
Name	Parameter	Data Type	Required
AnimalCategories	form	List<AnimalCategory>	Yes
AnimalsByCategory	form	Dictionary<int, List<DashboardAnimal>>	Yes
Lands	form	List<DashboardLand>	Yes
Greeting	form	string	Yes
FarmsCount	form	int	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	form	Status	Yes

**Status** Parameters:
Name	Parameter	Data Type	Required	Description
Message	form	string	Yes
StatusCode	form	int	No

**AnimalCategory** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	Yes
Alias	form	string	Yes
Order	form	int	No
Enabled	form	bool	No

**DashboardLand** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	Yes
Description	form	string	Yes
Image	form	string	Yes
Type	form	string	Yes
Price	form	string	Yes
CityRegionName	form	string	Yes
PriceType	form	string	Yes

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/v1/dashboard HTTP/1.1 
Host: pecuario-backend.develsystems.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	animalCategories: 
	[
		{
			id: 0,
			name: String,
			alias: String,
			order: 0,
			enabled: False
		}
	],
	animalsByCategory: 
	{
		0: 
		[
			{
				id: String,
				description: String,
				image: String,
				type: String,
				price: String,
				cityRegionName: String,
				priceType: String
			}
		]
	},
	lands: 
	[
		{
			id: String,
			description: String,
			image: String,
			type: String,
			price: String,
			cityRegionName: String,
			priceType: String
		}
	],
	greeting: String,
	farmsCount: 0
}