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 .xml suffix or ?format=xml

HTTP + XML

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

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

<UsersDetailsAutoQueryLookup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</UsersDetailsAutoQueryLookup>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfUsersDetailsZC5p8r_So xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel.Types">
    <d2p1:UsersDetails>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:Age>0</d2p1:Age>
      <d2p1:AppUserId>0</d2p1:AppUserId>
      <d2p1:ApplicationDate>0001-01-01T00:00:00</d2p1:ApplicationDate>
      <d2p1:ApprovalDate>0001-01-01T00:00:00</d2p1:ApprovalDate>
      <d2p1:Approved>false</d2p1:Approved>
      <d2p1:DocumentUrl>String</d2p1:DocumentUrl>
      <d2p1:EthnicGroup>String</d2p1:EthnicGroup>
      <d2p1:Gender>String</d2p1:Gender>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IdentificationNumber>String</d2p1:IdentificationNumber>
      <d2p1:IsDisabled>false</d2p1:IsDisabled>
      <d2p1:IsZoneMain>false</d2p1:IsZoneMain>
      <d2p1:Latitude>0</d2p1:Latitude>
      <d2p1:Longitude>0</d2p1:Longitude>
      <d2p1:PassportNumber>String</d2p1:PassportNumber>
      <d2p1:PublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:PublicAccessGuid>
    </d2p1:UsersDetails>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfUsersDetailsZC5p8r_So>