sfgboxapi

<back to all web services

UsersDetailsAutoQueryLookup

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 QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    @staticmethod
    def response_type(): return QueryResponse[T]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UsersDetails:
    # @Required()
    id: int = 0

    # @Required()
    # @References(typeof(AppUser))
    app_user_id: int = 0

    approved: bool = False
    identification_number: Optional[str] = None
    passport_number: Optional[str] = None
    address: Optional[str] = None
    latitude: float = 0.0
    longitude: float = 0.0
    age: int = 0
    ethnic_group: Optional[str] = None
    gender: Optional[str] = None
    is_disabled: bool = False
    document_url: Optional[str] = None
    application_date: datetime.datetime = datetime.datetime(1, 1, 1)
    approval_date: datetime.datetime = datetime.datetime(1, 1, 1)
    is_zone_main: bool = False
    public_access_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UsersDetailsAutoQueryLookup(QueryDb[UsersDetails]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Tenants:
    # @Required()
    id: int = 0

    # @Required()
    # @References(typeof(Zones))
    main_zones_id: int = 0

    is_public: bool = False


Tenants = TypeVar('Tenants')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[Tenants]):
    offset: int = 0
    total: int = 0
    results: Optional[List[Tenants]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python UsersDetailsAutoQueryLookup DTOs

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

HTTP + CSV

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

POST /csv/reply/UsersDetailsAutoQueryLookup HTTP/1.1 
Host: api-stage.smartfarmertech.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"appUserId":0,"approved":false,"identificationNumber":"String","passportNumber":"String","address":"String","latitude":0,"longitude":0,"age":0,"ethnicGroup":"String","gender":"String","isDisabled":false,"documentUrl":"String","applicationDate":"\/Date(-62135596800000-0000)\/","approvalDate":"\/Date(-62135596800000-0000)\/","isZoneMain":false,"publicAccessGuid":"00000000000000000000000000000000"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}