Pecuario.Backend

GetDashboard

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Pecuario.Backend.Application.DTOs
Imports Pecuario.Backend.Domain.Entities

Namespace Global

    Namespace Pecuario.Backend.Application.DTOs

        Public Partial Class BaseResponse
            Public Overridable Property Status As Status
        End Class

        Public Partial Class DashboardLand
            Public Overridable Property Id As String
            Public Overridable Property Description As String
            Public Overridable Property Image As String
            Public Overridable Property Type As String
            Public Overridable Property Price As String
            Public Overridable Property CityRegionName As String
            Public Overridable Property PriceType As String
        End Class

        Public Partial Class GetDashboard
            Implements IGet
            Public Overridable Property CountryId As Nullable(Of Integer)
            Public Overridable Property MaxAnimals As Nullable(Of Integer)
            Public Overridable Property MaxLands As Nullable(Of Integer)
        End Class

        Public Partial Class GetDashboardResponse
            Inherits BaseResponse
            Public Sub New()
                AnimalCategories = New List(Of AnimalCategory)
                AnimalsByCategory = New Dictionary(Of Integer, List(Of DashboardAnimal))
                Lands = New List(Of DashboardLand)
            End Sub

            Public Overridable Property AnimalCategories As List(Of AnimalCategory)
            Public Overridable Property AnimalsByCategory As Dictionary(Of Integer, List(Of DashboardAnimal))
            Public Overridable Property Lands As List(Of DashboardLand)
            Public Overridable Property Greeting As String
            Public Overridable Property FarmsCount As Integer
        End Class

        Public Partial Class Status
            Public Overridable Property Message As String
            Public Overridable Property StatusCode As Integer
        End Class
    End Namespace

    Namespace Pecuario.Backend.Domain.Entities

        Public Partial Class AnimalCategory
            Public Overridable Property Id As Integer
            <Required>
            <StringLength(50)>
            Public Overridable Property Name As String

            Public Overridable Property Alias As String
            Public Overridable Property Order As Integer
            Public Overridable Property Enabled As Boolean
        End Class
    End Namespace
End Namespace

VB.NET GetDashboard DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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}