sfgboxapi

<back to all web services

UsersDetailsAutoQueryLookup

QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
UsersDetails Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
AppUserIdformlongYes
ApprovedformboolNo
IdentificationNumberformstringNo
PassportNumberformstringNo
AddressformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
AgeformintNo
EthnicGroupformstringNo
GenderformstringNo
IsDisabledformboolNo
DocumentUrlformstringNo
ApplicationDateformDateTimeNo
ApprovalDateformDateTimeNo
IsZoneMainformboolNo
PublicAccessGuidformGuidNo
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 .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>