sfgboxapi

<back to all web services

UsersBoxesAutoQueryEdit

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 UsersBoxes:
    # @Required()
    id: int = 0

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

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

    # @Required()
    deployment_date: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Required()
    number_boxes: int = 0

    # @Required()
    recipient_type: Optional[str] = None

    food_gardens_id: Optional[int] = None
    other_description: Optional[str] = None
    public_access_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UsersBoxesAutoQueryEdit(UsersBoxes, IUpdateDb[UsersBoxes]):
    pass

Python UsersBoxesAutoQueryEdit 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/UsersBoxesAutoQueryEdit HTTP/1.1 
Host: api-stage.smartfarmertech.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UsersBoxesAutoQueryEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <AppUserId xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel.Types">0</AppUserId>
  <AuthAppUserId xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel.Types">0</AuthAppUserId>
  <DeploymentDate xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel.Types">0001-01-01T00:00:00</DeploymentDate>
  <FoodGardensId xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel.Types">0</FoodGardensId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel.Types">0</Id>
  <NumberBoxes xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel.Types">0</NumberBoxes>
  <OtherDescription xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel.Types">String</OtherDescription>
  <PublicAccessGuid xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel.Types">00000000-0000-0000-0000-000000000000</PublicAccessGuid>
  <RecipientType xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel.Types">String</RecipientType>
</UsersBoxesAutoQueryEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsersBoxes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel.Types">
  <AppUserId>0</AppUserId>
  <AuthAppUserId>0</AuthAppUserId>
  <DeploymentDate>0001-01-01T00:00:00</DeploymentDate>
  <FoodGardensId>0</FoodGardensId>
  <Id>0</Id>
  <NumberBoxes>0</NumberBoxes>
  <OtherDescription>String</OtherDescription>
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
  <RecipientType>String</RecipientType>
</UsersBoxes>