sfgboxapi

<back to all web services

CompanionsAutoQueryLookup

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports sfgboxapi.ServiceModel
Imports sfgboxapi.ServiceModel.Types

Namespace Global

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Skip As Nullable(Of Integer)

            <DataMember(Order:=2)>
            Public Overridable Property Take As Nullable(Of Integer)

            <DataMember(Order:=3)>
            Public Overridable Property OrderBy As String

            <DataMember(Order:=4)>
            Public Overridable Property OrderByDesc As String

            <DataMember(Order:=5)>
            Public Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of T)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of Tenants)
            Public Sub New()
                Results = New List(Of Tenants)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of Tenants)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace sfgboxapi.ServiceModel

        Public Partial Class CompanionsAutoQueryLookup
            Inherits QueryDb(Of Companions)
        End Class
    End Namespace

    Namespace sfgboxapi.ServiceModel.Types

        Public Partial Class Companions
            <DataMember(Order:=1)>
            <Required>
            Public Overridable Property Id As Long

            <DataMember(Order:=2)>
            <Required>
            <References(GetType(Tenants))>
            Public Overridable Property TenantsId As Long

            <DataMember(Order:=3)>
            <Required>
            <References(GetType(Zones))>
            Public Overridable Property ZonesId As Long

            <DataMember(Order:=4)>
            <Required>
            <References(GetType(Crops))>
            Public Overridable Property CropsId As Long

            <DataMember(Order:=5)>
            <Required>
            <References(GetType(Crops))>
            Public Overridable Property CompanionCropsId As Long
        End Class

        Public Partial Class Tenants
            <DataMember(Order:=1)>
            <Required>
            Public Overridable Property Id As Long

            <DataMember(Order:=2)>
            <Required>
            <References(GetType(Zones))>
            Public Overridable Property MainZonesId As Long

            <DataMember(Order:=3)>
            Public Overridable Property IsPublic As Boolean
        End Class
    End Namespace
End Namespace

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

<CompanionsAutoQueryLookup 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>
</CompanionsAutoQueryLookup>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCompanionsZC5p8r_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:Companions>
      <d2p1:CompanionCropsId>0</d2p1:CompanionCropsId>
      <d2p1:CropsId>0</d2p1:CropsId>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:TenantsId>0</d2p1:TenantsId>
      <d2p1:ZonesId>0</d2p1:ZonesId>
    </d2p1:Companions>
  </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>
</QueryResponseOfCompanionsZC5p8r_So>