Pecuario.Backend

<back to all web services

GetAnimalTypesByCategory

The following routes are available for this service:
GET/api/v1/utils/animal-types/{categoryId}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Status:
    message: Optional[str] = None
    status_code: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
    status: Optional[Status] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AnimalType:
    id: int = 0
    # @Required()
    # @StringLength(50)
    name: Optional[str] = None

    # @References(typeof(AnimalCategory))
    animal_category_id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAnimalTypesByCategoryResponse(BaseResponse):
    animal_types: Optional[List[AnimalType]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAnimalTypesByCategory(IGet):
    category_id: Optional[int] = None

Python GetAnimalTypesByCategory 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/utils/animal-types/{categoryId} HTTP/1.1 
Host: pecuario-backend.develsystems.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	animalTypes: 
	[
		{
			id: 0,
			name: String,
			animalCategoryId: 0
		}
	]
}