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

HTTP + JSV

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

POST /jsv/reply/UsersDetailsAutoQueryLookup HTTP/1.1 
Host: api-stage.smartfarmertech.com 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			appUserId: 0,
			approved: False,
			identificationNumber: String,
			passportNumber: String,
			address: String,
			latitude: 0,
			longitude: 0,
			age: 0,
			ethnicGroup: String,
			gender: String,
			isDisabled: False,
			documentUrl: String,
			applicationDate: 0001-01-01,
			approvalDate: 0001-01-01,
			isZoneMain: False,
			publicAccessGuid: 00000000000000000000000000000000
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}