Pecuario.Backend

<back to all web services

GetDashboard

The following routes are available for this service:
GET/api/v1/dashboard
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Pecuario.Backend.Application.DTOs;
using Pecuario.Backend.Domain.Entities;

namespace Pecuario.Backend.Application.DTOs
{
    public partial class BaseResponse
    {
        public virtual Status Status { get; set; }
    }

    public partial class DashboardLand
    {
        public virtual string Id { get; set; }
        public virtual string Description { get; set; }
        public virtual string Image { get; set; }
        public virtual string Type { get; set; }
        public virtual string Price { get; set; }
        public virtual string CityRegionName { get; set; }
        public virtual string PriceType { get; set; }
    }

    public partial class GetDashboard
        : IGet
    {
        public virtual int? CountryId { get; set; }
        public virtual int? MaxAnimals { get; set; }
        public virtual int? MaxLands { get; set; }
    }

    public partial class GetDashboardResponse
        : BaseResponse
    {
        public GetDashboardResponse()
        {
            AnimalCategories = new List<AnimalCategory>{};
            AnimalsByCategory = new Dictionary<int, List<DashboardAnimal>>{};
            Lands = new List<DashboardLand>{};
        }

        public virtual List<AnimalCategory> AnimalCategories { get; set; }
        public virtual Dictionary<int, List<DashboardAnimal>> AnimalsByCategory { get; set; }
        public virtual List<DashboardLand> Lands { get; set; }
        public virtual string Greeting { get; set; }
        public virtual int FarmsCount { get; set; }
    }

    public partial class Status
    {
        public virtual string Message { get; set; }
        public virtual int StatusCode { get; set; }
    }

}

namespace Pecuario.Backend.Domain.Entities
{
    public partial class AnimalCategory
    {
        public virtual int Id { get; set; }
        [Required]
        [StringLength(50)]
        public virtual string Name { get; set; }

        public virtual string Alias { get; set; }
        public virtual int Order { get; set; }
        public virtual bool Enabled { get; set; }
    }

}

C# GetDashboard DTOs

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
}