sfgboxapi

<back to all web services

ProductsAutoQueryLookup

QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Products Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
TenantsIdformlongYes
ZonesIdformlongYes
VarietiesIdformlongYes
DescriptionformstringYes
QueryResponse<Tenants> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Tenants>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Tenants Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
MainZonesIdformlongYes
IsPublicformboolNo

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/ProductsAutoQueryLookup 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,"tenantsId":0,"zonesId":0,"varietiesId":0,"description":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}