Pecuario.Backend

<back to all web services

GetDashboard

The following routes are available for this service:
GET/api/v1/dashboard
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetDashboard : IGet
{
    var countryId:Int? = null
    var maxAnimals:Int? = null
    var maxLands:Int? = null
}

open class GetDashboardResponse : BaseResponse()
{
    var animalCategories:ArrayList<AnimalCategory> = ArrayList<AnimalCategory>()
    var animalsByCategory:HashMap<Int,ArrayList<DashboardAnimal>> = HashMap<Int,ArrayList<DashboardAnimal>>()
    var lands:ArrayList<DashboardLand> = ArrayList<DashboardLand>()
    var greeting:String? = null
    var farmsCount:Int? = null
}

open class BaseResponse
{
    var status:Status? = null
}

open class Status
{
    var message:String? = null
    var statusCode:Int? = null
}

open class AnimalCategory
{
    var id:Int? = null
    @Required()
    @StringLength(50)
    var name:String? = null

    var alias:String? = null
    var order:Int? = null
    var enabled:Boolean? = null
}

open class DashboardLand
{
    var id:String? = null
    var description:String? = null
    var image:String? = null
    @SerializedName("type") var Type:String? = null
    var price:String? = null
    var cityRegionName:String? = null
    var priceType:String? = null
}

Kotlin 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
}