Pecuario.Backend

<back to all web services

GetFarms

Requires Authentication
The following routes are available for this service:
GET/api/v1/farms
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 Farm:
    id: int = 0
    # @References(typeof(AppUser))
    user_id: int = 0

    # @Required()
    # @StringLength(100)
    name: Optional[str] = None

    # @References(typeof(Region))
    region_id: Optional[int] = None

    # @References(typeof(MeasurementUnit))
    measurement_unit_id: Optional[int] = None

    area: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetFarmsResponse(BaseResponse):
    farms: Optional[List[Farm]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetFarms(IGet):
    pass

Python GetFarms DTOs

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

HTTP + OTHER

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

GET /api/v1/farms HTTP/1.1 
Host: pecuario-backend.develsystems.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"farms":[{"id":0,"userId":0,"name":"String","regionId":0,"measurementUnitId":0,"area":0}]}